Uploading a disk image to Yandex Cloud
This tutorial will tell you how to upload a Linux OS image file to Yandex Object Storage and use it to create an image and a VM in Compute Cloud. For more information on how to create an image with Windows OS, see Preparing your own images with Microsoft products.
Major virtualization systems are supported.
Warning
In Compute Cloud, you can only create images using files uploaded to Object Storage. You can also migrate a VM using Hystax Acura.
Prepare an image file
Boot disk images must meet the following requirements:
- The
virtio-net
,virtio-blk
, andvirtio-pci
drivers are installed. If you are going to attach file storages to your VM, you also need to install thevirtiofs
driver. For more information, refer to this guide. - The
ttyS0
terminal (COM1 port) is set up as a serial console. For more information, refer to this guide. - The network interface runs correctly when starting a VM and obtains the IP address via DHCP.
- The
cloud-init
package is installed and configured to work with our metadata service. To install the package for CentOS, run thesudo yum install cloud-init
command. To install it for Debian or Ubuntu, runsudo apt update && sudo apt install -y cloud-init
. - If you created an image based on an Amazon Machine Image (AMI), verification of the cloud platform where the VM instance is run is disabled in the
cloud-init
settings. For more information, refer to this guide. - In the system firewall settings, the minimum required set of ports for running your applications and a port for SSH access (by default, 22 TCP) are open.
- The SSH server starts automatically at VM startup.
- Services running your application are resistant to VM reboots.
- The boot disk uses MBR partitioning.
- The disk is mounted by its UUID rather than by name.
- The file system is not encrypted.
For setup instructions, see Preparing your disk image.
Upload an image file to Object Storage
Upload your image to Object Storage and get a link to the uploaded image:
- If you do not have a bucket in Object Storage, create one with restricted access.
- Upload the image using the management console, the AWS CLI, or WinSCP, for example. In Object Storage terms, the uploaded image is called an object.
- Get a link to the uploaded image. Use this link when creating an image in Compute Cloud.
Create an image in Compute Cloud
Create a new image from the link obtained in Object Storage:
-
In the management console, select the folder where you want to create an image.
-
Select Compute Cloud.
-
In the left-hand panel, select
Images. -
Click Upload image.
-
Enter the image name. The naming requirements are as follows:
- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
-
If necessary, add a description of the image.
-
Insert the link to the image you received in Object Storage.
-
To create an optimized image, enable Optimize for deployment.
-
Click Upload.
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 requirements for the size of a disk that will be created from this image, specify the size 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"
Note
The min-disk-size
value must be greater than the volume of the source data in the image and greater than the size of the virtual disk specified in the image.
If the min-disk-size
value you specify is less than that allowed, an error will occur and no image will be created. The error description will contain the minimum value in bytes, for example, Minimal disk size should be greater than or equal to 10737418240
.
If no min-disk-size
is specified, the minimum value will be used.
If you don't have Terraform, install it and configure the Yandex Cloud provider.
To create an image:
-
Describe the resource parameters in the
yandex_compute_image
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 link to the image in Object Storage.For more information about resources you can create with Terraform, see the provider documentation
. -
Make sure the configuration files are valid.
-
In the command line, go to the directory where you created the configuration file.
-
Run a check using this command:
terraform plan
If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, Terraform will point them out.
-
-
Deploy cloud resources.
-
Run this command:
terraform apply
-
Confirm that you want to create the resources.
All the resources you need will then be created in the specified folder. You can check the new resources and their configuration 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.
Once created, the image will have the CREATING
status. Wait until the image status changes to READY
before using it.
Delete the image from Object Storage
If you have successfully created an image, you can delete the image file from Object Storage. You can also delete the bucket if it does not contain any more objects.
Create a VM from the prepared image
-
In the management console
, select the folder to create your VM in. -
In the list of services, select Compute Cloud.
-
At the top right, click Create virtual machine.
-
Under Basic parameters:
-
Enter a name and description for the VM. The naming requirements are as follows:
- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
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.
-
Select an availability zone to place your VM in.
-
-
Under Image/boot disk selection, select an image:
- Go to the Custom image tab and click Choose.
- In the window that opens, go to the Image tab.
- Select an image from the list and click Apply.
-
(Optional) To encrypt a boot disk, under Disks and file storages, configure encryption parameters for the disk:
- Select the Encrypted disk option.
- In the KMS Key field, select the key with which you want to encrypt the disk. To create a new key, click Create.
- In the Service account field, select the service account with the
kms.keys.encrypterDecrypter
role for the specified key. To create a service account, click Create.
The encryption feature in Compute Cloud is currently at the Preview stage. To access it, open the resource creation page and click Request access under Encryption or contact support
.If you deactivate the key used to encrypt a disk or snapshot, access to the data will be suspended until you reactivate the key.
Alert
If you destroy the key or its version used to encrypt a disk or snapshot, access to the data will be irrevocably lost. Learn more in Destroying key versions.
-
Under Disks and file storages, add a disk:
-
Click Add disk.
-
Enter the disk name.
-
Select the disk type.
-
Specify the required block size.
-
Specify the required disk size.
-
(Optional) To encrypt a disk, configure encryption parameters.
-
(Optional) Enable the Delete with the VM option if you need to automatically delete the disk when deleting the VM it will be attached to.
-
Select
Image
as content. -
Select the image you need.
-
Click Add.
-
-
(Optional) Under Disks and file storages, select the File storages tab and attach the file storage:
- Click Attach file storage.
- In the window that opens, select the file storage.
- Enter the device name.
- Click Attach file storage.
-
Under Computing resources:
- Choose a platform.
- Specify the guaranteed share and the required number of vCPUs, as well as the amount of RAM.
- If required, make your VM preemptible.
- (Optional) Enable a software-accelerated network.
-
Under Network settings:
-
Enter a subnet ID or select a cloud network from the list.
If you do not have a network, click Create network to create one:- In the window that opens, enter the network name and specify the folder to host the network.
- (Optional) To automatically create subnets, select the Create subnets option.
- Click Create.
Each network must have at least one subnet. If there is no subnet, create one by selecting Add subnet.
-
In the Public IP field, choose a method for assigning an IP address:
Auto
: Assign a random IP address from the Yandex Cloud IP pool. With this, you can enable DDoS protection using the option below.List
: Select a public IP address from the list of previously reserved static addresses. For more information, see Converting a dynamic public IP address to static.No address
: Do not assign a public IP address.
-
In the Internal IPv4 address field, select the method for assigning internal addresses:
Auto
orManual
. -
(Optional) Create records for the VM in the DNS zone:
- Expand the DNS settings for internal addresses section and click Add record.
- Specify the zone, FQDN, and TTL for the record. When setting the FQDN, you can select
Detect automatically
for the zone.
You can add multiple records to internal DNS zones. For more information, see Cloud DNS integration with Compute Cloud. - To create another record, click Add record.
-
Select the appropriate security groups.
-
-
(Optional) To back up your VMs automatically using Cloud Backup, under Backups, select how your VM should connect to the service.
For more information, see Connecting Compute Cloud VMs to Cloud Backup.
-
Under Access, specify the information required to access the instance:
-
(Optional) Select or create a service account. With a service account, you can flexibly configure access rights for your resources.
-
(Optional) Enable VM access via OS Login. This option is only available for Linux images.
-
Enter the username in the Login field.
Alert
Do not use the
root
username or other names reserved by the operating system. To perform operations that require superuser permissions, use thesudo
command. -
In the SSH key field, paste the contents of the public key file.
-
If required, grant access to the serial console.
In public Linux images provided by Yandex Cloud, the functionality of connecting over SSH using login and password is disabled by default.
-
-
(Optional) Under Placement, select a VM placement group.
-
Click Create VM.
The VM appears in the list. Once created, the VM is assigned an IP address and a host name (FQDN).
You can monitor the VM status in the serial console or the serial port output.
If you do not have the Yandex Cloud 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.
-
View a description of the CLI create VM command:
yc compute instance create --help
-
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 | | ... | ... | | | ... | +----------------------+-----------------+--------+-------------+--------+
-
Select the identifier (
ID
) or name (NAME
) of the desired image. -
Create a VM in the default folder:
yc compute instance create \ --name <VM_name> \ --zone <availability_zone> \ --create-boot-disk name=<disk_name>,size=<disk_size_in_GB>,image-id=<custom_image_ID> \ --public-ip \ --ssh-key <path_to_public_key_file>
Where:
-
--name
: VM instance name. The naming requirements are as follows:- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
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.
-
--zone
: Availability zone to host the VM. -
--create-boot-disk
: Boot disk parameters:-
name
: Boot disk name. The naming requirements are as follows:- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be 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.
-
-
--public-ip
: Add this flag to assign a public IP to the VM. To create a VM without a public IP address, remove this flag. -
--ssh-key
: Path to the public SSH key file. The default username for access via SSH isyc-user
.
Result:
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:
-
In the configuration file, describe 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 = "<user_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 = <GB_of_RAM> } 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:- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
-
type
: Disk type. -
zone
: Availability zone to host the disk. -
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
: Description of the VM:-
name
: VM name. The naming requirements are as follows:- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot be a hyphen.
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.
-
allow_stopping_for_update
: Allow a VM instance to stop to make changes. Settrue
if you plan to change the network settings, computing resources, disks, or file storage for your VM using Terraform. The default value isfalse
. -
platform_id
: Platform. -
zone
: Availability zone to host the 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 disk ID. -
network_interface
: Network settings. Specify the ID of the selected subnet. To automatically assign a public IP address to the VM, setnat = 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 about resources you can create with Terraform, see the provider documentation
. -
Create resources:
-
In the terminal, change to the folder where you edited the configuration file.
-
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.
-
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.
-
Apply the configuration changes:
terraform apply
-
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 configuration using the management console
. -
Use the create REST API method for the Instance resource or the InstanceService/Create gRPC API call.
For information about Object Storage pricing, see Object Storage pricing.