Uploading a custom disk image to Yandex Cloud

To create a new image via the link, use the --source-uri flag. To create an optimized image, use the --pooled flag.

yc compute image create --name <image_name> --source-uri <image_URL> --pooled

Where:

• --name: Name to assign to the image.
• --source-uri: Image link you got in Object Storage.

Add a description as required and specify the family the image belongs to:

yc compute image create \
  --name ubuntu-cosmic \
  --description "Ubuntu Server 18.10 (Cosmic Cuttlefish)" \
  --family ubuntu \
  --source-uri "https://storage.yandexcloud.net/mybucket/cosmic-server-cloudimg-amd64.vmdk"

If you know the minimum required size of a disk to create from this image, specify it in GB:

yc compute image create \
  --name big-image \
  --min-disk-size 20 \
  --source-uri "https://storage.yandexcloud.net/mybucket/cosmic-server-cloudimg-amd64.vmdk"

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To create an image:

1. Specify the parameters of the yandex_compute_image resource in the configuration file.

   Here is an example of the configuration file structure:

   resource "yandex_compute_image" "image-1" {
     name       = "ubuntu-cosmic"
     os_type    = "LINUX"
     source_url = "<image_link>"
     pooled     = "false"
   }
   

   Where source_url is the image link in Object Storage.

   For more information about the resources you can create with Terraform, see the relevant provider documentation.

2. Make sure the configuration files are correct.

   1. In the command line, go to the directory where you created the configuration file.

   2. Run a check using this command:

      terraform plan
      

   If you described the configuration correctly, the terminal will display a list of the resources being created and their parameters. If the configuration contains any errors, Terraform will point them out.

3. Deploy the cloud resources.

   1. Run this command:

      terraform apply
      

   2. Confirm creating the resources.

   This will create all the resources you need in the specified folder. You can check the new resources and their settings using the management console.

Create a new image using the create REST API method for the Image resource or the ImageService/Create gRPC API call. In the request, specify the link to the image.

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

1. See the description of the CLI command for creating a VM:

   yc compute instance create --help
   

2. Get a list of images in the default folder:

   yc compute image list
   

   Result:

   +----------------------+-----------------+--------+-------------+--------+
   |          ID          |      NAME       | FAMILY | PRODUCT IDS | STATUS |
   +----------------------+-----------------+--------+-------------+--------+
   |         ...          |        ...      |        |             |  ...   |
   | fd8gkcd3l6ov******** | your-test-image |        |             | READY  |
   |         ...          |        ...      |        |             |  ...   |
   +----------------------+-----------------+--------+-------------+--------+
   

3. Select ID or NAME of the image you need.

4. Select a subnet:

   yc vpc subnet list
   

   Result:

   +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+
   |          ID          |           NAME            |      NETWORK ID      | ROUTE TABLE ID |       ZONE        |      RANGE      |
   +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+
   | e9bnlm18l70a******** |   default-ru-central1-a   | enpe3m3fa00u******** |                |   ru-central1-a   | [10.128.0.0/24] |
   +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+
   

5. Create a VM in the default folder:

   yc compute instance create \
     --name <VM_name> \
     --zone <availability_zone> \
     --network-interface subnet-name=<subnet_name>,nat-ip-version=ipv4 \
     --create-boot-disk name=<disk_name>,size=<disk_size_in_GB>,image-id=<custom_image_ID> \
     --ssh-key <path_to_public_key_file>
   

   Where:

   • --name: VM name. The naming requirements are as follows:

     • It must be 2 to 63 characters long.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

     Note

     The VM name is used to generate an internal FQDN, which is set only once, when you create the VM. If the internal FQDN is important to you, make sure to choose an appropriate name for your VM.

   • --zone: Availability zone matching the selected subnet.

   • --network-interface: VM network interface settings:

     • subnet-name: Name of the selected subnet.
     • nat-ip-version=ipv4: Public IP address. To create a VM without a public IP address, omit this parameter.

     If you want to add multiple network interfaces to your VM, specify the --network-interface parameter as many times as you need. You can add up to eight network interfaces to a single VM.

   • --create-boot-disk: VM boot disk settings:

     • name: Boot disk name. The naming requirements are as follows:

       • It must be 2 to 63 characters long.
       • It may contain lowercase Latin letters, numbers, and hyphens.
       • It must start with a letter and cannot end with a hyphen.

     • size: Disk size in GB.

     • image-id: ID of the custom image to create the VM from. Specify the ID of the uploaded image.

   • --ssh-key: Path to the file with the public SSH key. The VM will automatically create a user named yc-user for this key.

     When creating a VM from a Yandex Cloud Marketplace public image, make sure to provide an SSH key, as SSH access with a username and password is disabled by default for such images.

     If you want to add multiple users with SSH keys to your VM at the same time, specify these users' data in the --metadata-from-file parameter.

When a VM is created, it is assigned an IP address and hostname (FQDN). This data can be used for SSH access.

You can make a public IP address static. For more information, see Making a VM public IP address static.

Result:

```text
id: fhmue131en37********
folder_id: b1g681qpemb4********
created_at: "2024-03-02T12:58:43Z"
name: test-vm-from-image
zone_id: ru-central1-a
platform_id: standard-v2
resources:
  memory: "2147483648"
  cores: "2"
  core_fraction: "100"
status: RUNNING
metadata_options:
  gce_http_endpoint: ENABLED
  aws_v1_http_endpoint: ENABLED
  gce_http_token: ENABLED
  aws_v1_http_token: DISABLED
boot_disk:
  mode: READ_WRITE
  device_name: fhmn9n1uhutc********
  auto_delete: true
  disk_id: fhmn9n1uhutc********
network_interfaces:
  - index: "0"
    mac_address: d0:0d:1e:70:46:17
    subnet_id: e9bb9n0v4h17********
    primary_v4_address:
      address: 10.12*.*.**
      one_to_one_nat:
        address: 178.154.***.***
        ip_version: IPV4
gpu_settings: {}
fqdn: fhmue131en37********.auto.internal
scheduling_policy: {}
network_settings:
  type: STANDARD
placement_policy: {}
```

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To create a VM from a custom image:

1. In the configuration file, define the parameters of the resources you want to create:

   resource "yandex_compute_disk" "boot-disk" {
     name     = "<disk_name>"
     type     = "<disk_type>"
     zone     = "<availability_zone>"
     size     = "<disk_size>"
     image_id = "<custom_image_ID>"
   }
   
   resource "yandex_compute_instance" "vm-1" {
     name                      = "vm-from-image"
     allow_stopping_for_update = true
     platform_id               = "standard-v3"
     zone                      = "<availability_zone>"
   
     resources {
       cores  = <number_of_vCPU_cores>
       memory = <RAM_in_GB>
     }
   
     boot_disk {
       disk_id = yandex_compute_disk.boot-disk.id
     }
   
     network_interface {
       subnet_id = "${yandex_vpc_subnet.subnet-1.id}"
       nat       = true
     }
   
     metadata = {
       ssh-keys = "<username>:<SSH_key_contents>"
     }
   }
   
   resource "yandex_vpc_network" "network-1" {
     name = "network1"
   }
   
   resource "yandex_vpc_subnet" "subnet-1" {
     name       = "subnet1"
     zone       = "<availability_zone>"
     network_id = "${yandex_vpc_network.network-1.id}"
   }
   

   Where:

   • yandex_compute_disk: Boot disk description:

     • name: Disk name. The naming requirements are as follows:

       • It must be 2 to 63 characters long.
       • It may contain lowercase Latin letters, numbers, and hyphens.
       • It must start with a letter and cannot end with a hyphen.

     • type: Disk type.

     • zone: Availability zone the disk will be in.

     • size: Disk size in GB.

     • image_id: ID of the custom image to create the VM from. Specify the ID of the uploaded image.

   • yandex_compute_instance: VM description.

     • name: VM name. The naming requirements are as follows:

       • It must be 2 to 63 characters long.
       • It may contain lowercase Latin letters, numbers, and hyphens.
       • It must start with a letter and cannot end with a hyphen.

       Note

       The VM name is used to generate an internal FQDN, which is set only once, when you create the VM. If the internal FQDN is important to you, make sure to choose an appropriate name for your VM.

     • allow_stopping_for_update: Permission to stop the VM for updates. Set to true if you plan to change your VM's network settings or computing resources using Terraform. The default value is false.

     • platform_id: Platform.

     • zone: Availability zone the VM will be in.

     • resources: Number of vCPUs and amount of RAM available to the VM. The values must match the selected platform.

     • boot_disk: Boot disk settings. Specify the disk ID.

     • network_interface: VM network interface settings. Specify the ID of the selected subnet. To automatically assign a public IP address to the VM, set nat = true.

       If you want to add multiple network interfaces to your VM, specify the network_interface section as many times as you need. You can add up to eight network interfaces to a single VM.

     • metadata: In metadata, provide the public key for SSH access to the VM. For more information, see VM metadata.

   • yandex_vpc_network: Cloud network description.
   • yandex_vpc_subnet: Description of the subnet to connect your VM to.

   Note

   If you already have suitable resources, such as a cloud network and subnet, you do not need to redefine them. Specify their names and IDs in the appropriate parameters.

   For more information about the resources you can create with Terraform, see the relevant provider documentation.

2. Create the resources:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

   All the resources you need will then be created in the specified folder. You can check the new resources and their settings using the management console.

Use the create REST API method for the Instance resource or the InstanceService/Create gRPC API call.