Configuration parameters

Daria Barysheva

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

true

Type of mirroring

Defines the mirroring type: group or spread. The default value is auto, which selects the optimal type automatically based on the cluster configuration: if the number of segment hosts is greater than the number of primary segments per host (see Number of segments per host below), then the spread type is used. Otherwise, the group type is used

auto

ADB MADlib Extension

Defines whether 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

Defines whether 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

Defines whether to install the Auto Core Dump service (systemd-coredump) — a plugin that enables core dump files for ADB processes. This feature is useful for debugging purposes. If enabled, the system collects core dumps and saves them in the following directory: /var/lib/systemd/coredump/. When the maximum storage size is reached (1 GB), old files will be deleted

false

Diskquota Extension

Defines whether to install the diskquota extension, which allows Arenadata DB administrators to limit the amount of the disk space used by schemas or roles in the database

false
Advanced
NOTE
These parameters become visible after the Show advanced flag is set.
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 is used. When you customize a number of primary segments per host, remember that the more parallel SQL queries you plan to run simultaneously — the fewer segments per host you need

(<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

/data1

Masters host data directory

Directories that are used to store data on coordinator and standby coordinator hosts

/data1

Master server storage device

Coordinator storage devices, e.g. sdb (without the /dev prefix). Should be the same on all coordinator hosts (including coordinator and standby coordinator)

 — 

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

Applies the Linux kernel parameter values (using sysctl options) listed in the Sysctl parameters [key:value] block. Expand the block to view or modify the values of the applied parameters. To add a custom parameter, click Add property, enter the parameter name in the Enter field name and its value in the Enter field value field

false

Disable linux security module

Disable Security Enhanced Linux (SELinux). Modifying this parameter requires reboot of cluster hosts. If you modify the parameter prior to ADB installation, set the Reboot cluster servers after installation flag to true in the Install or Reinstall cluster action. Otherwise, reboot hosts manually

false

Disable IPv6

Disables IPv6 on all ADB hosts

false

Set up MaxStartups for sshd

Sets the MaxStartups parameter of the OpenSSH Daemon (sshd) to 1000:30:1022

false

Set up GRUB for DBMS

Disables Transparent Huge Pages in the Linux kernel by specifying transparent_hugepage=never in the GRUB configuration file. Modifying this parameter requires reboot of cluster hosts. If you modify the parameter prior to ADB installation, set the Reboot cluster servers after installation flag to true in the Install or Reinstall cluster action. Otherwise, reboot hosts manually

false

Set up ulimits for DBMS user

Adds the following resource limits to /etc/security/limits.conf:

gpadmin	soft	nofile	524288
gpadmin	hard	nofile	524288
gpadmin	soft	nproc	150000
gpadmin	hard	nproc	150000

The gpadmin user name here is the default name of the system user; it can be changed using the System user name parameter (see below)

false

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

Disable firewall

Disables firewalld on the cluster hosts

false

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

Edit /etc/hosts

Defines whether to edit the /etc/hosts file during ADB installation to include hostnames of the coordinator, standby coordinator, and segment hosts. With the default value of false, you must manually edit the file or configure a DNS server to ensure hostname resolution between all cluster hosts. If the value is set to true, make sure to also set the Reboot cluster servers after installation flag to true in the Install or Reinstall cluster action

false

Amount of shared memory

The amount of shared memory allocated for query metrics (in KB). The maximum size is 131072. Restart ADB to apply changes

5120

Maximum scan node’s instrumentations

The maximum number of scan node’s instrumentations per query (in shmem). Restart ADB to apply changes

300
Interconnect properties
NOTE
This section becomes visible after the Show advanced flag is set.
Parameter Description Default value

Interconnect type

An interconnect type that should be used. Possible values:

  • udpifc

  • tcp

  • proxy

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, 2000)

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 true.

Allowed values: [-60000, 0), (0, 60000].

Please do not use 0 as the parameter value, since it will cause the following error: Check that auto-discovery or proxy delta or gp_interconnect_proxy_addresses guc is not empty

2000

Run ic-proxy check

Whether to run an interconnect test

false
Use dedicated cluster network
Parameter Description Default value

Cluster network

A subnet that is used for cluster nodes interconnection. 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 Reinstall ADB to apply changes

 — 
ADB ident server
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
Crontab
Parameter Description Default value

Crontab maintenance scripts

Crontab maintenance scripts of the ADB system user gpadmin. For more information, see Work with arenadata_toolkit

 — 

Delete old maintenance script logs

A number of days after which maintenance script logs should be deleted

30
SSL
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)

 — 
UI LDAP authentication
Parameter Description Default value

UI LDAP authentication

Defines whether to use LDAP authentication

false

Type

A type of the LDAP server. Possible values:

  • MSAD — Microsoft Active Directory;

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

MSAD

LDAP Host

A domain name or an IPv4 address of the LDAP server

 — 

LDAP Port

A port number on the LDAP server to connect to

 — 

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

Defines whether to convert user names to lowercase

false

Lowercase group

Defines whether to convert group names to lowercase

false

Sync interval

A cron expression that defines how often synchronization of ADB users and groups with an LDAP server should be performed. The pg-ldap-sync utility, which comes with the ADB bundle, is used for synchronization

0 * * * *
Other
Parameter Description Default value

Custom pg_hba section

A custom part of the pg_hba.conf file

 — 

ADB Control

External ADB Control server parameters
Parameter Description Default value

External ADB Control server parameters

Defines whether to use an external ADB Control server

false

ADB Control IP-address

An external ADB Control IP address. The property becomes available after setting the External ADB Control server parameters flag

 — 

External ADB Control port

An external ADB Control port. The property becomes available after setting the External ADB Control server parameters flag

81
UI component parameters
Parameter Description Default value

ADB user name

A user name that is used by ADB Control for connecting to ADB. Such access is required to obtain information about the cluster topology and to cancel requests initiated by users

adcc

Service password

The service API user password for interaction between ADB Control and ADCM. It is recommended to change the default value

 — 

Servername

A server name for connecting to the ADB Control via HTTP

 — 

Listening port

A port on which ADB Control UI is available via HTTP

81

Xmx ram parameter

A maximum Java heap size for the UI component

8

Log level

A logs level that is used by the UI component. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
SSL
Parameter Description Default value

SSL

Defines whether to use SSL encryption in ADB Control

false

CA certificate

Server certificate authority (CA) file contents in the CRT format (*.crt file)

 — 

Server certificate

Server certificate contents in the CRT format (*.crt file)

 — 

Server private key

Server private key contents (*.key file)

 — 

Verify system endpoints' certificates

A flag that indicates whether to verify certificates of system endpoints.

When using the Verify system endpoints' certificates option in the ADB Control configuration with self-signed certificates, ensure that you added the root and intermediate CA certificates to the OS trusted root certificate stores.

In order to use the Verify system endpoints' certificates option with your own certificates, for proper verification, add the ADB Control IP address to the CN field of the san.cnf file (SAN) and exclude DNS from the alt_names section (leave only IP)

false

Server JKS keystore path

A path to the keystore file in the JKS format for the ADB Control server part. For example, /opt/adcc/ssl/keystore.jks

 — 

Server JKS keystore password

A password that is used for connecting to Server JKS keystore path

 — 

Server JKS truststore path

A path to the truststore file in the JKS format for the ADB Control server part. For example, /opt/adcc/ssl/truststore.jks

 — 

Server JKS truststore password

A password that is used for connecting to Server JKS truststore path

 — 

Client JKS keystore path

A path to the keystore file in the JKS format for the ADB Control client part (ADB Control/ADBM agents). For example, /opt/ssl/keystore.jks

 — 

Client JKS keystore password

A password that is used for connecting to Client JKS keystore path

 — 

Client JKS truststore path

A path to the truststore file in the JKS format for the ADB Control client part (ADB Control/ADBM agents). For example, /opt/ssl/truststore.jks

 — 

Client JKS truststore password

A password that is used for connecting to Client JKS truststore path

 — 
UI LDAP authentication
Parameter Description Default value

UI LDAP authentication

Defines 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: <schema>://<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 OU for user search. If the option is set, users will be searched only in the specified OUs, otherwise — within full 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 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

Defines whether to convert user names to lowercase

false
Backend parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the backend component

8

Log level

A logs level that is used by the backend component. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
Registry parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the registry component

2

Log level

A logs level that is used by the registry component. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
Database parameters
Parameter Description Default value

Database name

A name of the PostgreSQL database where ADB Control stores data (Query DB)

adcc

Username

A user name that is used for connecting to the PostgreSQL database

postgres

Password

A user password that is used for connecting to the PostgreSQL database

 — 

Listening port

A listening port for the PostgreSQL database

5433

Data dir

A full path to the directory where ADB Control stores PostgreSQL data. ADB Control uses the default Docker volume directory unless otherwise specified

 — 
CAUTION

The Data dir directory should be empty before database initialization during ADB Control installation.
External database parameters
Parameter Description Default value

External database parameters

Defines whether to use an external PostgreSQL database as Query DB for ADB Control

false

Server ip

An IP address of the server where the external PostgreSQL database is stored

 — 

External database port

A listening port of the server where the external PostgreSQL database is stored

5432

Database name

A name of the external PostgreSQL database

adcc

Username

A user name that is used for connecting to the external PostgreSQL database

postgres

Password

A user password that is used for connecting to the external PostgreSQL database

 — 
Database migration parameters
Parameter Description Default value

Migration completion timeout

A migration completion timeout (in minutes)

5
ADQM database parameters
Parameter Description Default value

Data dir

A full path to the directory where ADB Control stores ClickHouse data. ADB Control uses the default Docker volume directory unless otherwise specified

 — 

Database name

A name of the ClickHouse database that is used as Metrics DB in ADB Control

adcc

Username

A user name that is used for connecting to the ClickHouse database

default

Password

A user password that is used for connecting to the ClickHouse database

 — 
External ADQM parameters
Parameter Description Default value

External ADQM parameters

Defines whether to use an external ClickHouse database as Metrics DB for ADB Control

false

ADQM address and port [ip_address:port]

An address of the server where the external ClickHouse database is stored.

Starting with ADB Control 4.8.8, you can use clustered ClickHouse as an external database for ADB Control installation (in addition to a standalone node). To do this:

  1. Create a logical cluster called adcc_cluster in ClickHouse.

  2. On the ADB Control service configuration page in ADCM, expand a node with the parameter name ADQM address and port [ip_address:port].

  3. Click Add property.

  4. 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.

  5. Click Apply to save changes.

  6. Repeat the previous steps for each ClickHouse node.

 — 

Database name

A name of the external ClickHouse database

adcc

Username

A user name that is used for connecting to the external ClickHouse database

 — 

Password

A user password that is used for connecting to the external ClickHouse database

 — 
Agent parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for ADB Control agents

2

Log level

A logs level that is used by ADB Control agents. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO

Servers list update timeout

A timeout between refreshing information about available ADB Control Backend Servers instances (in ms)

5000
ADB Control scheduler param
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for ADB Control scheduler

2

Log level

A logs level that is used by ADB Control scheduler. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
Use dedicated network
NOTE
This section becomes visible after the Show advanced flag is set.
Parameter Description Default value

Dedicated network

A subnet that is used for ADB Control/ADBM interconnection. 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 the ADB Control IP address is used in the SAN certificate section, you should do the following before running the Reconfigure & Restart action when enabling or disabling a dedicated network for ADB Control/ADBM. In the HTTPS parameters enable section on the ADB Control configuration page in the ADCM UI, either reset the self-signed key and certificate (if they were automatically generated via a bundle) or set new key and certificate (if you added the current ones yourself)

 — 

ADBM

Parameter Description

Password for adbm system-user

The password for the adbm user account, which is used in service API for collecting information about storage and cluster modifications that is displayed on the Audit page. It is recommended to change the default value. The password must contain at least 12 characters
Backend parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the ADBM backend

8

Log level

A logs level that is used by the ADBM backend. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
Agent parameters
Parameter Description Default value

Xmx ram parameter

A maximum Java heap size for the ADBM agent

2

Log level

A logs level that is used by the ADBM agent. Possible values are TRACE, DEBUG, INFO, WARN, ERROR

INFO
External database parameters
Parameter Description Default value

External database parameters

Defines whether to use an external PostgreSQL database for ADBM

false

Server ip

An IP address of the server where the external database is stored

 — 

External database port

A listening port of the server where the external database is stored

5432

Database name

A name of the external database

adbm

Username

A user name that is used for connecting to the external database

postgres

Password

A user password that is used for connecting to the external database

 — 
Database migration parameters
Parameter Description Default value

Migration completion timeout

A migration completion timeout (in minutes)

3

Xmx ram parameter GB

The maximum memory pool allocated for a Java Virtual Machine (JVM) in GB

1

Chrony

Parameter Description Default value

NTP servers

Addresses of valid NTP servers. For example, 0.ru.pool.ntp.org, 1.ru.pool.ntp.org. If this parameter is set, then coordinator takes the time from NTP servers, standby coordinator — from coordinator or NTP servers, segment hosts — from coordinator or standby coordinator. If the parameter is not set or all NTP servers become unavailable, then coordinator uses its local clocks, standby coordinator uses the coordinator or local clocks, and segment hosts get the time from coordinator or standby coordinator

 — 

PXF

Parameter Description Default value

Use custom JAVA_HOME

Defines whether to use a custom JAVA_HOME path

false

JAVA_HOME

A custom JAVA_HOME path. Should lead to the JDK directory. The property becomes available after setting the Use custom JAVA_HOME flag. If empty, then the default system value is used:

  • /usr/lib/jvm/java-17-openjdk-amd64 (Ubuntu)

  • /usr/lib/jvm/jre-17-openjdk (RED OS)

  • /usr/lib/jvm/jre-17 (AltLinux)

For Astra Linux, the JAVA_HOME field is mandatory starting with ADB 6.27.1.58

 — 

PXF_JVM_OPTS

Sets PXF_JVM_OPTS

-Xmx2g -Xms1g

PXF_OOM_KILL

Defines whether the PXF service should automatically terminate when the PXF JVM detects an out-of-memory condition

false

PXF_OOM_DUMP_PATH

The absolute path to a file where you want the PXF service to write Java heap dumps when the PXF JVM detects an out-of-memory condition. If you specify a directory, the PXF JVM will write a new file to the directory every time it detects an out-of-memory condition. Leave empty to prevent the creation of heap dump files

 — 

PXF log4j properties

log4j properties for PXF

 — 

Use custom PXF_BASE

Defines whether to use a custom PXF_BASE path

false

PXF_BASE

A custom PXF_BASE path for PXF installation. The property becomes available after setting the Use custom PXF_BASE flag

/var/lib/pxf

Encryption

Defines whether 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

 — 
SSL
Parameter Description Default value

SSL

Defines whether to use SSL encryption in PXF

false

CA certificate

Server certificate authority (CA) file contents in the CRT format (*.crt file)

 — 

Server certificate

Server certificate contents in the CRT format (*.crt file)

 — 

Server private key

Server private key contents (*.key file)

 — 

Server JKS keystore password

A password that is used for connecting to Server JKS keystore path

 — 

Server JKS truststore password

A password that is used for connecting to Server JKS truststore path

 — 

Server JKS keystore path

A path to the keystore file in the JKS format for the PXF server part. For example, /var/lib/pxf/conf/ssl/keystore.jks

 — 

Server JKS truststore path

A path to the truststore file in the JKS format for the PXF server part. For example, /var/lib/pxf/conf/ssl/truststore.jks

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