Переменные TCM
В этом разделе приведены переменные окружения для роли cluster_manager.
Роль определяет настройки веб-интерфейса Tarantool Cluster Manager (TCM).
Переменная | Описание |
|---|---|
| Пользователь, от имени которого запускается TCM. Тип: |
| Группа, от имени которой запускается TCM. Тип: |
| Базовый каталог установки TCM. Тип: |
| Каталог дистрибутива TCM. Тип: |
| Каталог исполняемых файлов TCM. Тип: |
| Путь к исполняемому файлу |
| Каталог конфигурационных файлов TCM. Тип: |
| Имя файла конфигурации TCM. Тип: |
| Путь к файлу конфигурации TCM. Тип: |
| Имя systemd-юнита сервиса TCM. Тип: |
| Права доступа на директории TCM. Наследуется из глобальной переменной |
| Права доступа на файлы TCM. Наследуется из глобальной переменной |
Переменная | Описание |
|---|---|
| Режим работы TCM. Тип: |
| Провайдер хранилища состояния TCM. Тип: |
| Лимит скорости установки соединений к управляемому кластеру (соединений в секунду). Тип: |
| Таймаут соединения с Tarantool-кластером. Тип: |
| Таймаут ping-запросов к экземплярам Tarantool-кластера. Тип: |
| Команда утилиты |
| Период опроса состояния управляемого кластера. Тип: |
| Таймаут запроса состояния управляемого кластера. Тип: |
| Период обнаружения топологии управляемого кластера. Тип: |
| Имя индекса, используемого для шардирования данных управляемого кластера. Тип: |
| Допустимое рассогласование (смещение) времени между узлами управляемого кластера. Тип: |
| Порог фрагментации памяти экземпляров управляемого кластера (в процентах). Тип: |
| Таймаут проверки связности с экземплярами управляемого кластера. Тип: |
| Начальная задержка перед повторной попыткой подключения к экземпляру управляемого кластера. Тип: |
| Максимальная задержка перед повторной попыткой подключения к экземпляру управляемого кластера. Тип: |
| Порог количества неудачных попыток подключения к экземпляру управляемого кластера. Тип: |
| Период проверки соединений в пуле подключений к управляемому кластеру. Тип: |
| Задержка между повторными попытками подписки на изменения состояния управляемого кластера. Тип: |
| Ограничение на объём собираемой статистики спейсов управляемого кластера. Тип: |
| Таймаут запроса статистики у экземпляров управляемого кластера. Тип: |
TCM использует два независимых подключения к etcd, которые настраиваются разными группами переменных:
-
TCM → собственный etcd — хранение состояния TCM (пользователи, роли, регистрации кластеров). Настраивается переменными
tcm_config_storage_*,tcm_etcd_*иtcm_etcd_tls_*в секцииtcm:инвентаря для генератора. -
TCM → etcd кластера (через
initial_clusters) — чтение конфигурации управляемого кластера. Настраивается переменнымиtarantool_etcd_ssl_*(общие переменные Tarantool, также используются экземплярами) иtcm_cluster_etcd_tls_*в секцииconstants:.
Переменные ниже относятся к подключению TCM к собственному etcd.
Переменная | Описание |
|---|---|
| Список конечных точек хранилища состояния TCM (etcd или хранилище на основе Tarantool). При |
| Префикс ключа, под которым TCM хранит собственное состояние. Тип: |
| Имя пользователя для аутентификации в собственном etcd TCM. Тип: |
| Пароль для аутентификации в собственном etcd TCM. Тип: |
| Путь к файлу с паролем для аутентификации в собственном etcd TCM. Тип: |
Переменная | Описание |
|---|---|
| Включение TLS для соединения TCM с собственным etcd. Тип: |
| Автоматическое получение параметров TLS для соединения с собственным etcd. Тип: |
| Путь к SSL-сертификату клиента для соединения с собственным etcd. Тип: |
| Путь к SSL-ключу клиента для соединения с собственным etcd. Тип: |
| Путь к CA-сертификату для проверки сертификатов собственного etcd. Тип: |
| Требование проверки SSL-сертификата клиента (mutual TLS) при соединении с собственным etcd. Тип: |
| Путь к списку отзыва сертификатов (CRL) для собственного etcd. Тип: |
| Пропуск проверки SSL-сертификата сервера собственного etcd. Тип: |
| Пропуск проверки SAN в SSL-сертификате сервера собственного etcd. Тип: |
| Имя сервера (SNI) для TLS-соединения с собственным etcd. Тип: |
| Список допустимых наборов шифров (cipher suites) для TLS-соединения с собственным etcd. Тип: |
| Разрешённое значение Common Name сертификата клиента для собственного etcd. Тип: |
| Разрешённое имя хоста для TLS-соединения с собственным etcd. Тип: |
| Допущение пустого значения Common Name в сертификате клиента собственного etcd. Тип: |
Переменная | Описание |
|---|---|
| Транспорт для соединения TCM с Tarantool ( |
| Путь к SSL-сертификату клиента для соединения с Tarantool. Тип: |
| Путь к SSL-ключу клиента для соединения с Tarantool. Тип: |
| Путь к CA-сертификату для проверки сертификатов Tarantool. Тип: |
| Список наборов шифров OpenSSL для TLS-соединения с Tarantool. Тип: |
| Пароль приватного ключа клиента для соединения с Tarantool. Тип: |
| Путь к файлу с паролем приватного ключа клиента для соединения с Tarantool. Тип: |
Переменная | Описание |
|---|---|
| Адрес, на котором TCM слушает HTTP-запросы. Тип: |
| Порт HTTP-сервера TCM. Тип: |
| Сетевой протокол HTTP-сервера TCM. Тип: |
| Включение трассировки HTTP-запросов. Тип: |
Переменная | Описание |
|---|---|
| Включение TLS для HTTP-сервера TCM. Тип: |
| Путь к SSL-сертификату HTTP-сервера TCM. Тип: |
| Путь к SSL-ключу HTTP-сервера TCM. Тип: |
| Имя сервера (SNI) для HTTPS-сервера TCM. Тип: |
| Минимальная допустимая версия TLS для HTTP-сервера ( |
| Максимальная допустимая версия TLS для HTTP-сервера ( |
| Список предпочтительных эллиптических кривых для HTTP TLS. Тип: |
| Список допустимых наборов шифров (cipher suites) для HTTP TLS. Тип: |
Переменная | Описание |
|---|---|
| Каталог для файлов журнала TCM. Тип: |
| Уровень детализации записей журнала. Тип: |
| Формат записей журнала. Тип: |
| Тип вывода записей журнала: |
| Отключение цветовой разметки записей журнала. Тип: |
| Максимальный размер файла журнала в байтах. Тип: |
| Максимальный срок хранения файлов журнала в днях ( |
| Максимальное количество резервных копий файлов журнала. Тип: |
| Сжатие (gzip) резервных копий файлов журнала. Тип: |
| Отображение трассировки стека в записях журнала. Тип: |
| Добавление источника (файла и строки) в записи журнала. Тип: |
| Группа ОС, от имени которой запускается TCM. Тип: |
| Адрес приёмника в формате |
| Уровень важности сообщения ( |
| Подсистема (например, |
| Метка (tag) сообщений, отправляемых в syslog. Тип: |
| Время ожидания при попытке отправки записей журнала в |
| Список дополнительных направлений вывода записей журнала (поле |
Переменная | Описание |
|---|---|
| Максимальное количество пользователей TCM. Тип: |
| Максимальное количество кластеров, регистрируемых в TCM. Тип: |
| Максимальное количество ролей TCM. Тип: |
| Максимальное количество вебхуков TCM. Тип: |
| Максимальное количество секретов пользователя. Тип: |
| Максимальное количество веб-сессий пользователя. Тип: |
| Максимальное количество пользователей, привязанных к кластеру. Тип: |
Переменная | Описание |
|---|---|
| Включение функциональности |
| Включение функциональности column-store. Тип: |
| Включение функциональности Tarantool Queue Engine (TQE). Тип: |
| Включение функциональности API-токенов аутентификации. Тип: |
| Включение функциональности |
| Включение функциональности репликаторов данных (TCF). Тип: |
Переменная | Описание |
|---|---|
| Включение модулей дополнений (addons) TCM. Тип: |
| Каталог модулей дополнений TCM. Тип: |
| Максимальный размер загружаемого файла дополнения в байтах. Тип: |
| Список каталогов разработки дополнений. Тип: |
Переменная | Описание |
|---|---|
| Список кластеров, регистрируемых в TCM при первом запуске. При использовании генератора инвентаря формируется автоматически из кластеров секции |
| Список ролей, которые будут созданы при первом запуске TCM. Каждая роль может содержать: |
| Список пользователей, которые будут созданы при первом запуске TCM. Каждый пользователь может содержать: |
| Список правил доступа (ACL) к spaces/functions, создаваемых при первом запуске TCM. Каждое правило может содержать: |
| Список правил Key ACL (доступ к отдельным ключам конфигурации кластера), создаваемых при первом запуске TCM. Каждое правило может содержать: |
| Список LDAP-провайдеров, создаваемых при первом запуске TCM. Каждый элемент может содержать: |
TLS-блок LDAP-провайдера (tls) содержит: enabled (bool), cert-file, key-file, insecure-skip-verify (bool), use-start-tls (bool), server-name (строка). При enabled: true TCM требует читаемую пару клиентского сертификата и ключа (cert-file/key-file). Отдельного параметра для CA-файла нет: для проверки сертификата сервера используется системное хранилище доверенных CA, если insecure-skip-verify: false. Параметр use-start-tls: true включает StartTLS вместо непосредственного LDAPS-подключения, server-name задаёт имя сервера для проверки сертификата.
Параметры основного журнала TCM (секция log.default конфигурации TCM).
Переменная | Описание |
|---|---|
| Уровень журналирования: |
| Формат записей журнала: |
| Тип вывода записей журнала: |
| Максимальный размер одного файла журнала до ротации. TCM интерпретирует значение в мегабайтах. Применяется при |
| Максимальный срок хранения файлов ротации в днях. Значение |
| Максимальное число хранимых файлов ротации. Значение |
| Сжимать (gzip) файлы журнала при ротации. Применяется при |
| Добавлять стек вызовов в записи журнала. Тип: |
| Добавлять в записи журнала источник (файл и строку кода). Тип: |
| Отключить цветной вывод журнала в |
| Протокол доставки ( |
| Адрес приёмника в формате |
| Подсистема syslog ( |
| Зарезервировано. Передаётся в конфигурацию TCM ( |
| Зарезервировано. Передаётся в конфигурацию TCM ( |
| Время ожидания при подключении к syslog-серверу. Применяется при |
| Дополнительные выводы журнала (секция |
Параметры HTTP-сервера TCM, который обслуживает веб-интерфейс и API (секция http конфигурации TCM).
Переменная | Описание |
|---|---|
| Адрес, на котором TCM принимает HTTP-подключения. Тип: |
| Порт, на котором TCM принимает HTTP-подключения. Тип: |
| Тип сети для прослушивания: |
| Включить трассировку HTTP-запросов в журнале. Тип: |
| Максимальный размер тела HTTP-запроса в байтах. Тип: |
| Таймаут чтения HTTP-запроса целиком. Тип: |
| Таймаут чтения заголовков HTTP-запроса. Тип: |
| Таймаут записи HTTP-ответа. Тип: |
| Таймаут keep-alive соединения в ожидании следующего запроса. Тип: |
| Отключить встроенный обработчик запросов |
| Максимальный размер заголовков запроса в байтах. Значение |
| Таймаут обработки API-запроса. Не действует на WebSocket-подключения. Тип: |
| Период обновления данных, отдаваемых API. Тип: |
| Путь к директории со статическими файлами веб-интерфейса. Пустое значение — используется встроенный веб-интерфейс TCM. Тип: |
| Максимальный размер раздаваемого статического файла в байтах. Тип: |
| Максимальная допустимая сложность GraphQL-запроса. Тип: |
Параметры TLS для HTTPS-подключений к веб-интерфейсу и API самого TCM (секция http.tls конфигурации TCM).
Переменная | Описание |
|---|---|
| Включить HTTPS для веб-интерфейса и API TCM. Тип: |
| Путь к серверному TLS-сертификату TCM. Обязателен при включённом HTTPS. Тип: |
| Путь к приватному ключу серверного сертификата TCM. Обязателен при включённом HTTPS. Тип: |
| Минимальная версия TLS: строка |
| Максимальная версия TLS. Формат аналогичен |
| Порядок предпочтения эллиптических кривых для TLS: список имён кривых Go (например, |
| Список разрешённых наборов шифров: имена констант Go |
Параметры WebSocket-подключений, которые веб-интерфейс использует для подписок API (секция http.websocket конфигурации TCM).
Переменная | Описание |
|---|---|
| Размер буфера чтения WebSocket-соединения в байтах. Тип: |
| Размер буфера записи WebSocket-соединения в байтах. Тип: |
| Интервал отправки keep-alive ping по WebSocket-соединению. Тип: |
| Таймаут WebSocket-handshake. Тип: |
| Таймаут инициализации WebSocket-подключения (ожидание инициирующего сообщения клиента). Тип: |
Параметры cookie веб-сессии TCM (секция http.websession-cookie конфигурации TCM).
Переменная | Описание |
|---|---|
| Имя cookie веб-сессии. Тип: |
| Атрибут |
| Атрибут |
| Время жизни веб-сессии. Тип: |
| Устанавливать атрибут |
| Устанавливать атрибут |
| Атрибут |
| Период очистки истёкших веб-сессий. Тип: |
Параметры CORS для API TCM (секция http.cors конфигурации TCM). Требуются, если к API TCM обращаются из браузера с другого источника (origin).
Переменная | Описание |
|---|---|
| Включить обработку CORS. Тип: |
| Список разрешённых источников. Пустой список при включённом CORS разрешает запросы с любых источников. Тип: |
| Список разрешённых HTTP-методов. Пустой список разрешает |
| Список разрешённых заголовков запроса. Пустой список разрешает |
| Список заголовков ответа, доступных браузеру. Тип: |
| Разрешить передачу учётных данных (cookie, заголовки авторизации) в CORS-запросах. Тип: |
| Включить отладочный журнал обработчика CORS. Тип: |
Эти переменные задаются в секции constants: инвентаря (не являются переменными роли по умолчанию) и используются генератором инвентаря при автоматическом формировании tcm_initial_clusters. Статического значения по умолчанию в роли нет.
Переменная | Описание |
|---|---|
| Отображаемое имя кластера в веб-интерфейсе TCM. Если не задано — используется |
| Идентификатор кластера в TCM (UUID). Если не задано — TCM генерирует его автоматически при создании кластера. Тип: |
| Пропуск проверки SSL-сертификата etcd кластера в подключении TCM → etcd кластера (через |
| Пропуск проверки SAN в SSL-сертификате etcd кластера в подключении TCM → etcd кластера (через |
| Имя пользователя, которым TCM подключается к экземплярам управляемого кластера (поле |
Переменные для настройки initial-settings.auditlog — журнала аудита
действий пользователей и security-событий в TCM.
Переменная | Описание |
|---|---|
| Включает ведение журнала аудита. Если |
| Дублировать события аудита в stdout. Тип: |
| Способ вывода событий аудита: |
| Путь к файлу журнала аудита (используется при |
| Максимальный размер файла журнала аудита в МБ до ротации. Тип: |
| Максимальное число хранимых резервных копий журнала аудита. Тип: |
| Максимальный срок хранения резервных копий журнала аудита в днях. Тип: |
| Сжимать (gzip) резервные копии журнала аудита при ротации. Тип: |
| Протокол доставки для |
| Адрес syslog-сервера в формате |
| Severity-уровень для вывода событий аудита в syslog. Тип: |
| Категория (facility) для вывода событий аудита в syslog. Тип: |
| Таймаут ответа syslog-сервера для журнала аудита. Тип: |
| Список типов событий для записи в журнал аудита (например, |
| Включает генерацию секции |
| Минимальная длина пароля (0–32). Тип: |
| Требовать заглавные буквы. Тип: |
| Требовать строчные буквы. Тип: |
| Требовать цифры. Тип: |
| Требовать специальные символы. Тип: |
| Число запоминаемых предыдущих паролей (0–10). Тип: |
| Срок действия пароля в днях (0–365). Тип: |
| Число дней после установки или смены пароля, по истечении которых TCM присваивает ещё не истёкшему паролю статус предупреждения. Порог отсчитывается от даты смены пароля. Значение |
| Максимальное число неверных попыток ввода пароля до блокировки (0–20). Тип: |
| Время блокировки пользователя после превышения лимита попыток, сек. Тип: |
| Требовать смену пароля bootstrap-администратора при первом входе. Работает как с автогенерированным паролем, так и с паролем, заданным через |
| Ключ шифрования паролей, которые TCM использует для доступа к Tarantool/etcd-кластерам. Должен быть длиной 16, 24 или 32 байта. Тип: |
| Путь к файлу с ключом шифрования паролей, которые TCM использует для доступа к Tarantool/etcd-кластерам (альтернатива |
| Максимальная длительность выполнения миграций в хранилище состояния TCM при запуске (поле |
| Создавать ли |