Manage an SSH hostprovider

Overview

After you create and configure an SSH hostprovider, you can manage it on the Hostproviders page of the ADCM web interface. To see available hostprovider actions, click the actions default dark actions default light icon in the Actions column.

SSH hostprovider actions
SSH hostprovider actions

When you choose an action, ADCM displays a dialog window to confirm your choice. In this dialog window, you can select the Verbose checkbox to see additional execution details on the Jobs page. For some actions, you should first fill in additional options in a separate window.

Standard window to confirm all actions
Standard window to confirm all actions

When an action starts, ADCM displays its execution process and result on the Jobs page. From this page, you can navigate to a page with details on an individual job (by clicking a job name) to see inner steps of that job execution and analyze errors, if any.

The job page
The job page

All available hostprovider actions are listed below.

Create hosts

The Create hosts action adds information about several hosts to ADCM. All hosts should be created in a cloud or on-premises first. For each host, if an IP address can be identified, the SSH connection is checked and the statuschecker is installed. Thus, you do not need to run the Check connection and Install statuschecker actions for each created host.

IMPORTANT
  • Before you select the action, fill in the following SSH hostprovider settings:

    • Port

    • Username

    • Password or SSH private key

  • To add and configure each host separately, run the Create host action on the Hosts page.

After you select the Create hosts action, a dialog box opens where you can set the following parameters:

  • Count — a number of hosts.

  • Name — a common part of host names. A full host name is formed as <Name>-<N>, where <N> is a host number (from 1 to <Count>).

  • Domain name — a domain name.

  • Resolve IP — a flag that indicates whether ADCM can access the DNS server that provides the Domain name domain. If there is no such access, set the field value to false and specify IP addresses in the settings of new hosts manually after the Create hosts action is completed. Then, apply the Check connection and Install statuschecker actions to each created host.

The figure below shows how to fill in the action parameters for two hosts that already exist in the Yandex Cloud and have the following FQDNs: bds-sdw-1.ru-central1.internal and bds-sdw-2.ru-central1.internal (resolving IP is possible).

The Create hosts action form
The "Create hosts" action form

To run the Create hosts action, click Run in the action form. Then, confirm the action in the standard confirmation dialog.

As a successful result, new hosts and their actions become available on the Hosts page. For each host, an IP address is defined automatically if possible (see Resolve IP above). Other parameters (Username, Port, Password/SSH private key) are filled in as well — based on the SSH hostprovider settings.

New hosts on the Hosts page
New hosts on the Hosts page

Create users

The Create users action adds new users to all hosts that were previously created via the SSH hostprovider. Names and public SSH keys of created users are extracted from the SSH keys field of the SSH hostprovider configuration options. Users will be able to access hosts using their private SSH keys.

After you select the action, the standard confirmation dialog opens. Click Run to confirm the action. No additional parameters are required.

IMPORTANT
  • Before running the action, create and configure all hosts first — using the Create hosts action on the Hostproviders page or the Create host action on the Hosts page.

  • Public SSH keys of all created users should be specified in the SSH keys field of the SSH hostprovider settings.

Install statuschecker

The Install statuschecker action installs the statuschecker on all hosts that were previously created via the SSH hostprovider. This is a special daemon that periodically checks the status of services and components added to the cluster hosts via ADCM.

After you select the action, the standard confirmation dialog opens. Click Run to confirm the action. No additional parameters are required.

IMPORTANT

Before running the action, create and configure all hosts first — using the Create hosts action on the Hostproviders page or the Create host action on the Hosts page.

Found a mistake? Seleсt text and press Ctrl+Enter to report it