Configure a cluster

Anton Vasilev
IMPORTANT
There is usually no need to change cluster configuration parameters. You can leave all parameters at the default values.

After creation a new cluster, you can configure it by performing the following steps:

  1. Select a cluster on the Clusters page. To do this, click a cluster name in the Name column.

    Select a cluster
    Select a cluster

  2. Open the Configuration tab on the cluster page. The Configuration tab includes the following sections: Primary configuration, Configuration groups, Ansible settings.

  3. Fill in all necessary parameters on the selected tab and click Save.

Primary configuration

The Configuration → Primary configuration tab allows you to configure the general cluster settings.

CAUTION

Fill the Use custom JAVA_HOME for cluster field at your own risk.

Available configuration parameters are listed below:

  • Paths to the repositories that are used during the installation process — depending on the cluster operating system (ALT Linux, Ubuntu, Astra Linux, or RED OS):

    • Set up Monitoring repo — use the repository that is described in the Monitoring repo url field.

    • Monitoring repo url — the repository that is required to install monitoring.

  • Vault configuration — a switcher that determines whether to use HashiCorp Vault to store secrets of ADB ES services. When the switcher is activated, the following parameters become available.

    Name Description Default

    Address of the Vault server

    The Vault server address (e.g. 192.168.1.120 or vault.domain.com)

     — 

    Port of the Vault server

    The Vault server port. Should be specified if the service is published on a port other than HTTPS (443)

    443

    Internal CA certificate in PEM format (optional)

    The internal CA certificate in PEM format that signed the Vault server’s certificate

     — 

    Vault namespace (optional)

    The Vault namespace

     — 

    Writer authentication method for the Vault server

    The authentication method that is used to connect to the Vault server with write access.

    Possible values:

    • token

    • approle

    approle

    Writer Vault token

    The application token that is used to connect to the Vault server with write access. Required only if the Writer authentication method for the Vault server parameter is set to token

     — 

    Writer Vault role ID

    The role identifier provided for applications to connect to the Vault server with write access. Required only if the Writer authentication method for the Vault server parameter is set to approle

     — 

    Writer Vault secret ID

    The secret identifier associated with the Writer Vault role ID role that is used by applications to connect to the Vault server with write access. Required only if the Writer authentication method for the Vault server parameter is set to approle

     — 

    Reader authentication method for the Vault server

    The authentication method that is used to connect to the Vault server with read access.

    Possible values:

    • token

    • approle

    approle

    Reader Vault token

    The application token that is used to connect to the Vault server with read access. Required only if the Reader authentication method for the Vault server parameter is set to token

     — 

    Reader Vault role ID

    The role identifier provided for applications to connect to the Vault server with read access. Required only if the Reader authentication method for the Vault server parameter is set to approle

     — 

    Reader Vault secret ID

    The secret identifier associated with the Reader Vault role ID role that is used by applications to connect to the Vault server with read access. Required only if the Reader authentication method for the Vault server parameter is set to approle

     — 

    Mount point for ADB ES cluster secrets

    A mount point that is accessible for read/write operations with the provided ADB ES cluster authentication parameters. Each service will store secrets on the Vault server at the following path: <Mount point for ADB ES cluster secrets>/adbes/<cluster_name>/service/<service_name>/<component>

     — 

    Login mount point

    A custom authentication mount point. If empty, equals to the authentication method selected in the Writer authentication method for the Vault server (write) or Reader authentication method for the Vault server (read) field

     — 
IMPORTANT

  • Before editing Vault integration parameters, ensure that Vault is installed and configured.

  • Each time you edit and save parameters in the Vault integration section, run the cluster action Reconfigure Vault integration.

  • Currently, Vault can be used to store authentication parameters of ADB Control and ADBM.

  • SSL configuration — this section is read-only: you can use it to check whether SSL is enabled and configured. To enable and configure SSL in the ADB ES cluster, use the Manage SSL cluster action, which is available after the cluster is installed.

  • Timeout to unlock package manager — parameters of this section are intended to set the timeout of the DNF software package manager unlocking wait. Displayed if the Advanced flag is enabled. In Ubuntu, after the host reboot, automatic update starts, which locks DNF.

    Name Description Default

    retries

    The maximum number of retries

    3

    delay

    The time delay between retries (in seconds)

    10

  • Use custom JAVA_HOME for cluster — a switcher that determines whether to use a custom Java path for ADB ES services that use Java (for example, AD Eureka, ADB Control, and ADBM). Displayed if the Advanced flag is enabled. When the switcher is activated, the JAVA_HOME field becomes available. Enter a valid Java path in that field. The selected location should contain a bin folder with a Java binary file, for example, /usr/lib/jvm/java-17-openjdk-amd64. Installation will fail if there is no Java at the specified path.

    If the JAVA_HOME value is empty, one of the following default paths is used (depending on the operating system).

  • Ubuntu

  • RHEL

  • AltLinux

  • RED OS

/usr/lib/jvm/java-17-openjdk-amd64

/usr/lib/jvm/jre-17-openjdk

/usr/lib/jvm/jre-17

/usr/lib/jvm/jre-17-openjdk

IMPORTANT

  • If you plan to use custom Java (such as Axiom), Java 17 is required for installation.

  • For Astra Linux, the JAVA_HOME field is mandatory.

  • Use dedicated network — a switcher that determines whether to use a dedicated network for interconnection of ADB ES components. Displayed if the Advanced flag is enabled. When the switcher is activated, the Dedicated network field becomes available. The field requires the <subnet>/<netmask> notation, for example 192.168.1.0/24. If this parameter is not set, then ADCM uses addresses with the default route. A host must have exactly one address in the range. Run the Reconfigure & Restart ADB Control action to apply changes.

    If you use SSL certificates with an IP address in the SAN section, the IP addresses of the ADB ES components can change in the dedicated network. In this case, you will need to issue a new certificate specifying the new IP address.

Cluster configuration window
Cluster configuration window

Configuration groups

The Configuration → Configuration groups tab is designed to set cluster configuration groups.

Ansible settings

The Configuration → Ansible settings tab allows you to set Ansible configuration options at the cluster level. The tab is available starting with ADCM 2.2.0.

Ansible settings
Name Description Default

forks

The number of parallel processes to spawn when communicating with remote hosts

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