Configuration parameters in the ADCM UI

This article explains how to work with the object configuration parameters on the following tabs located on all main web interface pages:

  • Primary configuration — contains parameters with which you can configure the ADCM objects.

  • Ansible settings — contains settings used in creating the ansible.cfg file on every launch of an action on an object in a cluster.

  • Configuration group — contains configuration parameters of a config group.

Below is an example of how to fill out the Primary configuration tab for the ADB Control service. The presented option of filling in configuration parameters is correct for other objects.

The Primary configuration tab for the ADB Control service
The Primary configuration tab for the ADB Control service

The Primary configuration tab contains the following switches:

  • Show advanced — makes visible some of the fine-tuning configuration parameters.

  • Expand content — expands and collapses the configuration parameters tree.

After you fill in configuration parameters and save the configuration by clicking Save, a new configuration version appears including service information about configuration. If you have a previously saved configuration, you can view it and change configuration parameters by clicking on a tab with the appropriate name.

Manage configuration parameters

To reset unsaved configuration parameter changes, click Revert.

To search for a configuration parameter, enter its name in the Search input field.

To set the default value for a selected configuration parameter, click the reset dark reset light icon.

To delete one of multiple values added by selecting + 1, click the delete icon next to the desired value.

To clear a parameter value, i.e. set the value to null, click the clean dark clean light icon.

To activate or deactivate a section in the configuration tree, click the toggle dark off toggle light off or toggle dark on toggle light on icon respectively.

Parameter types

The ADCM web interface supports options for configuration parameter determination described below.

There are two types of drop-down lists: strict and non-strict. In case of strict drop-down lists, you have to select one option from the list of configuration parameter values. In case of non-strict drop-down lists, you can also specify a value that is not presented in the drop-down list.

The Log level dialog
The Log level dialog

Single line text field

This field is used to input strings of textual data (letters, numbers, and symbols) such as database name or username.

The Login dialog
The Login dialog

Sensitive data input field

This field is used to protect sensitive information due to regulatory and privacy requirements. After saving a value, it is available only in encrypted form.

The Service password dialog
The Service password dialog

To enable the display of entered parameter value, click the eye closed dark eye closed light icon.

Multi-line text input field

This field allows you to enter multi-line text.

The Scheduler logback parameters dialog
The Scheduler logback parameters dialog

To copy a multi-line text, hover over the working area and click Copy at the top-right of the working area.

Numeric input field

This field is used to enter only numeric values of configuration parameters (for example, listening port) by using keyboard or increment and decrease values using up and down arrows.

The Listening port dialog
The Listening port dialog

Arbitrary configuration parameter

The + Add property nested element is used to specify a configuration parameter with arbitrary key and value. Use this element in case of absence of the required configuration parameter among the parameters predefined in the ADCM web interface.

The dialog that appears by clicking Add property
The dialog that appears by clicking Add property

To add a new parameter, enter the parameter name in the Enter field name field and its value in the Enter field value field and click Apply to apply changes.

Array of composite objects or strings

The + 1 nested element allows you to add a new element to the list. The element can be either an element of the string type, such as an array of SSH keys, or a more complex composite object.

The Primary configuration tab for the Yandex Cloud hostprovider
The Primary configuration tab for the Yandex Cloud hostprovider

The field with the name which contains configuration parameter name and its sequence number in square brackets is displayed by clicking + 1.

Compare configurations

If there are several saved configurations, you can compare configuration parameters by clicking the three dots dark three dots light icon and selecting Compare. As a result, the Compare configurations window is displayed.

The Compare configurations window
The Compare configurations window

By default, a currently selected configuration is compared to a configuration on the tab where the Compare button was clicked. If necessary, select configurations for comparison from the drop-down lists in the Left Configuration and Right Configuration fields.

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