Configuration parameters
This article describes the parameters that can be configured for ADB services via ADCM. To read about the configuring process, refer to the relevant articles: Online installation, Offline installation.
|
NOTE
Some of the parameters become visible in the ADCM UI after the Show advanced flag being set.
|
ADB
| Parameter | Description | Default value |
|---|---|---|
Name of default database |
A name of the database created by default. Subsequently, this database is used to create most extensions via ADB service actions in ADCM |
adb |
Use segment mirroring |
Enables synchronous replication for primary data segments, i.e. adds mirror segments to the cluster. As a result, mirror segments provide higher availability for the stored data, but require twice more space. When the cluster has enough hosts, it uses spread mirroring policy, otherwise — group mirroring policy |
true |
ADB MADlib Extension |
Whether or not to install MADlib. MADlib is an open-source library for scalable in-database analytics that provides data-parallel implementations of mathematical, statistical, and machine-learning methods for structured and unstructured data. It provides a suite of SQL-based algorithms for machine learning, data mining, and statistics, that run at scale within a database engine with no need for transferring data between ADB and other tools |
false |
ADB PostGIS Extension |
Whether or not to install PostGIS. PostGIS is a spatial database extension for PostgreSQL that allows Geographic Information Systems (GIS) objects to be stored in the database. PostGIS includes support for GiST-based R-Tree spatial indexes and functions for analysis and processing of GIS objects |
false |
ADB Auto Core Dump Service |
Whether or not to install the Auto Core Dump service ( |
false |
Diskquota Extension |
Whether or not to install the |
false |
PL/Python3u Extension |
Whether or not to install the PL/Python3u extension |
false |
| Parameter | Description | Default value |
|---|---|---|
Number of segments per host |
A number of primary segments on each segment host. If the parameter is not set, then |
(<number of CPU cores>) / 2 |
Segment host data directories |
Directories that are used to store data on segment hosts. The Number of segments per host value should be a multiple of the number of directories. Directory names should be specified in the first column. In the second, optionally, it is possible to specify the devices that should be formatted and mounted in the corresponding directories on the segment hosts, e.g. |
/data1 |
Use nobarrier for segments |
Whether or not to use the |
false |
Masters host data directory |
Directories that are used to store data on master and standby master hosts |
/data1 |
Mount master storage device for data |
Whether or not to mount block storage devices to data directories on master and standby master hosts. If no block storage devices are listed in the Master server storage device field, then nothing to be done |
false |
Master server storage device |
Master storage devices, e.g. |
— |
Use nobarrier for master |
Whether or not to use the |
false |
Arenadata configs directory name |
A name of the folder that contains Arenadata configuration files. It is located in the system user home directory |
arenadata_configs |
Sysctl parameters |
Linux kernel parameters that are needed for ADB |
— |
System user GID |
A unique identifier of the group that the system user belongs to. A system user should be created with the same UID and GID across all cluster hosts in order to reduce problems with access to the common network storages, containing ADB backup files |
2042 |
System user name |
A system user name for ADB |
gpadmin |
System user UID |
A unique identifier of the system user. A system user should be created with the same UID and GID across all cluster hosts in order to reduce problems with access to the common network storages, containing ADB backup files |
2042 |
Disable firewall |
Whether or not to disable |
true |
Edit /etc/hosts |
Whether or not to edit the /etc/hosts file during ADB installation to provide short host names instead of FQDN for the correct ADB work |
true |
Amount of shared memory |
The amount of shared memory allocated for query metrics (in KB). The maximum size is |
5120 |
Maximum scan node’s instrumentations |
The maximum number of scan node’s instrumentations per query (in shmem). Restart ADB to apply changes |
300 |
| Parameter | Description | Default value |
|---|---|---|
Interconnect type |
An interconnect type that should be used. Possible values:
|
udpifc |
ic-proxy auto-discovery |
Whether to use automatic proxy list generation during ic-proxy interconnect configuration. A port shift is defined in the ic-proxy port delta field (by default, |
true |
ic-proxy port delta |
Defines an integer value that is used to increase/decrease the proxy port value relative to the port of the associated postmaster backend. Applies only in conjunction with ic-proxy auto-discovery set to Allowed values: Please do not use |
2000 |
Run ic-proxy check |
Whether to run an interconnect test |
false |
| Parameter | Description | Default value |
|---|---|---|
Cluster network |
A subnet that is used for cluster nodes interconnection. Requires the |
— |
| Parameter | Description | Default value |
|---|---|---|
ADB ident server |
Whether to install the Ident server |
false |
Default deny policy for ident server |
Whether to deny access by default for all users for which no explicit rules have been defined in the configuration file of the Ident server (/etc/oidentd.conf) |
true |
| Parameter | Description | Default value |
|---|---|---|
ADB GPperfmon Extension |
Whether to install the ADB |
true |
Authentication type |
An authentication type that should be defined in the pg_hba.conf file for the
To use the |
md5 |
| Parameter | Description | Default value |
|---|---|---|
Crontab maintenance scripts |
Crontab maintenance scripts of the ADB system user |
— |
Delete old maintenane script logs |
A number of days after which maintenance script logs should be deleted |
30 |
| Parameter | Description | Default value |
|---|---|---|
SSL |
Whether to use SSL certificates |
false |
SSL Ciphers |
SSL ciphers |
["HIGH","MEDIUM","+3DES","!aNULL"] |
Server certificate |
Server certificate contents in the CRT format (*.crt file) |
— |
Server private key: |
Server private key contents (*.key file) |
— |
Root certificate |
Root certificate (Certificate Authority, CA) contents in the CRT format (*.crt file) |
— |
Certificate revocation list |
Certificates revoked by certificate authorities |
— |
Custom ssl pg_hba section |
The custom part of the pg_hba.conf file (with SSL settings) |
— |
| Parameter | Description | Default value |
|---|---|---|
UI LDAP authentication |
Whether or not to use LDAP authentication |
false |
Type |
A type of the LDAP server. Possible values:
|
MSAD |
URI |
A URI for connecting to the LDAP server in the following format: |
— |
Users baseDN |
A limitation of the search scope of objects in the LDAP directory that is used in user search requests |
— |
Groups baseDN |
A limitation of the search scope of objects in the LDAP directory that is used in group search requests |
— |
Users filter |
An LDAP filter that is used to search users. Should be specified according to the RFC 2254 |
(&(|(objectClass=person)(objectClass=inetOrgPerson))(cn=*)) |
Groups filter |
An LDAP filter that is used to search groups. Should be specified according to the RFC 2254 |
(&(|(objectClass=group)(objectClass=groupofnames)(objectClass=groupOfUniqueNames))(cn=*)) |
SA 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 |
— |
Lowercase login |
Whether or not to convert user names to lowercase |
false |
Lowercase group |
Whether or not to convert group names to lowercase |
false |
Sync interval |
A |
0 * * * * |
| Parameter | Description | Default value |
|---|---|---|
Custom pg_hba section |
A custom part of the pg_hba.conf file |
— |
ADBC agents
| Parameter | Description |
|---|---|
Use dedicated network |
Whether to use a dedicated network for ADB Control agents.
If enabled, specify the network in the Dedicated network field.
The field requires the If you use SSL certificates with an IP address in the |
| Parameter | Description | Default value |
|---|---|---|
Xmx ram parameter |
A maximum Java heap size for the ADB Control agents component (in GB) |
2 |
Log level |
Logging level for the ADB Control agents component.
Possible values: |
INFO |
Servers list update timeout |
Time interval between requests for information about available ADB Control Backend servers (in ms) |
5000 |
Environment key-value |
This section lets you customize the behavior of the ADB Control agents component using environment variables. Click Add property and enter the name of a variable and its value. Use the ADCC agents environment reference file read-only field in the ADB ES cluster to get the names of available variables |
— |
ADBM agents
| Parameter | Description |
|---|---|
Use dedicated network |
Whether to use a dedicated network for ADBM agents.
If enabled, specify the network in the Dedicated network field.
The field requires the If you use SSL certificates with an IP address in the |
| Parameter | Description | Default value |
|---|---|---|
Xmx ram parameter |
A maximum Java heap size for the ADBM agents component (in GB) |
2 |
Log level |
Logging level for the ADBM agents component.
Possible values: |
INFO |
Environment key-value |
This section lets you customize the behavior of the ADBM agents component using environment variables. Click Add property and enter the name of a variable and its value. Use the ADBM agents environment reference file read-only field in the ADB ES cluster to get the names of available variables |
— |
Chrony
| Parameter | Description | Default value |
|---|---|---|
NTP servers |
Addresses of valid NTP servers. For example, |
— |
PXF
| Parameter | Description | Default value |
|---|---|---|
Use custom JAVA_HOME |
Whether or not to use a custom |
false |
JAVA_HOME |
A custom
For Astra Linux, the JAVA_HOME field is mandatory starting with ADB 6.27.1.58 |
— |
PXF_JVM_OPTS |
Sets |
-Xmx2g -Xms1g |
PXF log4j properties |
log4j properties for PXF |
— |
Use custom PXF_BASE |
Whether or not to use a custom |
false |
PXF_BASE |
A custom |
/var/lib/pxf |
Encryption |
Whether or not to use encryption |
false |
Keystore file |
An absolute path to the JKS keystore file. For example, /var/lib/pxf/conf/pxfkeystore.jks |
— |
Keystore password |
A JKS keystore password |
— |
Encryption key alias |
An encryption key alias. Do not enter a private key in this field |
— |
Monitoring
| Group | Parameter | Description | Default value |
|---|---|---|---|
— |
scrape_interval |
Specifies how frequently to scrape targets |
1m |
— |
scrape_timeout |
Specifies how long to wait until a scrape request times out |
10s |
— |
Password for grafana connection |
Password of a Grafana user ( |
— |
— |
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: |
15d |
| Parameter | Description | Default value |
|---|---|---|
Grafana administrator’s password |
Password for the |
— |
Grafana listen port |
Port to access the Grafana web interface |
11210 |
| Parameter | Description | Default value |
|---|---|---|
Listen port |
Port to access ADB host system metrics in the Prometheus format |
11203 |
Metrics endpoint |
Endpoint where the Node Exporter exposes system metrics in the Prometheus format |
/metrics |
| 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 |
[greengage] → Enable SSL |
Enables SSL encryption of incoming traffic for the Greengage Exporter component. If enabled, specify the path to the server SSL certificate file and the private key file and configure a keystore password |
Disabled |
| Parameter | Description | Default value |
|---|---|---|
Listen port |
Port to access Greengage Exporter metrics in the Prometheus format |
9080 |
Listen SSL port |
Port to access Greengage Exporter metrics in the Prometheus format via SSL |
9443 |
Metrics endpoint |
Endpoint where the Greengage Exporter exposes system metrics in the Prometheus format |
/metrics |
The Process exporter component and this section of configuration parameters are available only in the Enterprise edition of ADB.
| Parameter | Description | Default value |
|---|---|---|
Listen port |
Port to access Process Exporter metrics in the Prometheus format |
9256 |