Running a Docker image on a VM
This tutorial describes the steps required to run a Docker image on a VM using the Yandex Container Solution registry.
To run a Docker image on a VM using the registry:
- Prepare your cloud.
- Create a service account.
- Create a VM.
- Build and upload the Docker image to Container Registry.
- Download the Docker image to a VM.
- Check the result.
If you no longer need the resources you created, delete them.
You can also deploy an infrastructure for running a Docker image on a VM via Terraform using a ready-made configuration file.
Getting started
Sign up for Yandex Cloud and create a billing account:
- Go to the management console
and log in to Yandex Cloud or create an account if you do not have one yet. - On the Billing
page, make sure you have a billing account linked and it has theACTIVE
orTRIAL_ACTIVE
status. If you do not have a billing account, create one.
If you have an active billing account, you can go to the cloud page
Learn more about clouds and folders.
Required paid resources
The infrastructure support costs include:
- Fee for a continuously running VM (see Yandex Compute Cloud pricing).
- Fee for using a dynamic or a static public IP (see Yandex Virtual Private Cloud pricing).
- Fee for storing a Docker image in the registry and outgoing traffic (see Container Solution pricing).
Configure the environment
- Install the Yandex Cloud command line interface.
- Prepare an SSH key for VM access.
- Create a registry in Container Solution to store the Docker image.
- Install
Docker.
Create a service account
-
Create a service account and grant it the
container-registry.images.puller
role for the previously created registry:Management consoleCLITerraformAPI- In the management console
, select a folder in which to create a service account. - At the top of the screen, go to the Service accounts tab.
- Click Create service account.
- Enter the service account name and click Create.
- In the list of services, select Container Registry.
- Select the registry and click the row with its name.
- Go to the Access bindings tab.
- In the top-right corner, click Assign bindings.
- Click
- Click Add role and select
container-registry.images.puller
. - Click Save.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
-
View a description of the CLI command to create a service account:
yc iam service-account create --help
-
Create a service account:
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.yc iam service-account create --name <service_account_name>
Result:
id: ajelabcde12f******** folder_id: b0g12ga82bcv******** created_at: "2020-11-30T14:32:18.900092Z" name: myservice-acc
-
Assign the role to the service account:
yc <service_name> <resource> add-access-binding <resource_name_or_ID> \ --role <role_ID> \ --subject serviceAccount:<service_account_ID>
Where:
<service_name>
:container
service name.<resource>
: Category of theregistry
resource.<resource_name_or_ID>
: Name or ID of the resource the role is assigned for.--role
:container-registry.images.puller
role ID.--subject
: ID of the service account (e.g.,ajelabcde12f********
) to which the role is assigned.
See section How to create an infrastructure using Terraform.
Use the
updateAccessBindings
method for theregistry
resource. - In the management console
Create a VM
-
Create a VM with a public IP address and link the service account you created to it:
Management consoleCLITerraformAPI- In the management console
, select the folder to create your VM in. - In the list of services, select Compute Cloud.
- Click Create resource and select Virtual machine instance.
- 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 the service account you created at the previous step.
-
Select an availability zone to place your VM in.
-
- Under Image/boot disk selection, select an image and a Linux-based OS version.
- (Optional) Configure the boot disk under Disks:
-
Specify the required disk size.
-
Select the disk type.
If you want to create a VM from an existing disk, under Disks, add a disk.
-
- 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.
- 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 a name for the new network and choose a subnet to connect the VM to. Each network should have at least one subnet (if there are no subnets, create one). Then click Create.
- 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.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.- (Optional) Enable DDoS protection.
- 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:
- Under Access, specify the information required to access the instance:
-
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.
-
- Click Create VM.
-
View a description of the CLI create VM command:
yc compute instance create --help
-
Prepare the key pair (public and private keys) for SSH access to the VM.
-
Select in Cloud Marketplace a public image based on a Linux OS (for example, CentOS 7).
To get a list of available images using the YC CLI, run this command:
yc compute image list --folder-id standard-images
Result:
+----------------------+-------------------------------------+--------------------------+----------------------+--------+ | ID | NAME | FAMILY | PRODUCT IDS | STATUS | +----------------------+-------------------------------------+--------------------------+----------------------+--------+ ... | fdvk34al8k5n******** | centos-7-1549279494 | centos-7 | dqni65lfhvv2******** | READY | | fdv7ooobjfl3******** | windows-2016-gvlk-1548913814 | windows-2016-gvlk | dqnnc72gj2is******** | READY | | fdv4f5kv5cvf******** | ubuntu-1604-lts-1549457823 | ubuntu-1604-lts | dqnnb6dc7640******** | READY | ... +----------------------+-------------------------------------+--------------------------+----------------------+--------+
-
View a list of available subnets:
yc vpc subnet list
Result:
+----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ | ID | NAME | NETWORK ID | ROUTE TABLE ID | ZONE | RANGE | +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+ | b0c6n43f9lgh******** | default-ru-central1-d | enpe3m3fa00u******** | | ru-central1-d | [10.130.0.0/24] | | e2l2da8a20b3******** | default-ru-central1-b | enpe3m3fa00u******** | | ru-central1-b | [10.129.0.0/24] | | e9bnlm18l70a******** | default-ru-central1-a | enpe3m3fa00u******** | | ru-central1-a | [10.128.0.0/24] | +----------------------+---------------------------+----------------------+----------------+-------------------+-----------------+
-
Create a VM in the default folder:
yc compute instance create \ --name first-instance \ --zone ru-central1-a \ --network-interface subnet-name=default-ru-central1-a,nat-ip-version=ipv4 \ --create-boot-disk image-folder-id=standard-images,image-family=centos-7 \ --ssh-key ~/.ssh/id_ed25519.pub --service-account-name service-acc
Where:
-
--name
: VM name.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 that corresponds to the selected subnet. -
subnet-name
: Name of the selected subnet. -
image-family
: Image family, e.g.,centos-7
. This option allows you to install the latest version of the operating system from the specified family. -
Public IP. To create a VM without a public IP address, disable the
nat-ip-version=ipv4
option. -
--ssh-key
: Public SSH key path. The VM will automatically create a user namedyc-user
for this key. -
--service-account-name
: Name of the service account created in the previous step.
This will create a VM called
first-instance
. -
See section How to create an infrastructure using Terraform.
Create a VM using the Create method for the
Instance
resource:-
Prepare the key pair (public and private keys) for SSH access to the VM.
-
Get an Yandex Identity and Access Management token used for authentication in the examples:
-
Get the ID of the folder.
-
Get information about the image to create your VM from (image ID and minimum disk size):
-
If you know the image family, get information about the latest image in this family:
export IAM_TOKEN=CggaATEVAgA... export FAMILY=ubuntu-1804 curl -H "Authorization: Bearer ${IAM_TOKEN}" \ "https://compute.api.cloud.yandex.net/compute/v1/images:latestByFamily?folderId=standard-images&family=${FAMILY}"
-
To learn more about the image, see the list of public images.
-
-
Get the subnet ID and availability zone ID. Specify the ID of the folder where the subnet was created in your request:
export IAM_TOKEN=CggaATEVAgA... export FOLDER_ID=b1gvmob95yys******** curl -H "Authorization: Bearer ${IAM_TOKEN}" \ "https://vpc.api.cloud.yandex.net/vpc/v1/subnets?folderId=${FOLDER_ID}" { "subnets": [ { "v4CidrBlocks": [ "10.130.0.0/24" ], "id": "b0c6n43ftldh********", "folderId": "b1gvmob95yys********", "createdAt": "2018-09-23T12:15:00Z", "name": "default-ru-central1-a", "description": "Auto-created default subnet for zone ru-central1-a", "networkId": "enpe3m3faglu********", "zoneId": "ru-central1-a" }, ... ]}
-
Create a file named
body.json
with the body of the request to create a VM:{ "folderId": "b1gvmob95yys********", "name": "instance-demo-no-pwauth", "zoneId": "ru-central1-a", "platformId": "standard-v3", "resourcesSpec": { "memory": "2147483648", "cores": "2" }, "metadata": { "user-data": "#cloud-config\nusers:\n - name: user\n groups: sudo\n shell: /bin/bash\n sudo: 'ALL=(ALL) NOPASSWD:ALL'\n ssh-authorized-keys:\n - ssh-ed25519 AAAAB3N... user@example.com" }, "bootDiskSpec": { "diskSpec": { "size": "2621440000", "imageId": "fd8rc75pn12f********" } }, "networkInterfaceSpecs": [ { "subnetId": "b0c6n43ftldh********", "primaryV4AddressSpec": { "oneToOneNatSpec": { "ipVersion": "IPV4" } } } ], "serviceAccountId": "ajelabcde12f********" }
Where:
-
folderId
: Folder ID. -
name
: Name assigned to the VM upon creation. -
zoneId
: Availability zone that corresponds to the selected subnet. -
platformId
: Platform. -
resourceSpec
: Resources available to the VM. The values must match the selected platform. -
metadata
: In the metadata, provide the public key for VM access via SSH. For more information, see VM metadata. -
bootDiskSpec
: Boot disk settings. Specify the selected image ID and disk size. The disk size must not be less than the minimum value specified in the image details. -
networkInterfaceSpecs
: Network setting:-
subnetId
: ID of the selected subnet. -
primaryV4AddressSpec
: IP address to assign to the VM. To add a public IP to your VM, specify:"primaryV4AddressSpec": { "oneToOneNatSpec": { "ipVersion": "IPV4" } }
-
-
serviceAccountId
: ID of the service account created in the previous step.
Read more about the request body format in the API reference.
-
-
Create a VM:
export IAM_TOKEN=CggaATEVAgA... curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${IAM_TOKEN}" \ -d '@body.json' \ https://compute.api.cloud.yandex.net/compute/v1/instances
- In the management console
Build and upload the Docker image to Container Registry
-
To make command execution easier, add the following variables:
-
Username and your VM's public IP as
${PUBLIC_IP}
:export PUBLIC_IP=<username>@<VM_public_IP_address>
-
ID of the previously created registry in
crpc9qeoft23********
format as${REGISTRY_ID}
:export REGISTRY_ID=<registry_ID>
-
-
Authenticate as yourself:
Using an OAuth tokenUsing an Yandex Identity and Access Management tokenUsing the Docker credential helper-
If you do not have an OAuth token yet, get one by following this link
. -
Run this command:
echo <OAuth_token> | docker login --username oauth --password-stdin cr.yandex
Result:
Login succeeded
Note
The IAM token has a short lifetime — no more than 12 hours. That's why this is a good method for applications that automatically request an IAM token.
-
Get an Identity and Access Management token.
-
Run this command:
yc iam create-token | docker login --username iam --password-stdin cr.yandex
Result:
... Login succeeded
-
If you do not have a YC CLI profile yet, create one.
-
Configure Docker to use
docker-credential-yc
:yc container registry configure-docker
Result:
Credential helper is configured in '/home/<user>/.docker/config.json'
Settings are saved in the current user's profile.
Warning
Credential helper only works when using Docker without
sudo
. You can learn how to configure Docker to run under current user withoutsudo
in the official documentation . -
Make sure that Docker is configured.
The
/home/<user>/.docker/config.json
configuration file must include the following line:"cr.yandex": "yc"
-
You can now use Docker, for example, to push Docker images. You do not need to run the
docker login
command for that.
-
-
Create a file called Dockerfile:
touch .dockerfile
-
Open Dockerfile in a text editor, e.g.:
nano .dockerfile
-
Add the lines below to the file:
FROM ubuntu:latest CMD echo "Hi, I'm inside"
-
Build a Docker image:
docker build . -t cr.yandex/${REGISTRY_ID}/ubuntu:hello -f .dockerfile
Result:
... Successfully built b68ee9b6b1af Successfully tagged cr.yandex/crpmnjr98tm5********/ubuntu:hello
-
Push the built Docker image to Container Registry:
docker push cr.yandex/${REGISTRY_ID}/ubuntu:hello
Result:
The push refers to repository [cr.yandex/crpc9qeoft23********/ubuntu] cc9d18e90faa: Pushed 0c2689e3f920: Pushed 47dde53750b4: Pushed hello: digest: sha256:42068479274f1d4c7ea095482430dcba24dcfe8c23ebdf6d32305928******** size: 943
Download the Docker image on the VM
-
Use SSH to connect to the VM.
-
Authenticate under the service account tied to the machine:
curl -H Metadata-Flavor:Google 169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token | \ cut -f1 -d',' | \ cut -f2 -d':' | \ tr -d '"' | \ docker login --username iam --password-stdin cr.yandex
Result:
Login succeeded
-
Download the Docker image to the VM:
docker pull cr.yandex/${REGISTRY_ID}/ubuntu:hello
Result:
hello: Pulling from crpc9qeoft23********/ubuntu 6a5697faee43: Pulling fs layer ba13d3bc422b: Pulling fs layer ... Digest: sha256:42068479274f1d4c7ea095482430dcba24dcfe8c23ebdf6d32305928******** Status: Downloaded newer image for cr.yandex/crpc9qeoft23********/ubuntu:hello cr.yandex/crpc9qeoft23********/ubuntu:hello
Check the result
Run the Docker image on the VM:
docker run cr.yandex/${REGISTRY_ID}/ubuntu:hello
Result:
Hi, I'm inside
How to delete the resources you created
To stop paying for the resources you created:
- Delete the VM.
- Delete the static public IP if you reserved one.
- Delete the Docker image.
- Delete the registry.
How to create an infrastructure using Terraform
Terraform
For more information about the provider resources, see the documentation on the Terraform
If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.
To create an infrastructure for running a Docker image on a VM using the registry:
-
Install Terraform and specify the source for installing the Yandex Cloud provider (see Configure a provider, step 1).
-
Prepare a file with the infrastructure description:
Ready-made archiveManually- Create a directory for the file with the infrastructure description.
- Download the archive
(1.5 KB). - Unpack the archive to the directory. As a result, it should contain the
run-docker-on-vm.tf
configuration file.
-
Create a directory for the file with the infrastructure description.
-
In the directory, create a configuration file named
run-docker-on-vm.tf
:Contents of the run-docker-on-vm.tf filelocals { zone = "<default_availability_zone>" username = "<VM_username>" ssh_key_path = "<public_SSH-key_path>" target_folder_id = "<directory_ID_for_VM_placement>" registry_name = "<registry_name>" sa_name = "<service_account_name>" network_name = "<cloud_network_name>" subnet_name = "<subnet_name>" vm_name = "<VM_name>" image_id = "<image_ID>" } terraform { required_providers { yandex = { source = "yandex-cloud/yandex" version = ">= 0.47.0" } } } provider "yandex" { zone = local.zone } resource "yandex_container_registry" "my-registry" { name = local.registry_name folder_id = local.target_folder_id labels = { my-label = "my-label-value" } } resource "yandex_iam_service_account" "registry-sa" { name = local.sa_name folder_id = local.target_folder_id } resource "yandex_resourcemanager_folder_iam_member" "registry-sa-role-images-puller" { folder_id = local.target_folder_id role = "container-registry.images.puller" member = "serviceAccount:${yandex_iam_service_account.registry-sa.id}" } resource "yandex_vpc_network" "docker-vm-network" { name = local.network_name } resource "yandex_vpc_subnet" "docker-vm-network-subnet-a" { name = local.subnet_name zone = local.zone v4_cidr_blocks = ["192.168.1.0/24"] network_id = yandex_vpc_network.docker-vm-network.id } resource "yandex_compute_disk" "boot-disk" { name = "bootvmdisk" type = "network-hdd" zone = "local.zone" size = "5" image_id = local.image_id } resource "yandex_compute_instance" "docker-vm" { name = local.vm_name platform_id = "standard-v3" zone = local.zone service_account_id = "${yandex_iam_service_account.registry-sa.id}" resources { cores = 2 memory = 2 } boot_disk { disk_id = yandex_compute_disk.boot-disk.id } network_interface { subnet_id = "${yandex_vpc_subnet.docker-vm-network-subnet-a.id}" nat = true } metadata = { user-data = "#cloud-config\nusers:\n - name: ${local.username}\n groups: sudo\n shell: /bin/bash\n sudo: 'ALL=(ALL) NOPASSWD:ALL'\n ssh-authorized-keys:\n - ${file("${local.ssh_key_path}")}" } }
-
Under
locals
, set the parameters for resources to create:zone
: Availability zone that will host the VM.username
: Name of the user to be created on the VM.ssh_key_path
: Path to the file with a public SSH key to authenticate the user on the VM. For more information, see Creating an SSH key pair.target_folder_id
: ID of the folder to host the VM.registry_name
: Container Registry registry name.sa_name
: Service account name.network_name
: Name of the cloud network.subnet_name
: Subnet name.vm_name
: VM name.image_id
: ID of the image to create the VM from. For more information, see Getting a list of public images.
-
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.
-