Cluster actions

Olga Semme

This article describes the basic actions available for working with a cluster ADS 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 — the name given when the cluster was created.

  • Bundle — the name and version of the bundle.

  • Description — the description entered when the cluster was created.

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

Working with interactive interface elements in a cluster

Working with interactive elements in a cluster is done by clicking on an 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.

Status

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 the 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

Actions

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 ADS cluster

After every Enable action is performed, the corresponding Disable action and other accompanying actions appear.

cluster actions 26
Actions for working with ADS cluster after running all Enable actions

  • 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
    Action confirmation

  • Enable Basic Auth enables basic authentication for services:

    • Schema Registry

    • Kafka REST Proxy

    • KSQL

    Authentication is configured in accordance with the article Basic authentication.

  • Manage Basic Auth users appears after Enable Basic Auth has been performed. This action allows you to create, update and delete a user.

    After selection, specify what action should be performed on the user by turning on the corresponding switch. Launching is possible when only one action is selected.

    cluster actions 21
    Selecting an action on the user

    After turning on the Create user switch, you should enter a username and password. The username may contain letters, numbers, dots, underscores and/or hyphens. Next, you need to specify the user’s role in the line Role — admin or user. After entering the data, click Run.

    cluster actions 23
    User creation

    After turning on the Update user data switch, you should enter the name of an existing user and new data (password). Next, you need to specify the user’s role in the line Role — admin or user. After entering the data, click Run.

    As a result of the action, a new user password is set.

    cluster actions 24
    User data update

    After turning on the Delete user switch, you should enter the name of the user to be deleted. After entering the data, click Run.

    cluster actions 25
    Deleting a user

  • Disable Basic Auth appears after Enable Basic Auth has been performed. This action disables basic authentication. To run the action, enable the Clear users from ADCM parameter in the dialog box that opens, if you want to delete previously created users. Then click Run.

    cluster actions 18
    Action confirmation

  • 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.

  • Disable Kerberos appears after Enable Kerberos has been performed. This action disables Kerberos authentication.

    cluster actions 22
    Start Disable Kerberos

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

  • Create/Update/Delete user appears after Enable PLAIN has been performed. This action allows you to create, update, and delete users. Working with users is similar to the Manage Basic Auth users action described by above. For more information about working with users in Kafka, see Use SASL PLAIN in Kafka.

  • Disable PLAIN appears after Enable PLAIN has been performed. This action disables SASL PLAIN authentication.

    After selection, confirm the action by clicking Run.

    cluster actions 20
    Action confirmation

  • 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.

  • Disable SSL appears after Enable SSL has been performed. This action disables channel protection via the SSL protocol.

    Disabling the channel protection via the SSL protocol is performed in accordance with the section Disabling SSL on an ADS cluster using ADCM.

  • Reconfig Kerberos appears after Enable Kerberos has been performed. This action reconfigures the Kerberos protocol after making changes to the configuration files and parameters in accordance with the articles MIT Kerberos and Kerberos with MS Active Directory.

    After selection, click Run in the opened dialog box.

    cluster actions 27
    Action confirmation

  • 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, click Run in the opened dialog box.

    cluster actions 35
    Action confirmation

Import

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

cluster actions 07
Import components for ADS cluster integration

Upgrade

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

To update the cluster version, do the following:

  1. Download bundle ADS new version. To do this, go to the BUNDLES tab, click Upload bundles and select the pre-uploaded bundle in the window that opens.

    cluster actions 08 1
    Loading the bundle

    After loading the bundle, the Upgrade icon upgrade grey on the CLUSTERS tab becomes active.

  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
    Cluster ready for upgrade

  4. On the CLUSTERS tab, click on the Actions icon 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

Config

Clicking on the Config icon config takes you to the Configuration cluster menu page. Configuration parameters are described in the article Cluster configuring .

cluster actions 11
Cluster configuration parameters

Delete

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

cluster actions 12 1
Deleting a cluster

When deleting a cluster, click Yes in the opened dialog box.

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