Configuration parameters

Anton Vasilev

This article describes parameters that can be configured for ADB ES services via ADCM.

NOTE
Some of the parameters become visible in the ADCM UI after the Show advanced flag being set.

AD Eureka

Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the AD Eureka component (in GB)

2

Log level

Logging level for the AD Eureka component. Possible values: TRACE, DEBUG, INFO, WARN, and ERROR

INFO

Registry app parameters

Read-only configuration of the AD Eureka component in YAML format. The content can be used as a reference if you need to modify AD Eureka properties (see below)

 — 

AD eureka server app environment key-value

This section lets you customize the behavior of the AD Eureka component using environment variables. Click Add property and enter the name of a variable and its value. Use the Registry app parameters read-only field to get the names of available variables

 — 

ADB Control

UI component parameters
Parameter Description Default value

ADB user name

ADB Control system user. A role with the same name is also created in ADB when you install the ADBC agents service in an ADB cluster.

The name can only be changed before the ADB Control service is installed

adcc

Service password

The password for the ADB Control system user

 — 

Listening port

A port on which ADB Control UI is available via HTTP

8890

Xmx ram parameter

A maximum Java heap size for the ADB Control UI component (in GB)

8

Log level

Logging level for the ADB Control UI component. Possible values: TRACE, DEBUG, INFO, WARN, and ERROR

INFO

UI server app parameters

Read-only configuration of the ADB Control UI component in YAML format. The content can be used as a reference if you need to modify ADB Control UI properties (see below)

 — 

UI server app environment key-value

This section lets you customize the behavior of the ADB Control UI component using environment variables. Click Add property and enter the name of a variable and its value. Use the UI server app parameters read-only field to get the names of available variables

 — 
UI LDAP authentication
Parameter Description Default value

UI LDAP authentication

Whether to use LDAP authentication

false

LDAP type

A type of the LDAP server. Possible values:

  • MSAD — Microsoft Active Directory;

  • FreeIPA — 389 Directory server as a part of FreeIPA.

MSAD

LDAP URI

A URI for connecting to the LDAP server. Requires the following format: <scheme>://<host>:<port>. For example, ldap://example.com:389, ldaps://example.com:636. If a port number is not specified, the standard ports are used: 389 for LDAP and 636 for LDAPS

 — 

Internal CA certificate in PEM format (optional)

The internal CA certificate or certificate chain in PEM format that signed the LDAP server certificate

 — 

Users baseDN

A limitation of the search scope of objects in the LDAP directory that is used in users search requests

 — 

Groups baseDN

A limitation of the search scope of objects in the LDAP directory that is used in groups search requests

 — 

Users OUs

A list of OUs for user search. If the option is set, users will be searched only in the specified OUs, otherwise — within full search scope specified in Users baseDN. Enter each OU value on a separate line using the ou=<name> format (e.g. ou=users1)

 — 

Groups OUs

A list of OU for group search. If the option is set, groups will be searched only in the specified OUs, otherwise — within full search scope specified in Groups baseDN. Enter each OU value on a separate line using the ou=<name> format (e.g. ou=groups1)

 — 

Group

A group name that is used for service requests to the LDAP server

 — 

Login

A user name that is used for service requests to the LDAP server

 — 

Password

A user password that is used for service requests to the LDAP server

 — 

Size limit

A maximum number of records that can be returned by the LDAP server

1000

Lowercase login

Whether to convert user names to lowercase

false
Backend parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the ADB Control Backend component (in GB)

8

Log level

Logging level for the ADB Control Backend component. Possible values: TRACE, DEBUG, INFO, WARN, and ERROR

INFO

Backend app parameters

Read-only configuration of the ADB Control Backend component in YAML format. The content can be used as a reference if you need to modify ADB Control Backend properties (see below)

 — 

Backend server app environment key-value

This section lets you customize the behavior of the ADB Control Backend component using environment variables. Click Add property and enter the name of a variable and its value. Use the Backend app parameters read-only field to get the names of available variables

 — 
Database migration parameters
Parameter Description Default value

Migration completion timeout

A timeout (in minutes) for an ADB Control migration to complete

5

Migration app parameter

Read-only configuration of the ADB Control Migration component in YAML format. The content can be used as a reference if you need to modify ADB Control Migration properties (see below)

 — 

Migration server app environment key-value

This section lets you customize the behavior of the ADB Control Migration component using environment variables. Click Add property and enter the name of a variable and its value. Use the Migration app parameter read-only field to get the names of available variables

 — 
ADB Control scheduler param
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the ADB Control Scheduler component (in GB)

2

Log level

Logging level for the ADB Control Scheduler component. Possible values: TRACE, DEBUG, INFO, WARN, and ERROR

INFO

Scheduler server app parameters

Read-only configuration of the ADB Control Scheduler component in YAML format. The content can be used as a reference if you need to modify ADB Control Scheduler properties (see below)

 — 

Scheduler app environment key-value

This section lets you customize the behavior of the ADB Control Scheduler component using environment variables. Click Add property and enter the name of a variable and its value. Use the Scheduler server app parameters read-only field to get the names of available variables

 — 
ADCC agents environment reference file

 

This section shows configuration of the ADBC agents service. You can use it as a reference if you want to customize the ADBC agents service in an ADB cluster.

ADBM

Parameter Description

Password for adbm system-user

The password for the adbm user account, which is used in the service API for collecting information about storage and cluster modifications that is displayed on the Audit page
Backend parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the ADBM Backend component (in GB)

8

Log level

Logging level for the ADBM Backend component. Possible values: TRACE, DEBUG, INFO, WARN, and ERROR

INFO

Backend app parameters

Read-only configuration of the ADBM Backend component in YAML format. The content can be used as a reference if you need to modify ADBM Backend properties (see below)

 — 

ADBM server app environment key-value

This section lets you customize the behavior of the ADBM Backend component using environment variables. Click Add property and enter the name of a variable and its value. Use the Backend app parameters read-only field to get the names of available variables

 — 
Database migration parameters
Parameter Description Default value

Migration completion timeout

A timeout (in minutes) for an ADBM migration to complete

3

Xmx ram parameter

A maximum Java heap size for the ADBM Database migration component (in GB)

1

Migration app parameters

Read-only configuration of the ADBM Database migration component in YAML format. The content can be used as a reference if you need to modify ADBM Database migration properties (see below)

 — 

ADBM migration app environment key-value

This section lets you customize the behavior of the ADBM Database migration component using environment variables. Click Add property and enter the name of a variable and its value. Use the Migration app parameters read-only field to get the names of available variables

 — 
ADBM agents environment reference file

 

This section shows configuration of the ADBM agents service. You can use it as a reference if you want to customize the ADBM agents service in an ADB cluster.

ADBM CLI config parameters

 

This section shows configuration of ADBM CLI.

Clickhouse

Parameter Description Default value

Database type

Choose the DBMS type:

  • Internal Clickhouse database parameters — to use an internal Arenadata QuickMarts (ADQM) instance from the bundle.

  • External Clickhouse parameters — to connect to an existing external ClickHouse instance.

Internal Clickhouse database parameters

The available parameters depend on the database type that you select.

Internal Clickhouse database parameters

Parameter Description Default value

Data dir

Directory for ClickHouse data storage

/var/lib/clickhouse/

Username

Database username for ClickHouse

default

Password

Database password for ClickHouse

 — 

External Clickhouse parameters

Parameter Description Default value

Clickhouse address and port [ip_address:port]

An external ClickHouse database address.

You can use a clustered ClickHouse installation as an external database for ADB Control as well as a standalone node. To do this:

  1. Create a logical cluster called adcc_cluster in ClickHouse.

  2. In the Clickhouse address and port [ip_address:port] section, click Add property.

  3. In the dialog that opens, enter an IP address in the Enter field name field and a port number in the Enter field value field.

  4. Click Apply to save changes.

  5. Repeat the previous steps for each ClickHouse node.

 — 

Database name

Database name in the external ClickHouse instance

adcc

Username

Username for the external ClickHouse database

default

Password

Password for the external ClickHouse database user

 — 

Database

Parameter Description Default value

Database type

Choose the DBMS type:

  • Internal postgres database parameters — to use an internal Arenadata Postgres (ADPG) instance from the bundle.

  • External postgres parameters — to connect to an existing external PostgreSQL instance.

Internal postgres database parameters

The available parameters depend on the database type that you select in Database type.

Internal Postgres database parameters

Parameter Description Default value

Postgres user password

Password for the postgres system user

 — 

Data directory

Directory used to store PostgreSQL data on hosts. Can only be changed before the Database service is installed

/pg_data1

External postgres parameters

Parameter Description Default value

Server ip

IP address of the external PostgreSQL database server

 — 

External database port

Port of the external PostgreSQL database

5432

Database name prefix

Prefix for database names.

The following two databases should exist in the external PostgreSQL instance: <prefix>_adcc and <prefix>_adbm, for example adcc_adcc and adcc_adbm

adcc

Username

Username for the external PostgreSQL database

postgres

Password

Password for the external PostgreSQL database user

 — 

Monitoring

Prometheus settings

 

Group Parameter Description Default value

 — 

scrape_interval

Target scrape frequency

1m

 — 

scrape_timeout

Scrape request timeout

10s

 — 

Password for Grafana connection

Password of a Grafana user (admprom_grafana) to connect to Prometheus

 — 

 — 

Prometheus users to login/logout to Prometheus

User credentials for logging into the Prometheus web interface

 — 

Service parameters

config.file

Path to the Prometheus server configuration file

/etc/admprom/prometheus/prometheus.yml

web.config.file

Path to the web configuration file. The file is written in YAML format

/etc/admprom/prometheus/prometheus-auth.yml

storage.tsdb.path

Path to the Prometheus server database

/var/lib/admprom/prometheus

web.listen-address

Address to access the Prometheus web interface

0.0.0.0:11200

web.console.libraries

Path to console management libraries

/usr/share/admprom/prometheus/console_libraries

web.console.templates

Path to Prometheus server console templates

/usr/share/admprom/prometheus/consoles

storage.tsdb.retention.time

Specifies how long to retain samples in the storage. Supported units: y, w, d, h, m, s, ms

15d
Grafana settings

 

Parameter Description Default value

Grafana administrator’s password

Password for the admin user to access the Grafana web interface

 — 

Grafana listen port

Port to access the Grafana web interface

11210
Node Exporter settings

 

Parameter Description Default value

Listen port

Port to access ADB ES host system metrics in the Prometheus format

11203

Metrics endpoint

Endpoint to access ADB ES host system metrics in the Prometheus format

/metrics
SSL configuration
Parameter Description Default value

[Prometheus] → Enable SSL

Enables SSL encryption of incoming traffic for the Prometheus Server component

Disabled

[Prometheus] → Certificate file

Path to the server SSL certificate file for the Prometheus Server component

/etc/admprom/prometheus/server.crt

[Prometheus] → Private key file

Path to the file with the private key of the server SSL certificate for the Prometheus Server component

/etc/admprom/prometheus/server.key

[Prometheus] → Certificate authority file

Path to the file with the CA certificate to verify Prometheus targets

/etc/admprom/prometheus/ca.crt

[Grafana] → Enable SSL

Enables SSL encryption of incoming traffic for the Grafana component

Disabled

[Grafana] → Certificate file

Path to the server SSL certificate file for the Grafana component

/etc/admprom/grafana/server.crt

[Grafana] → Private key file

Path to the file with the private key of the server SSL certificate for the Grafana component

/etc/admprom/grafana/server.key

[Grafana] → Certificate authority file

Path to the file with the CA certificate to verify the Prometheus certificate

/etc/admprom/grafana/ca.crt

[Node-exporter] → Enable SSL

Enables SSL encryption of incoming traffic for the Node Exporter component

Disabled

[Node-exporter] → Certificate file

Path to the server SSL certificate file for the Node Exporter component

/etc/ssl/server.crt

[Node-exporter] → Private key file

Path to the file with the private key of the server SSL certificate for the Node Exporter component

/etc/ssl/server.key
Process exporter settings
Parameter Description Default value

Listen port

Port to access Process Exporter metrics in the Prometheus format

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