Software requirements

Daria Barysheva

Overview

The software requirements for Arenadata DB installation are listed below:

  1. ADB supports the following operating systems:

  2. If you use ClickHouse or PostgreSQL as external storage systems for ADB Control/ADBM (see Metrics DB and Query DB in Arenadata DB Control overview), the required versions of these databases are:

    • ClickHouse 22.8 — 25.9

    • PostgreSQL 12.20

  3. ADB uses Docker as a containerization platform for some services (for example, ADB Control and ADBM) and Enterprise Tools. ADB supports Linux vendor-specific Docker engines. You can also use pre-installed Docker by setting the Use existing docker flag when configuring the ADB cluster.

    IMPORTANT

    Starting with ADB 6.27.1.56, ADB Control rewrites Docker settings in the /etc/docker/daemon.json file for security purposes. Thus, if you need to modify this file, set the Use existing docker option when configuring ADB. This option will also allow you to use Docker in the rootless mode.

  4. ADB needs Java 17 for some services (e.g. PXF, ADB Control, and ADBM). In all operating systems except Astra Linux, no additional Java installation is needed since Java comes with the main operating system repository. In Astra Linux, before ADB installation, you should install Java manually and fill in the Java path in the JAVA_HOME field when configuring the ADB cluster. This step is also necessary in other operating systems if you use Java 17 with a path different from the default one.

    The default Java paths for supported operating systems are listed below.

  • Ubuntu

  • RED OS

  • AltLinux

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

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

/usr/lib/jvm/jre-17

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 starting with ADB 6.27.1.58.

  1. The minimal ADCM version is 2.6.0.

  2. If you use ADBM, its minimal version for ADB 7 is 2.8.0.

  3. If you use ADB Control, its minimal version for ADB 7 is 4.15.0.

  4. ADB requires the en_US.UTF-8 operating system locale on all cluster hosts. Yet you do not need to select this locale as default. This locale is present by default in all supported operating systems except Astra Linux. In the case of Astra Linux, the locale is automatically added during ADB installation. To view available locales, run the following command:

    $ localectl list-locales

  5. It is recommended to switch off any antivirus software before ADB installation and during the ADB operation process. In case of using antivirus, please contact your antivirus software vendor to find out the settings necessary to allow ADB.

  6. Only Latin characters and digits are allowed for ADB database objects. These characters are treated as reserved: ", &, ',   (space), (, ), ;, <, >, \, `, |. If such characters are present, Arenadata DB Backup Manager will not be able to back up/restore a database.

  7. During ADB installation, a bundle assigns the necessary permissions to the specific files and directories it creates, regardless of the umask value on cluster hosts.

  8. During ADB installation, the following changes are made at the operating system level. Do not change any of the objects listed below.

    • The following system files are modified:

      • /etc/hosts (optionally)

      • /etc/hostname (optionally)

      • /etc/chrony.conf (if you install Chrony)

      • /etc/ssh/sshd_config (always)

      • /etc/security/limits.conf (always)

    • A service file for configuring cgroup v2 for ADB is created at /etc/systemd/system/cgroup_v2_gpdb.service;

    • New files are created in the /sys/fs/cgroup directory.

  9. The installation process creates a new file in the /var/spool/cron/ folder for the ADB system user (by default, gpadmin). All technical accounts should be able to change that file as well (via crontab -e -u gpadmin). ADB adds cron jobs to run the cluster maintenance scripts — their schedule and arguments should be modified using the corresponding section in the ADB configuration parameters.

  10. For online installation of ADB, all cluster hosts should have access to Arenadata repositories specified on the Configuration tab in the ADB cluster menu available via ADCM UI (see Arenadata repo url and Monitoring repo url fields). For offline installation, provide access to the host where the Enterprise Tools cluster is installed.

  11. For both online and offline installation, all cluster hosts should have access to the repositories that are listed below (or local mirrors should be created):

Requirements for Astra Linux and Ubuntu

  1. ADB, like other analytical DBMS, is optimized to work with generic kernels. Using the lowlatency kernels may not provide optimal performance for tasks that are typical for analytical data processing. Due to this, for proper operation of ADB, it is recommended to use generic cores only.

  2. You should also consider version compatibility.

NOTE
ADB 6 was built upon cgroup v1. Starting with version 7, ADB uses cgroup v2 that is the default in all supported operating systems.

Operating system prerequisites

Below is the list of prerequisites for your operating system environment to ensure proper ADB operation. You can either prepare the environment manually on all ADB hosts, or select the corresponding configuration parameters in the ADB service to automatically apply the recommended settings during ADB installation.

Before installing ADB, run the Precheck cluster action, which includes verification of the host operating system parameters.

Requirement Name of ADB configuration parameter

The /etc/hosts file contains hostnames of all cluster hosts: coordinator host, standby coordinator host, and segment hosts. For example:

192.168.1.10 mdw.example.com
192.168.1.20 smdw.example.com
192.168.1.30 sdw1.example.com
192.168.1.40 sdw2.example.com

Alternatively, DNS can be used for hostname resolution

Edit /etc/hosts

Security Enhanced Linux (SELinux) is disabled

Disable linux security module (requires host reboot)

IPv6 is disabled

Disable IPv6

The value of the MaxStartups parameter of the OpenSSH Daemon (sshd) is 1000:30:1022

Set up MaxStartups for sshd

Transparent Huge Pages in the Linux kernel are disabled

Set up GRUB for DBMS (requires host reboot)

The following limits are set for the default database user in the /etc/security/limits.conf file:

  • The soft and hard limits for the number of open file descriptors are set to 524288.

  • The soft and hard limits for the number of processes are set to 150000.

Set up ulimits for DBMS user

The firewall is disabled on ADB hosts

Disable firewall

The recommended kernel parameters are as follows (use the sysctl -a command to view all kernel settings):

    kernel.core_pipe_limit = 0
    kernel.core_uses_pid = 1
    kernel.msgmax = 65536
    kernel.msgmnb = 65536
    kernel.msgmni = 2048
    kernel.sem = 250 2048000 200 8192
    kernel.shmmni = 4096
    kernel.sysrq = 1
    net.core.netdev_max_backlog = 10000
    net.core.rmem_max = 2097152
    net.core.wmem_max = 2097152
    net.ipv4.conf.all.arp_filter = 1
    net.ipv4.conf.default.accept_source_route = 0
    net.ipv4.ip_local_port_range = 12000 65535
    net.ipv4.ipfrag_high_thresh = 41943040
    net.ipv4.ipfrag_low_thresh = 31457280
    net.ipv4.ipfrag_time = 60
    net.ipv4.tcp_max_syn_backlog = 4096
    net.ipv4.tcp_syncookies = 1
    vm.dirty_background_bytes = 1610612736
    vm.dirty_background_ratio = 0
    vm.dirty_bytes = 4294967296
    vm.dirty_expire_centisecs = 500
    vm.dirty_ratio = 0
    vm.dirty_writeback_centisecs = 100
    vm.overcommit_memory = 2
    vm.overcommit_ratio = 95
    vm.swappiness = 10
    vm.zone_reclaim_mode = 0

Sysctl parameters
IMPORTANT

If you change the Disable linux security module and Set up GRUB for DBMS parameters, set the Reboot cluster servers after installation flag to true in the Install or Reinstall cluster action. Otherwise, these settings will not apply to the hosts. This may lead to situations where, during subsequent cluster actions (Expand, Move Host Segment, or Init Standby Master) with the Reboot new segment host after installation flag enabled, the system will reboot all hosts where these settings were not applied, not only the new ones. This can disrupt cluster operations.

If the Reboot cluster servers after installation flag was not set, it is recommended to stop the cluster and reboot the hosts manually to apply the specified settings.
Found a mistake? Seleсt text and press Ctrl+Enter to report it