Add Yandex Compute VM hostprovider

Daria Barysheva

This topic shows how to add the Yandex Compute VM hostprovider, which allows to create multiple virtual machines in the Yandex.Cloud.

  • Prerequisites

  • Restrictions

Before adding the Yandex Compute VM hostprovider, make sure that:

  • The Folder exists in the Yandex.Cloud.

  • The subnet is created in the Yandex.Cloud.

  • ADCM can establish the connection to the specified subnet in the Yandex.Cloud.

  • The user that creates the virtual machine has all necessary rights.

 
If automatic Red Hat registration is required for virtual machines using RHEL, you should have:

  • A subscription to Red Hat services and the corresponding organization ID.

  • A configured Red Hat activation key.

In comparison with the Yandex.Cloud console, the Yandex Compute VM hostprovider does not support the configuring of:

  • Static IP addresses.

  • DDoS protection.

  • Additional network adapters.

A typical installation sequence for the Yandex Compute VM hostprovider includes the following steps.

Step 1. Download a hostprovider bundle

Hostprovider distributions for ADCM come in bundles. Regarding the Yandex Compute VM hostprovider, a bundle is a regular archive that includes a description and logic to interact with the Yandex.Cloud.

The steps for downloading a bundle are given below:

  1. Go to the Arenadata Cluster Manager product website and click Download.

    adcm hostprovider add 01
    Switching to the Arenadata Cluster Manager downloading page

    Another way — go to https://network.arenadata.io/ and choose Arenadata Cluster Manager.

  2. On the next page, download a required bundle. Yandex Compute VM hostprovider bundles are called Yandex Compute VM Provider Bundle.

Step 2. Upload a hostprovider bundle to ADCM

To upload a bundle to ADCM, follow these steps in the ADCM web interface:

  1. Open the BUNDLES tab and click Upload bundle.

  2. Select the downloaded bundle in the Open File Dialog.

    yandex bundle upload dark
    Switching to uploading a bundle
    yandex bundle upload light
    Switching to uploading a bundle

  3. As a result of the performed actions, the uploaded bundle is displayed at the BUNDLES tab.

    yandex bundle success
    The result of successful uploading a bundle

Step 3. Create a hostprovider based on the uploaded bundle

To add a new hostprovider to ADCM on the base of the uploaded bundle, follow these steps in the ADCM web interface:

  1. Open the HOSTPROVIDERS tab and click Create provider.

    yandex hostprovider add
    Creating a new hostprovider

  2. In the opened window:

    • Select the uploaded bundle in the Bundle field.

    • Select the desired version of the bundle in the Version field. Several versions become available in the case of different versions of the same bundle being uploaded. By default, the latest version is displayed.

    • Enter the hostprovider name in the Hostprovider name field.

    • Enter the hostprovider description in the Description field, if necessary.

    • Click Create.

    yandex hostprovider card
    Filling in the new hostprovider parameters

  3. As a result of the performed actions, the created hostprovider is displayed at the HOSTPROVIDERS tab.

    yandex hostprovider success
    The result of successful adding a hostprovider

Step 4. Configure a hostprovider

In order to configure the access to the cloud, perform the following actions:

  1. Open the HOSTPROVIDERS tab, find the row with a desired hostprovider, and click the gear icon in the Config column.

    yandex hostprovider config
    Switching to configuring the hostprovider

  2. In the next window set the Advanced flag, fill in the necessary parameters, and click Save.

    yandex hostprovider config card
    Configuring the hostprovider

    The assignment of parameters is listed below.

    Configuration parameters
    UI pane Parameter Mandatory Description

    cloud

    Service account credentials

    No

    Static access keys, that can be obtained for the service account according to the Yandex.Cloud documentation. The Service account credentials field is incompatible with OAuth, you should use only one of these fields for authentication. Pay attention, that static keys should be transformed into the JSON format before being inserted into the field

    Endpoint

    No

    A custom endpoint, that is used to connect to a private Yandex.Cloud installation

    Root certificates

    No

    The root certificates, that are used to connect to a private Yandex.Cloud installation

    OAuth

    No

    An OAuth token, that can be obtained according to the Yandex.Cloud documentation. The OAuth field is incompatible with Service account credentials, you should use only one of these fields for authentication

    Folder ID

    Yes

    A target folder for new virtual machines, for example b1gotqhf08176hh183dn. Can be copied from the Id column in the folders list of the Yandex.Cloud

    Subnet ID

    Yes

    A target subnet for new virtual machines, for example b0cccgrn656k0nixi92a. To get the Subnet ID value, open the Virtual Private Cloud service in the Yandex.Cloud console, click on the desired network in the Cloud networks section, and copy the value of the Id column from the row that contains the desired subnet in the list of subnets that opens

    Zone

    Yes

    A target availability zone for new virtual machines, for example ru-central1-c. Every zone corresponds to the specific data center . To get the Zone value, open the Virtual Private Cloud service in the Yandex.Cloud console, click on the desired network in the Cloud networks section, and copy the value of the Zone column from the row that contains the desired subnet in the list of subnets that opens

    metadata

    Ssh keys

    No

    A list of OpenSSH keys with the user@hostname data in the end. When adding virtual machines, the users list is parsed from this field. Every user is created with the corresponding key

    default_host_settings

    Active operations limit timeout

    No

    A timeout activated when the quota of simultaneously performed operations is exceeded (resulting in errors returned by the Yandex.Cloud gPRC). If empty, the timeout is not activated. If 0, the waiting time is unlimited. Any positive integer in the field equals the waiting time, during which the operation should move from the queue to the execution stage. Measured in seconds

    Labels

    No

    The default labels that are used for all created VMs. Should be specified in the key:value format. The labels, specified when adding VMs, have a higher priority compared to the labels, specified for the hostprovider

    redhat_subscription

    Organization ID

    No

    The organization ID that is provided at subscribing to Red Hat services. This ID is available in the Red Hat client portal. Should be filled in simultaneously with the Activation key field, if automatic Red Hat registration is required for virtual machines using RHEL. The field is available in the 2.15 bundle version or later

    Activation key

    No

    An activation key that is configured in the Red Hat client portal. Should be filled in simultaneously with the Organization ID field, if automatic Red Hat registration is required for virtual machines using RHEL. The field is available in the 2.15 bundle version or later

  3. Return to the HOSTPROVIDERS tab. As a result, the orange exclamation mark stops being displayed in the Actions column. The actions available for the configured hostprovider can be opened by clicking the icon in the Actions column.

    yandex hostprovider result
    The result of successful hostprovider configuring
Found a mistake? Seleсt text and press Ctrl+Enter to report it