Creating a VM from a custom image

If you don't have the Nebius Israel command line interface yet, install and initialize it.

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

1. View a description of the CLI create VM command:

   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 |
   +----------------------+-----------------+--------+-------------+--------+
   |         ...          |        ...      |        |             |  ...   |
   | fd8gkcd3l6ov84aon8s1 | your-test-image |        |             | READY  |
   |         ...          |        ...      |        |             |  ...   |
   +----------------------+-----------------+--------+-------------+--------+
   

3. Select the identifier (ID) or name (NAME) of the desired image.

4. Create a VM in the default folder:

   yc compute instance create \
     --name test-vm-from-image \
     --zone il1-a \
     --create-boot-disk name=disk1,size=5,image-id=fd8gkcd3l6ov84aon8s1 \
     --public-ip \
     --ssh-key ~/.ssh/id_ed25519.pub
   

   This command creates a VM with a 5 GB boot disk from the pre-loaded image named test-vm-from-image.

   Note

   The VM name is used to generate an internal FQDN only once: when creating a VM. If the internal FQDN is important to you, choose an appropriate name for the VM at the creation stage.

   The yc-user user will be created on the VM with the public key from the ~/.ssh/id_ed25519.pub file. The VM gets a public IP address. To create a VM without a public IP, remove the --public-ip flag.

   Note

   If you are using the CLI version 0.92.0 or lower, then in the command, you must also specify the VM platform: --platform standard-v3. You can find out the CLI version using the yc version command and install the latest version using the yc components update command.

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

If you do not have Terraform yet, install it and configure the Nebius Israel provider.

To create a VM from a custom image:

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

   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 = <amount_of_RAM_in_GB>
     }
   
     boot_disk {
       initialize_params {
         image_id = "<image_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_instance: Description of the VM:
     • name: VM name.

     • allow_stopping_for_update: Allow a VM instance to stop to make changes. Set true if you plan to change the network settings, computing resources, disks, or file storage for your VM using Terraform. The default value is false.

     • platform_id: Platform.
     • zone: ID of the availability zone that will host your VM.
     • resources: Number of vCPU cores and the amount of RAM available to the VM. The values must match the selected platform.
     • boot_disk: Boot disk settings. Specify the identifier of the uploaded image.
     • network_interface: Network settings. Specify the ID of the selected subnet. To automatically assign a public IP address to the VM, set nat = true.
     • metadata: In metadata, provide the public key for accessing the VM via SSH. For more information, see VM metadata.
   • yandex_vpc_network: Description of the cloud network.
   • yandex_vpc_subnet: Description of the subnet your VM will connect to.

   Note

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

   For more information on resources that you can create with Terraform, see the provider documentation.

2. Create 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 that the resources are there and their settings are correct using the management console.