Cluster actions

This article describes the basic actions available for working with an ADS cluster in the ADCM interface.

Actions with a cluster are performed on the CLUSTERS tab.

For each cluster, ADCM provides:

  • Name, Bundle, Description, State — columns displaying information about the cluster;

  • Status, Actions, Import, Upgrade, Config — columns with interactive interface elements (icons).

For some columns, it is possible to sort rows (created clusters) alphabetically.

cluster actions 01
ADS cluster in ADCM interface

Cluster information

The columns display the following information about the cluster:

  • Name — name given when the cluster was created.

  • Bundle — name and version of the bundle.

  • Description — description entered when the cluster was created.

  • State — current state of the cluster (created, installed, kerberized, etc.).

Working with interactive interface elements in a cluster

Working with interactive UI elements in the cluster is done by clicking on the element (icon).

On the JOBS tab, you can view the process of some actions (for example, starting or stopping a cluster, updating a cluster). Also on the JOBS tab, you can analyze errors if they occur.


When you click on the Status icon green status, you go to the Status cluster menu page, which shows the statuses of all components of all services on hosts. The image of the icon changes depending on the current state of the cluster. If the cluster is not working correctly, the icon Status warning orange warning is displayed.

cluster actions 04
Statuses of all components of all services


When you click on the Actions icon green arrow, the drop-down list offers actions for working with the cluster.

cluster actions 02
Actions for working with an ADS cluster
  • Start and Stop respectively start and stop all cluster services. The services are launched in the same sequence as during installation — first the required services, then the additional ones. When the cluster is stopped, additional services are stopped first, then the required ones.

    After selecting the action Start or Stop, click Run in the opened dialog box.

    cluster actions 03
    Start cluster
  • Enable Basic Auth enables basic authentication for services:

    • Schema Registry

    • Kafka REST Proxy

    • KSQL

    Authentication is configured in accordance with the article Basic authentication.

  • Enable Kerberos provides a choice of Kerberos authentication using previously configured servers:

    • KDC

    • LDAP

    • FreeIPA

    Authentication is configured in accordance with the articles MIT Kerberos and Kerberos with MS Active Directory.

  • Enable PLAIN starts enabling authentication using the PLAIN mechanism. Authentication is configured in accordance with the article SASL PLAIN.

  • Enable SSL starts enabling of channel security via the SSL protocol. Configuring the channel protection via the SSL protocol is carried out in accordance with the article SSL channel security.

  • Reinstall status-checker is used when migrating a cluster to a new ADCM server. Running Reinstall status-checker starts a reconfiguration and restart of the statuschecker for all cluster services.

    After selection, you must confirm the action by clicking Run.

    cluster actions 35
    Action confirmation


When you click on the Import icon import, you go to the Import cluster menu page, on which you install the import of components for integrating the ADS cluster with other clusters installed in ADCM (Enterprise Tools, Monitoring, ADPS).

cluster actions 07
Import components for ADS cluster integration


The Upgrade icon upgrade grey is used to upgrade the cluster version.

To update the cluster version, do the following:

  1. Download the ADS bundle of the new version. To do this, go to the BUNDLES tab, click Upload bundles, upload the pre-downloaded bundle of the new cluster version.

    cluster actions 08 1
    Loading the bundle

    After the bundle is loaded, the Upgrade upgrade grey icon changes color.

  2. Click on the Upgrade icon upgade orange and select the available version from the list.

    cluster actions 08
    ADS cluster upgrade available
  3. In the dialog box that opens, click Run.

    cluster actions 09
    Upgrade ADS cluster

    As a result, the status in the State column is changed to upgrade from 1.7.0 (depending on the cluster version) — the cluster is ready for upgrade.

    cluster actions 10
    Upgrade ADS cluster
  4. Click on the Actions icon green arrow and select the Upgrade action.

    cluster actions 14
    Upgrade ADS cluster
  5. In the dialog box that opens, click Run.

    As a result of updating the cluster, the Bundle column displays the designation of the new version of the bundle, the status in the State column is changed to installed.

    cluster actions 12
    ADS cluster after upgrade


When you press the Config icon config, you go to the Configuration cluster menu page. Configuration parameters are described in the Cluster configuring article.

cluster actions 11
Cluster configuration parameters


The icon delete in the last column is intended for removing a cluster from the ADCM interface.

cluster actions 12 1
Deleting a cluster

When deleting a cluster, you must confirm the action in the dialog box that opens.

cluster actions 13
Action confirming
Found a mistake? Seleсt text and press Ctrl+Enter to report it