Глобальные переменные

ate_instance_type

Тип экземпляра: тарантульный или один из нетарантульных типов экземпляра. Влияет на процесс установки и конфигурации. Тип: string. Значение по умолчанию: tarantool.

tarantool, tcm, tqe-grpc, tcs-scheduler, tcf-gateway, tcf-destination, cdc

Все роли

tarantool_user

Пользователь, от имени которого работают компоненты Tarantool. Тип: string. Значение по умолчанию: tarantool.

tarantool

Все роли (как владелец)

tarantool_group

Группа, от имени которой работают компоненты Tarantool. Тип: string. Значение по умолчанию: tarantool.

tarantool

Все роли (как владелец)

tarantool_base_dir

Базовый каталог установки Tarantool-приложений. Тип: string. Значение по умолчанию: /app/tarantool.

/app/tarantool

prepare, tarantool_config, systemd, tcf, tdb_worker, os_configure

tarantool_log_base_dir

Базовый каталог журналов. Тип: string. Значение по умолчанию: /app/logs.

/app/logs

prepare, tcf

tarantool_snap_base_dir

Базовый каталог снимков состояния. Тип: string. Значение по умолчанию: /app/snap.

/app/snap

prepare

tarantool_dir_mode

Права доступа на директории. Тип: string. Значение по умолчанию: 0750.

0750

Во всех ролях, создающих каталоги

tarantool_file_mode

Права доступа на неисполняемые файлы. Тип: string. Значение по умолчанию: 0644.

0644

Во всех ролях, создающих файлы конфигурации и неисполняемые файлы

tarantool_secret_file_mode

Права доступа на приватные ключи, токены, SSH-файлы. Тип: string. Значение по умолчанию: 0400.

0400

prepare, os_configure

tarantool_exec_file_mode

Права доступа на исполняемые скрипты. Тип: string. Значение по умолчанию: 0755.

0755

prepare (для установщика)

tarantool_umask

Umask при создании файлов и каталогов. Тип: string. Значение по умолчанию: 0027.

0027

prepare

tarantool_backups_dir_mode

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

0750

prepare

tarantool_installer_script_mode

Права доступа на скрипт-установщик. Наследуется из tarantool_exec_file_mode. Тип: string. Значение по умолчанию: "{{ tarantool_exec_file_mode | default('0755') }}".

0755

prepare

tarantool_systemd_userspace_dir

Каталог systemd-юнитов уровня пользователя. Тип: string. Значение по умолчанию: ~/.config/systemd/user.

~/.config/systemd/user

prepare, tcf, systemd, os_configure

tarantool_systemd_exec_cmd_prefix

Префикс команды запуска systemd-юнита. Тип: string. Значение по умолчанию: "" (пустая строка).

""

prepare, systemd

tarantool_systemd_dir

Каталог systemd-юнитов уровня системы. Тип: string. Значение по умолчанию: /etc/systemd/system.

/etc/systemd/system

prepare, systemd, os_configure

tarantool_tmpfiles_dir

Каталог конфигурации tmpfiles.d. Тип: string. Значение по умолчанию: /usr/lib/tmpfiles.d/.

/usr/lib/tmpfiles.d/

prepare, os_configure

tarantool_config_storage

Тип централизованного хранилища конфигурации кластера: etcd или tarantool. Тип: string. Значение по умолчанию: etcd.

etcd, tarantool

prepare, systemd, tdb_worker, cluster_ops, uninstall

tarantool_config_storage_endpoints

Список конечных точек централизованного хранилища конфигурации. Тип: list. Для etcd — список URL-строк (например, ["http://etcd:2379"]); для хранилища на базе Tarantool — список словарей (см. раздел «Настройка SSL-соединения с TbCS»). Значение по умолчанию: ["http://etcd:2379"] (пользователь задаёт список явно — готового адреса по умолчанию нет, так как у каждого пользователя собственное хранилище по собственному адресу).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops, tcs, cluster_manager

tarantool_config_storage_prefix

Префикс ключа в хранилище конфигурации, под которым хранится конфигурация кластера. Применяется в обоих режимах (etcd и Tarantool). Тип: string. Значение по умолчанию: "/tarantool/{{ tarantool_app_name }}". Обратите внимание: итоговая конфигурация будет храниться под ключом {{ tarantool_config_storage_prefix }}/config/{{ tarantool_config_storage_key }} (по умолчанию — .../config/all).

/tarantool/{{ tarantool_app_name }}

prepare, tarantool_config, cluster_ops

tarantool_config_storage_key

Ключ, по которому конфигурация кластера публикуется в централизованном хранилище конфигурации (etcd или TbCS): <prefix>/config/<key>. Соответствует аргументу key команды tt cluster publish. В ATE 1.x переменная называлась tarantool_config_key. Тип: string. Значение по умолчанию: all.

all

prepare, tarantool_config, tt

tarantool_etcd_validate_certs

Включает проверку SSL-сертификатов etcd. Применяется только в режиме etcd; в режиме хранилища на базе Tarantool TLS настраивается в словаре tarantool_config_storage_endpoints. Тип: boolean. Значение по умолчанию: false.

Нет

prepare, tarantool_config, tdb_worker, cluster_ops

tarantool_etcd_ssl_key_file

Путь к клиентскому SSL-ключу для соединения с etcd. Применяется только в режиме etcd; в режиме хранилища на базе Tarantool TLS настраивается в словаре tarantool_config_storage_endpoints. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops

tarantool_etcd_ssl_cert_file

Путь к клиентскому SSL-сертификату для соединения с etcd. Применяется только в режиме etcd. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops

tarantool_etcd_ssl_ca_file

Путь к доверенному CA-сертификату для соединения с etcd. Применяется только в режиме etcd. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops

tarantool_etcd_ssl_ca_path

Путь к каталогу доверенных CA-сертификатов для соединения с etcd. Применяется только в режиме etcd. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, systemd

tarantool_etcd_ssl_verify_host

Проверка имени хоста SSL-сертификата etcd. Применяется только в режиме etcd. Тип: boolean. Значение по умолчанию: false.

Нет

prepare, systemd, tdb_worker, cluster_ops

tarantool_etcd_ssl_verify_peer

Проверка peer-сертификата etcd. Применяется только в режиме etcd. Тип: boolean. Значение по умолчанию: false.

Нет

prepare, systemd, tdb_worker, cluster_ops

tarantool_etcd_username

Логин для подключения к etcd с включённой аутентификацией. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops, cluster_manager

tarantool_etcd_password

Пароль для подключения к etcd с включённой аутентификацией. Тип: string. Значение по умолчанию: "" (пустая строка).

Нет

prepare, tarantool_config, systemd, tdb_worker, cluster_ops, cluster_manager

tarantool_app_name

Имя приложения (имя кластера). При использовании генерации инвентаря, эта переменная заполняется автоматически из поля cluster_name. Тип: string. Значение по умолчанию: null (обязательная переменная).

Нет

prepare, все роли

tarantool_app_directory

Корневой каталог приложения. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}".

/app/tarantool/{{ tarantool_app_name }}

prepare

tarantool_app_install_dir

Каталог дистрибутива приложения. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}/dist".

/app/tarantool/{{ tarantool_app_name }}/dist

prepare, tcs

tarantool_app_instances_dir

Каталог исполняемых файлов экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}/bin".

/app/tarantool/{{ tarantool_app_name }}/bin

prepare, systemd, tarantool_config

tarantool_run_dir

Каталог run-файлов экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}/run".

/app/tarantool/{{ tarantool_app_name }}/run

prepare, tarantool_config, logrotate

tarantool_data_dir

Каталог данных экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}/workdir".

/app/tarantool/{{ tarantool_app_name }}/workdir

prepare, tarantool_config

tarantool_conf_dir

Каталог конфигурационных файлов экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}/etc/conf.d".

/app/tarantool/{{ tarantool_app_name }}/etc/conf.d

prepare, systemd, tarantool_config, tqe

tarantool_log_dir_parent

Родительский каталог журналов экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_log_base_dir }}/{{ tarantool_app_name }}".

/app/logs/{{ tarantool_app_name }}

prepare, tarantool_config

tarantool_memtx_dir_parent

Родительский каталог memtx-снимков состояния экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_snap_base_dir }}/{{ tarantool_app_name }}".

/app/snap/{{ tarantool_app_name }}

prepare, tarantool_config

tarantool_vinyl_dir_parent

Родительский каталог vinyl-файлов экземпляров. Тип: string. Значение по умолчанию: null (по умолчанию совпадает с tarantool_data_dir).

Нет

prepare, tarantool_config

tarantool_wal_dir_parent

Родительский каталог WAL-файлов экземпляров. Тип: string. Значение по умолчанию: "{{ tarantool_data_dir }}".

{{ tarantool_data_dir }}

prepare, tarantool_config

tarantool_config_filepath

Путь к итоговому файлу конфигурации Tarantool. Тип: string. Значение по умолчанию: "{{ tarantool_base_dir }}/{{ tarantool_app_name }}_config.yaml".

/app/tarantool/{{ tarantool_app_name }}_config.yaml

prepare, tarantool_config, systemd

tarantool_package_path

Локальный путь к архиву пакета приложения для установки. Тип: string. Значение по умолчанию: null.

Нет

prepare, tcs, tdb_worker

tarantool_app_user

Пользователь приложения. Тип: string. Значение по умолчанию: tarantool.

tarantool

prepare, common, os_configure, tqe, tcs, cluster_ops

tarantool_app_group

Группа приложения. Тип: string. Значение по умолчанию: tarantool.

tarantool

prepare, common, os_configure, tqe, tcs, cluster_ops

tarantool_keep_num_latest_dists

Количество последних dist-дистрибутивов приложения, сохраняемых на диске. Тип: integer. Значение по умолчанию: 10.

10

prepare, common, tcf

tarantool_multiversion

Включает мультиверсионное хранение дистрибутивов приложения. Тип: boolean. Значение по умолчанию: true.

true

prepare, common

tarantool_not_save_cookie_in_app_config

Не сохранять cookie в конфигурации приложения. Тип: boolean. Значение по умолчанию: false.

false

prepare

tarantool_enable_tarantool_repo

Включает подключение репозитория Tarantool. Тип: boolean. Значение по умолчанию: true.

true

prepare, common

tarantool_remote_backups_dir

Директория для хранения резервных копий на удалённом сервере. Тип: string. Значение по умолчанию: /opt/tarantool/backups.

/opt/tarantool/backups

prepare, crontab, cluster_ops

tarantool_fetch_backups

Включает скачивание резервной копии на локальную машину. Тип: boolean. Значение по умолчанию: false.

false

prepare, cluster_ops

tarantool_fetch_backups_dir

Локальная директория для скачиваемых резервных копий. Тип: string. Значение по умолчанию: backups/.

backups/

prepare, cluster_ops

tarantool_restore_backup_path

Путь к архиву резервной копии на удалённом сервере для восстановления. Тип: string. Значение по умолчанию: null.

Нет

prepare, cluster_ops

tarantool_restore_backup_path_local

Локальный путь к архиву резервной копии для восстановления. Тип: string. Значение по умолчанию: null.

Нет

prepare, cluster_ops

tarantool_force_restore

Принудительное восстановление поверх существующих данных. Тип: boolean. Значение по умолчанию: false.

false

prepare, cluster_ops

tarantool_allow_alien_backup

Разрешает восстановление из резервной копии, созданной на другом кластере. Тип: boolean. Значение по умолчанию: false.

false

prepare, cluster_ops

tarantool_skip_cleanup_on_restore

Пропускает очистку перед восстановлением. Тип: boolean. Значение по умолчанию: false.

false

prepare, cluster_ops

tarantool_paths_to_keep_before_restore

Список путей, сохраняемых перед восстановлением. Тип: list. Значение по умолчанию: [].

[]

prepare, cluster_ops

tarantool_backup_wait_snapshot_timeout

Таймаут ожидания снимка состояния при резервном копировании, секунды. Тип: integer. Значение по умолчанию: 1000.

1000

prepare, cluster_ops

tarantool_backup_wait_snapshot_delay

Задержка между попытками ожидания снимка состояния, секунды. Тип: integer. Значение по умолчанию: 5.

5

prepare, cluster_ops

tarantool_etcd_additional_prefixes

Список дополнительных префиксов в etcd, данные по которым включаются в резервную копию и восстанавливаются вместе с основной конфигурацией кластера. При использовании TCF с etcd-хранилищем префиксы tcf_gateway_storage_prefix и tcf_destination_storage_prefix добавляются автоматически. Тип: list. Значение по умолчанию: [].

[]

prepare, cluster_ops

tarantool_backup_cleanup_time

Время запуска задачи очистки старых резервных копий в cron. Возможные значения: hourly, daily, weekly, monthly, yearly, reboot. Тип: string. Значение по умолчанию: не задано (в роли crontab по умолчанию weekly).

weekly

crontab

tarantool_backup_retention_days

Срок хранения резервных копий в днях (очистка по времени). Тип: integer. Значение по умолчанию: не задано (пользовательский ввод). Должна быть задана ровно одна из tarantool_backup_retention_days/tarantool_backup_retention_count (см. плейбук backup_clean). Если указаны обе, плейбук упадёт с ошибкой.

Нет

crontab, playbooks: backup_clean

tarantool_backup_retention_count

Количество сохраняемых резервных копий (очистка по счёту). Тип: integer. Значение по умолчанию: не задано (пользовательский ввод). Должна быть задана ровно одна из tarantool_backup_retention_days/tarantool_backup_retention_count (см. плейбук backup_clean).

Нет

crontab, playbooks: backup_clean

tarantool_coordinator

Признак того, что текущий экземпляр является координатором кластера. Генератор инвентаря выставляет tarantool_coordinator: true на экземплярах компонента coordinator (по его объявлению в инвентаре, без ручной установки); в статическом инвентаре задаётся на хосте вручную. Тип: boolean. Значение по умолчанию: false.

false

prepare, os_configure, cluster_ops, common, logrotate

tarantool_grpc

Признак того, что на экземпляре включён gRPC-интерфейс. Генератор инвентаря выставляет tarantool_grpc: true на экземплярах gRPC-компонента TQE (по его объявлению в инвентаре, без ручной установки); в статическом инвентаре задаётся на хосте вручную. Тип: boolean. Значение по умолчанию: false.

false

prepare, os_configure, cluster_ops, tqe, common

is_config_storage

Признак того, что текущий хост является узлом централизованного хранилища конфигурации. Задаётся на хосте в инвентаре. Тип: boolean. Значение по умолчанию: false.

false

prepare, systemd, tarantool_config, cluster_ops

stateboard

Признак того, что экземпляр работает в режиме stateboard. Задаётся на экземпляре в инвентаре. Тип: boolean. Значение по умолчанию: false.

false

prepare, cluster_ops

expelled

Признак исключения хоста из топологии (при true хост исключается). Задаётся на хосте в инвентаре. Тип: boolean. Значение по умолчанию: null.

null

prepare, common, cluster_ops

disabled

Признак отключения хоста (при true хост считается отключённым, но не исключённым). Задаётся на хосте в инвентаре. Тип: boolean. Значение по умолчанию: null.

null

prepare, common, cluster_ops

restarted

Признак необходимости перезапуска экземпляра (при true экземпляр перезапускается). Задаётся на экземпляре в инвентаре. Тип: boolean. Значение по умолчанию: null.

null

prepare, common

zone

Имя зоны для распределения экземпляров по зонам. Задаётся на экземпляре в инвентаре; используется генератором инвентаря. Тип: string. Значение по умолчанию: null.

null

prepare (генератор инвентаря)

tarantool_tt_connect_username

Имя пользователя для подключения к Tarantool при выполнении команд tt CLI. Тип: string. Значение по умолчанию: '' (пустая строка — подключение без аутентификации).

Нет

cluster_ops, prepare

tarantool_tt_connect_password

Пароль для подключения к Tarantool при выполнении команд tt CLI. Тип: string. Значение по умолчанию: '' (пустая строка).

Нет

cluster_ops, prepare

tarantool_tt_timeout

Время ожидания завершения операции tt vshard bootstrap, секунды. Тип: integer. Значение по умолчанию: 10.

10

cluster_ops, prepare

tarantool_tt_failover_status_timeout

Время ожидания выполнения команды failover switch, секунды. Тип: integer. Значение по умолчанию: 30.

30

cluster_ops, prepare

tarantool_tt_failover_status_retries

Количество повторных попыток запроса статуса выполнения команды failover switch. Тип: integer. Значение по умолчанию: 5.

5

cluster_ops, prepare

tarantool_tt_failover_status_delay

Задержка проверки статуса восстановления после отказа (команда failover status), секунды. Тип: integer. Значение по умолчанию: 1.

1

cluster_ops, prepare

tarantool_shared_become

Разрешить смену пользователя для выполнения задач повышенного уровня доступа (установка пакетов и т.д.). Для работоспособности коллекции необходимо оставить в true или в качестве tarantool_shared_become_user указать пользователя с уровнем доступа root. Тип: boolean. Значение по умолчанию: true.

true

prepare, все роли

tarantool_shared_become_user

Системный пользователь, под которым коллекция будет выполнять большинство задач. Тип: string. Значение по умолчанию: tarantool.

tarantool

prepare, все роли

tarantool_shared_become_method

Метод повышения привилегий системного пользователя для системных задач. Тип: string. Значение по умолчанию: sudo.

sudo

prepare, все роли

replicaset_alias

Имя (алиас) набора реплик, к которому относится экземпляр. Генератор инвентаря выставляет replicaset_alias равным имени набора реплик на каждый его экземпляр (без ручной установки); в статическом инвентаре задаётся вручную. Тип: string. Значение по умолчанию: null.

null

prepare, генератор инвентаря

tarantool_configure_logrotate

Включает настройку logrotate для журналов. Тип: boolean. Значение по умолчанию: true.

true

prepare, logrotate

tarantool_needs_bootstrap_vshard

Признак необходимости явной инициализации vshard (команда tt vshard bootstrap). Нужна кластерам TQE, у которых нет модуля app.vshard_bootstrapper. Если переменная не задана, инициализация включается автоматически, когда у роутера задана роль roles.tqe-router или app.roles.api; для остальных кластеров — false. Тип: boolean. Значение по умолчанию: не задано (определяется автоматически).

не задано

prepare, playbooks: install, tt_vshard_bootstrap

tarantool_wait_alive_retries

Число попыток ожидания готовности (alive) экземпляра. Тип: integer. Значение по умолчанию: 30.

30

prepare, cluster_ops

tarantool_wait_alive_delay

Задержка между попытками ожидания ready/alive, секунды. Тип: integer. Значение по умолчанию: 1.

1

prepare, cluster_ops

tarantool_allowed_statuses

Допустимые статусы экземпляра при ожидании готовности. Тип: list. Значение по умолчанию: ['ready'].

['ready']

prepare, cluster_ops

tarantool_migrations_directory

Путь на локальной машине к директории с миграциями, которые будут опубликованы и применены на удалённых хостах. Тип: string. Значение по умолчанию: null.

Нет

prepare, playbooks: tt_migrations

tarantool_iproto_ssl_params

Дополнительные настройки iproto.listen.params из документации Tarantool. Тип: dict. Значение по умолчанию: {}.

Нет

Только в инвентаре для генератора

tarantool_httpd_ssl_params

Параметры SSL для HTTP-подключений — секция roles.httpd.default конфигурации Tarantool. Тип: dict. Значение по умолчанию: {}.

Нет

Только в инвентаре для генератора

tarantool_extra_env

Дополнительные переменные окружения экземпляра. Тип: dict. Значение по умолчанию: null.

Нет

prepare

tarantool_runtime_params

Параметры времени выполнения экземпляра. Тип: dict. Значение по умолчанию: null.

Нет

prepare, cluster_ops

tarantool_replication_sync_check_enabled

Включает проверку синхронизации перед переключением в continuous_update.yml. На вызов из relocate_instances.yml не влияет — там проверка выполняется всегда. Тип: boolean. Значение по умолчанию: false.

tarantool_replication_sync_retries

Количество попыток проверки синхронизации репликации. Если синхронизация не достигнута за указанное число попыток, сценарий завершается с ошибкой, и плановая операция (переключение мастера или удаление старых экземпляров при переносе) не выполняется. Тип: integer. Значение по умолчанию: 120.

tarantool_replication_sync_delay

Задержка в секундах между попытками проверки синхронизации репликации. Тип: integer. Значение по умолчанию: 5.

tarantool_replication_sync_max_lag

Максимальный допустимый модуль лага репликации (box.info.replication[*].upstream.lag) в секундах. Тип: number. Значение по умолчанию: 1.