Overview of the Clusters tab in the ADCM UI

Adelya Zvyagintseva

After you upload a cluster bundle, you can install and manage clusters on the Clusters tab in the ADCM web interface via the cluster actions that are described below.

List of clusters

On the Clusters tab, you can view the list of clusters in two view modes: Table view and Widget view.

Table view

In Table view, clusters are displayed as a table containing information about each cluster. The descriptions of the table fields are provided below.

The Clusters tab in Table view
The Clusters tab in Table view
Fields of the Clusters tab
Field Description

Name

Name of the cluster specified during the cluster creation.

The dot located next to the cluster name determines the cluster status. The green dot indicates that all cluster components and hosts work. The yellow one indicates that any of the components or hosts is stopped or is not available.

If needed, it is possible to rename the cluster if it has the created status

State

Current state of the cluster. The list of possible values depends on a product in use

Product

Product name

Version

Version of the cluster bundle used to install or upgrade the cluster

Description

Cluster description specified during the cluster creation.

Starting with ADCM 2.8.0, it is possible to change the description of the cluster

Concerns

One of the following icons:

A pop-up window with the error description appears when hovering over the concern red dark concern red light or concern yellow dark concern yellow light icon

Operations

Icons for managing the cluster:

  • actions default dark actions default light — opens the drop-down list with actions to manage the cluster.

  • upgrade default — indicates whether a new version of the bundle is available and allows you to upgrade the cluster. If no version is available, the icon image is changed to upgrade dark disabled upgrade light disabled.

  • delete — deletes the information about the cluster from ADCM.
NOTE
The actions default dark actions default light icon is also available on the cluster page.

To sort the clusters alphabetically, click the arrow down dark arrow down light (from Z to A) or arrow up default dark arrow up default light (from A to Z) icon in the Name column.

Widget view

In Widget view, each cluster is displayed as an individual widget.

The Clusters tab in Widget view
The Clusters tab in Widget view

The top section of the widget displays the following information:

  • cluster name which contains a link to the cluster page;

  • cluster status (possible values: Up or Down);

  • cluster state;

  • product name (for example, ADQM);

  • cluster bundle version;

  • cluster edition (possible values: Community or Enterprise).

Cluster widget elements
Element Description

Services

Number of services added to the cluster

Hosts

Number of hosts included in the cluster

CPU

Cluster CPU usage information

RAM

Cluster RAM usage information

Disk

Cluster disk space usage information
NOTE
Resource usage data (CPU, RAM, Disk) is updated once a day.

The bottom section of the widget contains icons for managing the cluster (similar to the icons in the Operations column in Table view).

By clicking a widget, you can open a sidebar on the right with detailed cluster information. The sidebar includes:

  • cluster name;

  • cluster status;

  • the edit dark edit light icon to rename and edit the cluster description;

  • the Full overview button to go to the cluster page;

  • circle diagrams showing the ratio of services (Services) and hosts (Hosts) in Up and Down statuses;

  • section with a list of blocking and non-blocking concerns.

Search and filter

To search for a created cluster in the list, enter its name in the Search cluster name field.

To filter clusters:

  • by status — select the required value from the drop-down list in the field next to Status;

  • by product name — select the required value from the drop-down list in the field next to Product.

To reset search and filter settings, click the reset dark reset light icon.

Change a name and description of a cluster

To change the name of a cluster that has the created status, follow these steps:

  1. Depending on the view mode:

    • Table view — hover over the cluster row.

    • Widget view — click the cluster widget.

  2. Click the edit dark edit light icon:

    • in Table view — in the Name column.

    • in Widget view — at the top of the widget.

  3. In the modal window, specify a new name for the cluster.

  4. Click Save.

When renaming a cluster, make sure that a new name meets the following requirements:

  1. Consists of 2—​150 characters.

  2. Begins with Latin uppercase [A-Z] or lowercase [a-z] letter or digit [0-9].

  3. Contains only the following characters: Latin uppercase [A-Z] or lowercase [a-z] letters, digits [0–9], period [.], hyphen [-], or underscore [_].

  4. Does not end with a space, period [.], hyphen [-], or underscore [_].

To change the cluster description, follow these steps:

  1. Depending on the view mode:

    • Table view — hover over the cluster row.

    • Widget view — click the cluster widget.

  2. Click the edit dark edit light icon:

    • in Table view — in the Description column.

    • in Widget view — at the top of the widget.

  3. In the modal window, specify a new description for the cluster. Note that a cluster description should not exceed 256 characters.

  4. Click Save.

Changing the cluster description is also available on the cluster page in the Description section.

Operations with a cluster

ADCM allows you to install and manage clusters. The installation process includes the following steps:

  1. Create a cluster.

  2. Add services.

  3. Add hosts to a cluster.

  4. Map components to hosts.

  5. Configure services.

  6. Configure a cluster.

  7. Launch actions.

  8. Upgrade a cluster.

To install a new cluster, see the following Get started guides, depending on the product in use:

After you install the cluster, you can manage it on the Clusters tab. To select one of the available cluster actions, click the actions default dark actions default light icon located:

  • in Table view — in the Operations column.

  • in Widget view — at the bottom of the widget.

For more information on actions for each product cluster, refer to the following links:

When you select an action, ADCM opens a modal window.

The modal window allows you to run the action without blocking the object if necessary, add a comment with a brief description of the action to be launched, and select the Verbose checkbox to view additional information about the action execution on the Jobs page.

Modal window for running the Install action
Modal window for running the Install action

For some actions, you should first fill in additional options on a separate tab.

Cluster details

To get detailed information about the cluster, click the cluster name:

  • in Table view — in the Name column of the table located on the Clusters tab.

  • in Widget view — in the cluster widget.

The Overview tab of the Test ADQM cluster page
The Overview tab of the Test ADQM cluster page

The cluster page includes multiple tabs, each of which is described in detail below. For more examples of tabs, see the Get started guides for each product.

Overview

The Overview tab on a cluster page displays detailed information on the selected cluster. The tab includes:

  • sections:

    • Cluster info — basic cluster information: product name, cluster bundle version, and cluster edition.

    • Resources — cluster resource usage metrics.

    • Services — a circle diagram showing the ratio of services in Up and Down statuses.

    • Hosts — a circle diagram showing the ratio of hosts in Up and Down statuses.

    • Concerns — information about existing cluster concerns with the option to view all (All), blocking (Blocking), and non-blocking (Non-blocking) concerns.

    • Bundle info — reference information about the current cluster bundle.

  • tabs:

    • Services

    • Hosts

The Services tab contains information about services included in the cluster. Next to each service name, the ratio of successfully installed components to total components on the host is displayed.

To filter services:

  • by name — enter text in the Search field;

  • by status — select one of the following tabs:

    • All — all services added to the cluster;

    • Up — operational cluster services;

    • Down — inactive cluster services;

    • Maintenance mode — cluster services switched to maintenance mode.

      NOTE
      The health of an object in ADCM is determined by its state.

For example, to view cluster services that may function correctly but whose status is not reported by the hosts to ADCM, switch to the Down tab. To open the Components tab of the <Cluster name> → Services page, click the service name.

The Hosts section displays information on the cluster hosts.

To filter hosts:

  • by name — enter text in the Search field;

  • by status — select one of the following tabs:

    • All — all hosts added to the cluster;

    • Up — hosts that regularly send heartbeats;

    • Down — hosts that do not send heartbeats.

    • Maintenance mode — hosts switched to maintenance mode.

The Host-Components tab opens by clicking the host name.

The Host-Components tab of the Test ADQM cluster → Hosts → zar-adqm-01.ru-central1.internal page
The Host-Components tab of the Test ADQM cluster → Hosts → zar-adqm-01.ru-central1.internal page

Services

The Services tab on a cluster page contains information on services added to a cluster.

The Services tab of the Test ADQM cluster page
The Services tab of the Test ADQM cluster page
Fields of the Services tab
Field Description

Name

Name of the service

Version

Version of the cluster bundle used to install or upgrade the cluster

State

Current state of the service (for example, created or installed)

Concerns

One of the following icons:

A pop-up window with the error description appears when hovering over the concern red dark concern red light or concern yellow dark concern yellow light icon

Operations

Icons for managing the service:

  • actions default dark actions default light — opens the drop-down list with actions to manage the service.

  • maintenance default — turns on the maintenance mode on the service if supported by the product in use. If maintenance mode is not supported by the product, the icon image is changed to maintenace disabled dark maintenace disabled light. After the action is executed, the service changes its state and the icon is changed to the maintenance active dark maintenance active light icon. In this state, the service can be transferred to normal mode.

  • delete — deletes the information about the service from ADCM. The service removal is possible after removing its components from hosts on the Mapping tab described below.

For more information on the service actions, refer to the following links, depending on the product in use:

To sort the services alphabetically, click the arrow down dark arrow down light (from Z to A) or arrow up default dark arrow up default light (from A to Z) icon in the Name column.

To search for a service in the list, enter its name in the Search service field.

To reset search parameters, click the reset dark reset light icon.

To add a service to a cluster, follow these steps:

  1. On the cluster page, open the Services tab.

  2. On the page that opens, click Add services.

  3. For further action, see the Add services article of the corresponding Get started guide mentioned above.

To get detailed information about the service, click the service name in the Name column of the table located on the Services tab of a cluster page.

The ADQMDB service page
The ADQMDB service page

At the top of the service page, the following is displayed:

  • service name with the service status;

  • service version;

  • ratio of components in the Up status to the total number of the service components;

  • buttons Actions and Delete.

Also, this page includes the following tabs:

  • Primary configuration — allows you to configure the general service settings. The tab description and information about working with configuration parameters are given in the Configuration parameters in the ADCM UI article.

  • Configuration groups — allows you to set up service configuration groups. For more information, refer to the article Set up configuration groups.

  • Action host groups — enables you to create and manage host groups to run actions allowed for the service separately for each group of hosts. For more information, refer to the article Set up host groups for actions.

  • Components — allows you to work with the service components. The tab description is given below. The example of the ADS components configuration is described in the Configure services article of the Get started guide.

  • Info — displays general information on the purpose of the selected service.

Components

The Components tab on the <Cluster name> → Services → <Service name> page contains information on the service components.

The Test ADQM cluster → Services → ADQMDB → Components tab
The Test ADQM cluster → Services → ADQMDB → Components tab
Fields of the <Cluster name> → Services → <Service name> → Components tab
Field Description

Name

Name of the component that contains a link to the Primary configuration tab of the <Cluster name> → Services → <Service name> → Components page

Hosts

Number of hosts assigned for the component that contains a link to the Hosts tab

Concerns

One of the following icons:

A pop-up window with the error description appears when hovering over the concern red dark concern red light or concern yellow dark concern yellow light icon

Operations

Icons for managing the component:

  • actions default dark actions default light — opens the drop-down list with actions to manage the component.

  • maintenance default — turns on the maintenance mode on the component if supported by the product in use. If maintenance mode is not supported by the product, the icon image is changed to maintenace disabled dark maintenace disabled light. After the action is executed, the component changes its state and the icon is changed to the maintenance active dark maintenance active light icon. In this state, the component can be transferred to normal mode.

To sort components alphabetically, click the arrow down dark arrow down light (from Z to A) or arrow up default dark arrow up default light (from A to Z) icon in the Name column.

To expand or collapse the list of hosts assigned for the component under the component row, click the three dots dark three dots light or three dots active default dark three dots active default light icon respectively.

Hosts

The Hosts tab on the cluster page contains information on hosts added to a cluster.

The Hosts tab of the Test ADQM cluster page
The Hosts tab of the Test ADQM cluster page
Fields of the Hosts tab
Field Description

Name

Name of the host that contains a link to the Host-Components tab of the <Cluster name> → Hosts → <Host name> page. When hovering over a host row, the copy dark copy light icon appears, allowing you to copy the host name

State

Current state of the host (for example, running)

Hostprovider

Name of the hostprovider used to create the host that contains a link to the Primary configuration tab of the hostprovider page

Components

Number of components added to the host that contains a link to the Host-Components tab of the <Cluster name> → Hosts → <Host name> page

Concerns

One of the following icons:

  • concern red dark concern red light — indicates the presence of blocking concerns.

  • concern yellow dark concern yellow light — indicates the presence of non-blocking concerns.

A pop-up window with the error description appears when hovering over the concern red dark concern red light or concern yellow dark concern yellow light icon

Operations

Icons for managing the host:

  • actions default dark actions default light — opens the drop-down list with actions to manage the host.

  • maintenance default — turns on the maintenance mode on the host if supported by the product in use. If maintenance mode is not supported by the product, the icon image is changed to maintenace disabled dark maintenace disabled light. After the action is executed, the host changes its state and the icon is changed to the maintenance active dark maintenance active light icon. In this state, the host can be transferred to normal mode.

  • link default — adds the host to a cluster. After the action is executed, the icon is changed to the unlink default icon which performs the opposite action.

For more information on actions for hosts based on different hostprovider types, refer to the Operations with host section.

To sort the hosts alphabetically, click the arrow down dark arrow down light (from Z to A) or arrow up default dark arrow up default light (from A to Z) icon in the Name column.

To search for a host in the list, enter its name in the Search hostname field.

To filter hosts:

  • by hostprovider name — select the required value from the drop-down list in the field next to Hostprovider;

  • by component name — select the required value from the drop-down list in the field next to Component.

To reset search and filter settings, click the reset dark reset light icon.

To add one or more hosts to a cluster, follow these steps:

  1. On the cluster page, open the Hosts tab.

  2. On the page that opens, click Add hosts.

  3. In the modal window that opens, select one or more hosts that should be added to the cluster and click Add.

    The Add hosts modal window
    The Add hosts modal window

    As a result, the added hosts are displayed on the Hosts tab.

    The Hosts tab with added host
    The Hosts tab with added host

To get detailed information about the host, click the host name in the Name column of the table located on the Hosts tab of a cluster page. The Host-Components tab of the <Cluster name> → Hosts → <Host name> page is opened.

The Host-Components tab of the Test ADQM cluster → Hosts → zar-adqm-01.ru-central1.internal page
The Host-Components tab of the Test ADQM cluster → Hosts → zar-adqm-01.ru-central1.internal page

For more information about the host page, refer to the Host details section.

Mapping

The Mapping tab on a cluster page allows you to allocate components among hosts.

The Mapping tab of the Test ADQM cluster page
The Mapping tab of the Test ADQM cluster page

For more information on how to allocate components among hosts, see the Add components article of the corresponding Get started guide mentioned above.

To search for a host or component in the list, enter the host or component name in the Search hosts or the Search components field respectively.

To sort components or hosts (depending on the allocation mode selected in the Hosts mode field):

  • in ascending (from A to Z) alphabetical order, click the arrow up default dark arrow up default light icon next to A-Z order.

  • in descending (from Z to A) alphabetical order, click the arrow down dark arrow down light icon next to A-Z order.

To hide components without assigned hosts or hosts that do not contain components, switch on the Hide empty toggle.

To save changes in allocating components among hosts, click Save. To revert changes, click Reset.

To select the other way of allocating components among hosts, switch on the Hosts mode toggle.

Configuration

The Configuration tab on a cluster page is designed to configure the cluster after its creation.

This page includes the following tabs:

  • Primary configuration — allows you to configure the general cluster settings. For more information on configuration parameters, refer to the Configure a cluster article of the Get started guide, depending on the product in use.

  • Configuration groups — allows you to set up cluster configuration groups.

  • Ansible settings — allows you to set up Ansible configuration options at the cluster level. The tab is available starting with ADCM 2.2.0. The tab content controls are the same as for the Primary configuration tab. For detailed information on how to work with configuration parameters, see Configuration parameters in the ADCM UI.

  • Action host groups — enables you to set up host groups to run actions allowed for the cluster separately for each group of hosts.

The Primary configuration, Configuration groups, and Action host groups are completely identical to tabs of a service page described above.

Import

The Import tab on a cluster page allows you to import the following settings:

  • settings of other clusters or services from other clusters to the current cluster (the Cluster section);

  • settings of other clusters or services from other clusters to a service of the current cluster from the drop-down list (the Services section).

The Import tab of the ADS cluster page
The Import tab of the ADS cluster page

For an example of how to import settings of the monitoring cluster services to the ADS cluster, see Import/export of services.

To save import changes, click Save. The following message will be displayed: Imported objects have been updated.

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