Service actions

Elena Dvoryadkina

ADCM UI provides actions to manage ADQM services. These actions are available on the Services page. To open this page, click an ADQM cluster name on the Clusters page and switch to the Services tab.

ADQM cluster services in the ADCM interface

The Services page contains a table with the following columns:

Name — service name.
Version — service version.
State — the current state of the service (for example, created or installed).
Concerns. The icon indicates that the service components are configured correctly. If critical errors are detected in the service configuration (for example, mandatory components are not deployed on cluster hosts), the icon image is changed to — when you hover over it, a pop-up window appears showing an error description with a link that you can follow to perform the required configuration.
Actions. When you click the icon , the drop-down list offers actions to manage the service. A set of actions depends on the service type.

Actions available for all services:
- Install (if a service state is created) — installs a service.
- Start — starts a service.
- Stop — stops a service.
Service-specific actions:
ADQMDB
- Check — checks whether the settings of hosts, components, and related services match the requirements of the ADQMDB service, and whether the service itself works correctly.
- Add Server(s) — installs the Clickhouse Server component on more hosts.
  
  When you select this action, ADCM opens the Run an action dialog where you can add new hosts to install the Clickhouse Server component on them.
  
  Add the Clickhouse Server component to hosts
- Add JDBC Bridge — installs the Clickhouse JDBC Bridge component on more hosts.
  
  In the Run an action dialog that appears when you select the Add JDBC Bridge action, click Add hosts in the Clickhouse JDBC Bridge section to add hosts on which you want to install the component.
  
  Add the Clickhouse JDBC Bridge component to hosts
- Remove JDBC Bridge — removes the Clickhouse JDBC Bridge component from hosts.
  
  In the Run an action: Remove JDBC Bridge dialog, remove hosts on which the Clickhouse JDBC Bridge component should not be installed.
  
  Remove the Clickhouse JDBC Bridge component from hosts
- Enable auto core dump — enables an automatic core dump.
- Disable auto core dump — disables an automatic core dump.
- Reconfig and restart — updates the service configuration files according to settings specified on the service configuration page, and restarts the service.
  
  In the Run an action window that opens when you select the action, you can activate the Disable validation option to switch off the validation of the service configuration (in some cases the configuration can be considered incorrect — for example, if it deletes storage policies that are still in use).
  
  Disable the configuration validation
- Restart — stops and then starts the service.
Zookeeper
- Check — checks the health of the Zookeeper service.
- Expand — installs the Zookeeper Server component on more hosts.
  
  When you select this action, ADCM opens the Run an action dialog where you can add new hosts on which you want to install the Zookeeper Server component.
  
  Add the Zookeeper Server component to hosts
  
  After the Expand action is completed, run the Reconfig and restart action for the ADQMDB service to apply the changes.
- Shrink — removes the Zookeeper Server component from hosts.
  
  In the Run an action dialog that appears when you select the Shrink action, remove hosts on which the Zookeeper Server component should not be installed.
  
  Remove the Zookeeper Server component from hosts
  
  After the Shrink action is completed, run the Reconfig and restart action for the ADQMDB service to apply the changes.
- Restart — stops and then starts the service.
Clickhousekeeper
- Check — checks the health of the Clickhousekeeper service.
- Expand — installs the Clickhouse Keeper Server component on more hosts.
  
  When you select this action, ADCM opens the Run an action dialog where you can add new hosts on which you want to install the Clickhouse Keeper Server component.
  
  Add the Clickhouse Keeper Server component to hosts
  
  After the Expand action is completed, run the Reconfig and restart action for the ADQMDB service to apply the changes.
- Shrink — removes the Clickhouse Keeper Server component from hosts.
  
  In the Run an action dialog that appears when you select the Shrink action, remove hosts on which the Clickhouse Keeper Server component should not be installed.
  
  Remove the Clickhouse Keeper Server component from hosts
  
  After the Shrink action is completed, run the Reconfig and restart action for the ADQMDB service to apply the changes.
- Reconfig and restart — updates the service configuration and restarts the service.
- Restart — stops and then starts the service.
Monitoring
Check — checks the health of the Monitoring service.

Reconfigure and restart — applies configuration to the Monitoring service according to settings specified on the service configuration page, and restarts the service.

When you select this action, ADCM opens the Run an action dialog where you can specify whether to reconfigure other ADQM services taking into account the current settings of the Monitoring service and to restart those services.

Enable auto reconfiguration/restart of ADQM services

Reinstall — reinstalls the service.
Monitoring Clients
- Expand — installs the Monitoring Diamond component on more hosts.
  
  When you select this action, ADCM displays the Run an action dialog where you can add new hosts on which you want to install the Monitoring Diamond component.
  
  Add the Monitoring Diamond component to hosts
- Shrink — removes the Monitoring Diamond component from hosts.
  
  In the Run an action dialog that appears when you select the Shrink action, remove hosts on which the Monitoring Diamond component should not be installed.
  
  Remove the Monitoring Diamond component from hosts
- Reconfig and restart — updates the service configuration and restarts the service.
- Restart — stops and then starts the service.
Chproxy
Check — checks the health of the Chproxy service.

Add Server(s) — installs the Chproxy Proxy Server component on more hosts.

When you select this action, ADCM displays the Run an action dialog where you can add new hosts on which you want to install the Chproxy Proxy Server component.

Add the Chproxy Proxy Server component to hosts

Remove Server(s) — removes the Chproxy Proxy Server component from hosts.

In the Run an action dialog that appears when you select the Remove Server(s) action, remove hosts on which the Chproxy Proxy Server component should not be installed.

Remove the Chproxy Proxy Server component from hosts

Reconfig and restart — updates the service configuration according to settings specified on the service configuration page, and restarts the service.

Restart — stops and then starts the service.
When an action starts, ADCM displays its execution process and result on the Jobs page. On this page, you can also analyze errors if they occur.

The Actions column also displays separate icons for the following actions:
- — sets up the maintenance mode for a service. This functionality is currently not implemented in the ADQM bundle.
- — removes a service from the cluster.

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