Contact UsGet started

Working with Yandex Cloud from inside a VM

Written by
Improved by
Updated at November 21, 2024

This section describes how to work with Yandex Cloud from inside a VM via the API or CLI.

To automate operations with Yandex Cloud from inside a VM, we recommend using service accounts. This is more secure since you do not need to save your OAuth token on a VM and can restrict access rights to a service account.

Yandex Cloud provides simplified authentication via the API and CLI from inside a VM for service accounts. To authenticate:

  1. If you do not have a service account yet, create one and configure access rights for it.
  2. Link the service account to your VM.
  3. Authenticate from inside a VM.

Link your service account to an existing or new VM. You can only link one service account.

To link a service account to a VM, you must have permission to use this account. This permission comes with the iam.serviceAccounts.user and editor roles or higher.

  1. In the management console, select the folder the VM belongs to.
  2. In the list of services, select Compute Cloud.
  3. Click the VM name.
  4. In the top-right corner of the page, click Edit VM.
  5. Under Additional, select an existing service account or create a new one.
  6. Click Save changes.

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.

Update the VM parameters by specifying the service account via the --service-account-name or --service-account-id option:

yc compute instance update my-instance --service-account-name test

Use the update REST API method for the Instance resource or the InstanceService/Update gRPC API call. Specify the service account ID in your request.

In the management console, you can link a service account to a virtual machine located in the same folder as the VM being created. If the service account is in a different folder, use the CLI or API.

To link a service account to a VM, select it under Additional in the Service account field when creating a VM. You can select an existing service account or create a new one.

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.

Create a VM by specifying the service account using the --service-account-name or --service-account-id option:

yc compute instance create \
  --name my-instance \
  --network-interface subnet-name=default,nat-ip-version=ipv4 \
  --ssh-key ~/.ssh/id_ed25519.pub \
  --service-account-name my-robot

Use the create REST API method for the Instance resource or the InstanceService/Create gRPC API call. Specify the service account ID in your request.

Authenticating from inside a VM

To authenticate from inside a VM on behalf of the linked service account:

  1. Connect to your VM over SSH.

  2. If you do not have the Yandex Cloud command line interface yet, install and initialize it.

  3. Create a new profile:

    yc config profile create my-robot-profile

  4. Configure your profile to run commands.

    Some commands require that you specify unique IDs for your cloud and folder. You can specify their details in the profile or use a specific flag for these commands.

    1. Specify the cloud in your profile:

      yc config set cloud-id <cloud_ID>

      You can also use the --cloud-id parameter to run commands.

    2. Specify a folder in the profile:

      yc config set folder-id <folder_ID>

      You can also use the --folder-id parameter to run commands.

    All operations in this profile will be performed on behalf of the linked service account. You can change the profile parameters or switch to another profile.

    You can also get a Yandex Identity and Access Management token, for example, to authenticate with the API:

    yc iam create-token

    The lifetime of an Identity and Access Management token in this case will be less than 12 hours. Request an Identity and Access Management token more often, e.g., every hour. To learn the remaining token lifetime, use the API instructions.

  1. Connect to the VM via SSH.

  2. Get an Identity and Access Management token from metadata in Google Compute Engine format:

    curl \
  --header Metadata-Flavor:Google http://169.254.169.254/computeMetadata/v1/instance/service-accounts/default/token

    Result:

    {"access_token":"CggVAgAAA...","expires_in":39944,"token_type":"Bearer"}

    The response will return an Identity and Access Management token in the access_token field. The remaining lifetime of the Identity and Access Management token is specified in the expires_in field.

  3. Specify the received IAM token when accessing Yandex Cloud resources via the API. Provide the IAM token in the Authorization header in the following format:

    Authorization: Bearer <IAM_token>

Keep track of the Identity and Access Management token lifetime or request a new token more often, e.g., every hour.

Previous
Connecting to a VM via OS Login
Next
Installing NVIDIA drivers