VK Docs logo
Помощь
Обновлена 11 сентября 2026 г. в 11:09

Переменные TCM

В этом разделе приведены переменные окружения для роли cluster_manager. Роль определяет настройки веб-интерфейса Tarantool Cluster Manager.

Управление правами доступа

Переменная

Описание

tcm_dir_mode

Права доступа на директории TCM. Тип: string. Значение по умолчанию: "{{ tarantool_dir_mode | default('0750') }}".

tcm_file_mode

Права доступа на файлы TCM. Тип: string. Значение по умолчанию: "{{ tarantool_file_mode | default('0644') }}".

Конфигурация TCM

Переменная

Описание

tcm_log_output

Тип вывода записей журнала: file -- запись в файл, syslog -- отправка на syslog-сервер. Тип: string. Значение по умолчанию: file.

tcm_log_syslog_protocol

Протокол доставки (tcp или udp). Тип: string. Значение по умолчанию: "tcp".

tcm_log_syslog_output

Адрес приёмника в формате host:port (например, 127.0.0.1:514). Тип: string.

tcm_log_syslog_priority

Уровень важности сообщения (info, warning, error и т.д.). Тип: string. Значение по умолчанию: "info".

tcm_log_syslog_facility

Подсистема (например, syslog, daemon, local0). Тип: string. Значение по умолчанию: "syslog".

tcm_log_syslog_timeout

Время ожидания при попытке отправки записей журнала в syslog. Тип: string. Значение по умолчанию: "20s".

tcm_initial_roles

Список ролей, которые будут созданы при первом запуске TCM. Каждая роль может содержать: id (строка, опционально), name (строка, обязательно), description (строка, опционально), permissions (список строк или список объектов с resource/actions). Если id не указан, TCM сгенерирует его автоматически при создании роли. Доступно с TCM 1.9.0. Тип: list. Значение по умолчанию: [].

tcm_initial_users

Список пользователей, которые будут созданы при первом запуске TCM. Каждый пользователь может содержать: fullname (строка, обязательно), description (строка, опционально), secret-type (строка: password или public-key, обязательно), secret-key (строка, обязательно) — пароль (если secret-type: password) или приватный ключ (если secret-type: public-key), public-key (строка, обязательно для всех типов secret-type) — публичный SSH-ключ, role-ids (список строк с идентификаторами ролей, опционально). Если role-ids не указаны, пользователь создается без дополнительных ролей. Доступно с TCM 1.9.0. Тип: list. Значение по умолчанию: [].

Подключение TCM к etcd

TCM использует два независимых подключения к etcd, которые настраиваются разными группами переменных:

  1. TCM → собственный etcd — хранение состояния TCM (пользователи, роли, регистрации кластеров). Настраивается переменными tcm_etcd_* и tcm_etcd_tls_* в секции tcm: динамического инвентаря.

  2. TCM → etcd кластера (через initial_clusters) — чтение конфигурации управляемого кластера. Настраивается переменными tarantool_config_etcd_ssl_* (общие переменные Tarantool, также используются экземплярами и ролью etcd) и tcm_cluster_etcd_tls_* в секции constants:.

Метаданные кластеров в TCM

Эти переменные задаются в секции constants: и используются при автоматической генерации tcm_initial_clusters.

Переменная

Описание

tcm_cluster_display_name

Отображаемое имя кластера в веб-интерфейсе TCM. Если не задано — используется cluster_name из инвентаря. Тип: string. Значение по умолчанию: cluster_name.

tcm_cluster_id

Идентификатор кластера в TCM (UUID). Если не задано — TCM генерирует его автоматически при создании кластера. Тип: string. Значение по умолчанию: не задано.

Аудит-логирование TCM (auditlog)

Переменные для настройки initial-settings.auditlog — аудит-логирования действий пользователей и security-событий в TCM.

IMPORTANT: Параметры initial-settings.* (включая auditlog) применяются только при первом старте TCM. Если TCM уже был запущен, изменение этих переменных через роль не окажет эффекта. Секция auditlog задаётся только через YAML-конфиг — аналога в переменных окружения или CLI у TCM нет.

Переменная

Описание

tcm_initial_settings_auditlog_enabled

Включает аудит-логирование. Если false — секция initial-settings.auditlog в конфиге не генерируется. Тип: bool. Значение по умолчанию: false.

tcm_initial_settings_auditlog_stdout

Дублировать события аудита в stdout. Тип: bool. Значение по умолчанию: false.

tcm_initial_settings_auditlog_protocol

Способ вывода событий аудита: file или syslog. Тип: string. Значение по умолчанию: "file".

tcm_initial_settings_auditlog_file_output

Путь к файлу аудит-лога (используется при protocol: file). По умолчанию указывает в ту же директорию, куда пишется основной лог TCM (tcm_log_directory), чтобы избежать ошибок доступа. Тип: string. Значение по умолчанию: "{{ tcm_log_directory }}/audit.log".

tcm_initial_settings_auditlog_file_max_size

Максимальный размер файла аудит-лога в МБ до ротации. Тип: int. Значение по умолчанию: 0.

tcm_initial_settings_auditlog_file_max_backups

Максимальное число хранимых бэкап-файлов аудит-лога. Тип: int. Значение по умолчанию: 0.

tcm_initial_settings_auditlog_file_max_age

Максимальный срок хранения бэкапов аудит-лога в днях. Тип: int. Значение по умолчанию: 0.

tcm_initial_settings_auditlog_file_compress

Сжимать (gzip) бэкапы аудит-лога при ротации. Тип: bool. Значение по умолчанию: false.

tcm_initial_settings_auditlog_syslog_protocol

Протокол доставки для protocol: syslog (udp или tcp). Тип: string. Значение по умолчанию: "udp".

tcm_initial_settings_auditlog_syslog_output

Адрес syslog-сервера в формате host:port (используется при protocol: syslog). Тип: string.

tcm_initial_settings_auditlog_syslog_priority

Severity-уровень для syslog-вывода аудит-событий. Тип: string.

tcm_initial_settings_auditlog_syslog_facility

Категория (facility) для syslog-вывода аудит-событий. Тип: string.

tcm_initial_settings_auditlog_syslog_timeout

Таймаут ответа syslog-сервера для аудит-лога. Тип: string. Значение по умолчанию: "2s".

tcm_initial_settings_auditlog_filters

Список типов событий для записи в аудит-лог (например, auth.fail, auth.ok, access.denied, user.add, role.update, cluster.config.save). Пустой список означает отсутствие фильтрации. Тип: list. Значение по умолчанию: [].

tcm_security_encryption_key

Ключ шифрования паролей, которые TCM использует для доступа к Tarantool/etcd-кластерам. Должен быть длиной 16, 24 или 32 байта. Тип: string. Значение по умолчанию: "".

tcm_default_cluster

Создавать ли Default cluster автоматически при первом старте TCM. Тип: bool. Значение по умолчанию: true.

ВАЖНО: Eсли tcm_security_encryption_key пустой (значение по умолчанию), а в tcm_initial_clusters заданы кластеры с паролями подключения (etcd или tarantool), то при запуске TCM появляется ошибка security encryption key must be non empty string. Ключ должен быть ровно 16, 24 или 32 байта