Конфигурационные параметры

Антон Васильев

В этой статье описаны параметры, которые могут быть настроены для сервисов ADB ES через ADCM.

ПРИМЕЧАНИЕ
Некоторые из перечисленных параметров становятся доступны в UI ADCM после установки флага Show advanced.

AD Eureka

Параметр Описание Значение по умолчанию

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента AD Eureka, в гигабайтах

2

Log level

Уровень логирования, используемый компонентом AD Eureka. Возможные значения: TRACE, DEBUG, INFO, WARN, ERROR

INFO

Registry app parameters

Конфигурация компонента AD Eureka в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства AD Eureka (см. ниже)

 — 

AD eureka server app environment key-value

В этом разделе можно настроить поведение компонента AD Eureka с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Registry app parameters

 — 

ADB Control

UI component parameters
Параметр Описание Значение по умолчанию

ADB user name

Имя системного пользователя ADB Control. При установке сервиса ADBC agents в кластере ADB также создается роль с таким же именем.

Имя можно изменить только до установки сервиса ADB Control

adcc

Service password

Пароль системного пользователя ADB Control

 — 

Listening port

Порт, на котором UI ADB Control доступен по HTTP

8890

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента ADB Control UI, в гигабайтах

8

Log level

Уровень логирования, используемый компонентом ADB Control UI. Возможные значения: TRACE, DEBUG, INFO, WARN, ERROR

INFO

UI server app parameters

Конфигурация компонента ADB Control UI в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADB Control UI (см. ниже)

 — 

UI server app environment key-value

В этом разделе можно настроить поведение компонента ADB Control UI с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре UI server app parameters

 — 
UI LDAP authentication
Параметр Описание Значение по умолчанию

UI LDAP authentication

Необходимо ли использовать LDAP-аутентификацию

false

LDAP type

Тип LDAP-сервера. Возможные значения:

  • MSAD — Microsoft Active Directory;

  • FreeIPA — 389 Directory server в составе FreeIPA.

MSAD

LDAP URI

URI для подключения к LDAP-серверу в формате <схема>://<хост>:<порт>. Например, ldap://example.com:389 или ldaps://example.com:636. Если номер порта не указан, используются стандартные номера: 389 для LDAP и 636 для LDAPS

 — 

Internal CA certificate in PEM format (optional)

Внутренний сертификат центра сертификации (Certification Authority, CA) в формате PEM, используемый для подписи сертификата сервера LDAP

 — 

Users baseDN

Ограничение на область поиска объектов в каталоге LDAP, применяемое в запросах на поиск пользователей

 — 

Groups baseDN

Ограничение на область поиска объектов в каталоге LDAP, применяемое в запросах на поиск групп пользователей

 — 

Users OUs

Список OU для поиска пользователей. Если опция заполнена, поиск производится только в выбранных OU, иначе — относительно всего пути, указанного в Users baseDN. Каждое значение OU вводится в виде отдельной строки в формате ou=<name> (например, ou=users1)

 — 

Groups OUs

Список OU для поиска групп пользователей. Если опция заполнена, поиск производится только в выбранных OU относительно Groups baseDN, иначе — относительно всего пути, указанного в Groups baseDN. Каждое значение OU вводится в виде отдельной строки в формате ou=<name> (например, ou=groups1)

 — 

Group

Имя группы, используемое в сервисных запросах к LDAP-серверу

 — 

Login

Имя пользователя, используемое в сервисных запросах к LDAP-серверу

 — 

Password

Пароль пользователя, используемый в сервисных запросах к LDAP-серверу

 — 

Size limit

Максимальное количество записей, возвращаемое LDAP-сервером

1000

Lowercase login

Необходимо ли преобразование имен пользователей в нижний регистр

false
Backend parameters
Параметр Описание Значение по умолчанию

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента ADB Control Backend, в гигабайтах

8

Log level

Уровень логирования, используемый компонентом ADB Control Backend. Возможные значения: TRACE, DEBUG, INFO, WARN, ERROR

INFO

Backend app parameters

Конфигурация компонента ADB Control Backend в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADB Control Backend (см. ниже)

 — 

Backend server app environment key-value

В этом разделе можно настроить поведение компонента ADB Control Backend с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Backend app parameters

 — 
Database migration parameters
Параметр Описание Значение по умолчанию

Migration completion timeout

Период времени для завершения миграции ADB Control (в минутах)

5

Migration app parameter

Конфигурация компонента ADB Control Migration в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADB Control Migration (см. ниже)

 — 

Migration server app environment key-value

В этом разделе можно настроить поведение компонента ADB Control Migration с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Migration app parameter

 — 
ADB Control scheduler param
Параметр Описание Значение по умолчанию

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента ADB Control Scheduler, в гигабайтах

2

Log level

Уровень логирования, используемый компонентом ADB Control Scheduler. Возможные значения: TRACE, DEBUG, INFO, WARN, ERROR

INFO

Scheduler server app parameters

Конфигурация компонента ADB Control Scheduler в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADB Control Scheduler (см. ниже)

 — 

Scheduler app environment key-value

В этом разделе можно настроить поведение компонента ADB Control Scheduler с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Scheduler server app parameters

 — 
ADCC agents environment reference file

 

В этом разделе отображается конфигурация сервиса ADBC agents. Используйте ее как справочник при настройке сервиса ADBC agents в кластере ADB.

ADBM

Параметр Описание

Password for adbm system-user

Пароль пользователя adbm сервисного API, используемого для сбора информации об изменениях хранилищ и кластеров, отображаемой на странице Audit
Backend parameters
Параметр Описание Значение по умолчанию

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента ADBM Backend, в гигабайтах

8

Log level

Уровень логирования, используемый компонентом ADBM Backend. Возможные значения: TRACE, DEBUG, INFO, WARN, ERROR

INFO

Backend app parameters

Конфигурация компонента ADBM Backend в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADBM Backend (см. ниже)

 — 

ADBM server app environment key-value

В этом разделе можно настроить поведение компонента ADBM Backend с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Backend app parameters

 — 
Database migration parameters
Параметр Описание Значение по умолчанию

Migration completion timeout

Период времени для завершения миграции ADBM (в минутах)

3

Xmx ram parameter

Максимальный объем памяти (Java heap size), выделяемый для компонента ADBM Database migration, в гигабайтах

1

Migration app parameters

Конфигурация компонента ADBM Database migration в формате YAML (доступна только для чтения). Содержимое можно использовать в качестве справочника, если требуется изменить свойства ADBM Database migration (см. ниже)

 — 

ADBM migration app environment key-value

В этом разделе можно настроить поведение компонента ADBM Database migration с помощью переменных окружения. Нажмите Add property и введите название переменной и ее значение. Названия доступных переменных можно найти в параметре Migration app parameters

 — 
ADBM agents environment reference file

 

В этом разделе отображается конфигурация сервиса ADBM agents. Используйте ее как справочник при настройке сервиса ADBM agents в кластере ADB.

ADBM CLI config parameters

 

В этом разделе отображается конфигурация ADBM CLI.

Clickhouse

Параметр Описание Значение по умолчанию

Database type

Выберите тип используемого ClickHouse:

  • Internal Clickhouse database parameters — чтобы использовать встроенный Arenadata QuickMarts (ADQM), поставляемый с бандлом.

  • External Clickhouse parameters — чтобы настроить подключение к внешнему ClickHouse.

Internal Clickhouse database parameters

Доступные параметры ClickHouse зависят от значения, выбранного в поле Database type.

Internal Clickhouse database parameters

Параметр Описание Значение по умолчанию

Data dir

Директория для хранения данных ClickHouse

/var/lib/clickhouse/

Username

Имя пользователя базы данных ClickHouse

default

Password

Пароль пользователя базы данных ClickHouse

 — 

External Clickhouse parameters

Параметр Описание Значение по умолчанию

Clickhouse address and port [ip_address:port]

Адрес внешней БД ClickHouse.

Наряду с одиночной нодой возможно использовать кластеризованный ClickHouse в качестве внешней БД для ADB Control. Для добавления нескольких хостов кластера ClickHouse выполните шаги:

  1. Создайте логический кластер с именем adcc_cluster на стороне ClickHouse.

  2. В секции Clickhouse address and port [ip_address:port] нажмите Add property.

  3. В открывшемся диалоговом окне укажите IP-адрес хоста ClickHouse в поле Enter field name и порт для подключения в поле Enter field value.

  4. Нажмите Apply для применения изменений.

  5. Повторите предыдущие шаги для каждого хоста ClickHouse.

 — 

Database name

Имя базы данных во внешнем экземпляре ClickHouse

adcc

Username

Имя пользователя внешней базы данных ClickHouse

default

Password

Пароль пользователя внешней базы данных ClickHouse

 — 

Database

Параметр Описание Значение по умолчанию

Database type

Выберите тип используемого PostgreSQL:

  • Internal postgres database parameters — чтобы использовать встроенный экземпляр Arenadata Postgres (ADPG), поставляемый с бандлом.

  • External postgres parameters — чтобы настроить подключение к внешнему PostgreSQL.

Internal postgres database parameters

Доступные параметры PostgreSQL зависят от значения, выбранного в поле Database type.

Internal Postgres database parameters

Параметр Описание Значение по умолчанию

Postgres user password

Пароль системного пользователя postgres

 — 

Data directory

Директория для хранения данных PostgreSQL на хостах. Может быть изменена только до установки сервиса Database

/pg_data1

External postgres parameters

Параметр Описание Значение по умолчанию

Server ip

IP-адрес сервера внешней базы данных PostgreSQL

 — 

External database port

Порт внешней базы данных PostgreSQL

5432

Database name prefix

Префикс имен баз данных.

Во внешнем экземпляре PostgreSQL должны существовать две базы данных: <prefix>_adcc и <prefix>_adbm, например adcc_adcc и adcc_adbm

adcc

Username

Имя пользователя внешней базы данных PostgreSQL

postgres

Password

Пароль пользователя внешней базы данных PostgreSQL

 — 

Monitoring

Prometheus settings

 

Группа Параметр Описание Значение по умолчанию

 — 

scrape_interval

Интервал между операциями сбор метрик

1m

 — 

scrape_timeout

Время ожидания данных

10s

 — 

Password for grafana connection

Пароль пользователя Grafana (admprom_grafana) для подключения к Prometheus

 — 

 — 

Prometheus users to login/logout to Prometheus

Учетные данные пользователей для входа в веб-интерфейс Prometheus

 — 

Service parameters

config.file

Путь к конфигурационному файлу сервера Prometheus

/etc/admprom/prometheus/prometheus.yml

web.config.file

Путь к файлу веб-конфигурации. Файл записывается в YAML-формате

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

storage.tsdb.path

Путь к базе данных сервера Prometheus

/var/lib/admprom/prometheus

web.listen-address

Адрес для доступа к веб-интерфейсу Prometheus

0.0.0.0:11200

web.console.libraries

Путь к библиотекам управления консолями

/usr/share/admprom/prometheus/console_libraries

web.console.templates

Путь к шаблонам консолей сервера Prometheus

/usr/share/admprom/prometheus/consoles

storage.tsdb.retention.time

Время хранения данных. Поддерживаемые единицы: y, w, d, h, m, s, ms

15d
Grafana settings

 

Параметр Описание Значение по умолчанию

Grafana administrator’s password

Пароль пользователя admin для доступа к веб-интерфейсу Grafana

 — 

Grafana listen port

Порт доступа к web-интерфейсу Grafana

11210
Node Exporter settings

 

Параметр Описание Значение по умолчанию

Listen port

Порт доступа к системным метрикам хоста ADB ES в формате Prometheus

11203

Metrics endpoint

Эндпойнт доступа к системным метрикам хоста ADB ES в формате Prometheus

/metrics
SSL configuration
Параметр Описание Значение по умолчанию

[Prometheus] → Enable SSL

Включает SSL-шифрование входящего трафика для компонента Prometheus Server

Неактивен

[Prometheus] → Certificate file

Путь к файлу серверного SSL-сертификата для компонента Prometheus Server

/etc/admprom/prometheus/server.crt

[Prometheus] → Private key file

Путь к файлу закрытого ключа серверного SSL-сертификата для компонента Prometheus Server

/etc/admprom/prometheus/server.key

[Prometheus] → Certificate authority file

Путь к файлу корневого сертификата центра сертификации для проверки ресурсов (target), с которых поступают метрики для мониторинга в Prometheus

/etc/admprom/prometheus/ca.crt

[Grafana] → Enable SSL

Включает SSL-шифрование входящего трафика для компонента Grafana

Неактивен

[Grafana] → Certificate file

Путь к файлу серверного SSL-сертификата для компонента Grafana

/etc/admprom/grafana/server.crt

[Grafana] → Private key file

Путь к файлу закрытого ключа серверного SSL-сертификата для компонента Grafana

/etc/admprom/grafana/server.key

[Grafana] → Certificate authority file

Путь к файлу корневого сертификата центра сертификации для проверки сертификата Prometheus

/etc/admprom/grafana/ca.crt

[Node-exporter] → Enable SSL

Включает SSL-шифрование входящего трафика для компонента Node Exporter

Неактивен

[Node-exporter] → Certificate file

Путь к файлу серверного SSL-сертификата для компонента Node Exporter

/etc/ssl/server.crt

[Node-exporter] → Private key file

Путь к файлу закрытого ключа серверного SSL-сертификата для компонента Node Exporter

/etc/ssl/server.key
Process exporter settings
Параметр Описание Значение по умолчанию

Listen port

Порт доступа к метрикам Process Exporter в формате Prometheus

9256
Нашли ошибку? Выделите текст и нажмите Ctrl+Enter чтобы сообщить о ней