Переменные TCS

tcs_dir_mode

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

tcs_file_mode

Права доступа на конфигурационные файлы компонента Scheduler для TCS 0.х. Тип: string. Значение по умолчанию: "{{ tarantool_file_mode | default('0644') }}".

tcs_package_dir

Полный путь к архиву с пакетом установки компонента Scheduler для TCS 0.х. Тип: string. Значение по умолчанию: "{{ cartridge_app_install_dir }}/{{ cartridge_package_path | basename | split('.tar.gz') | first }}".

tcs_v1_support

Включить поддержку TCS 1.x. Установите значение true, если используете динамический инвентарь для установки TCS 1.x. Доступно с версии 1.12.0. Тип: boolean. Значение по умолчанию: false.

tcs_http_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/storage.http.credentials, если используется динамический инвентарь для установки TCS 1.x. Применяется для экземпляров хранилища (storage). Доступно с версии 1.12.0. Тип: object.

tcs_sql_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/storage.arrow_flight_sql.credentials, если используется динамический инвентарь для установки TCS 1.x. Применяется для экземпляров хранилища (storage). Доступно с версии 1.12.0. Тип: object.

tcs_http_enabled

Включить поддержку http-запросов для TCS. Доступно с версии 1.12.0. Тип: boolean. Значение по умолчанию: true.

tcs_listen_host

Адрес (хост или сетевой интерфейс), на котором компоненты TCS принимают подключения, если используется динамический инвентарь. Задаёт адрес прослушивания (listen) для секций arrow_flight_sql и http (TCS 1.x), параметров http_listen и http_listen_streaming агрегатора (TCS 0.x), параметра http_listen компонента Scheduler, адрес listen секции iproto, а также адрес прослушивания роли roles.metrics-export, если она включена. Адрес для объявления (advertise) при этом остаётся равным advertise_host. Если переменная не задана, используется значение advertise_host. Доступно с версии 1.22.0. Тип: string.

cartridge_app_user

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

cartridge_app_group

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

cartridge_app_install_dir

Путь к директории, в которой хранятся установленные версии (дистрибутивы) Cartridge-приложения. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/dist".

tcs_scheduler_bin_directory

Путь к директории, в которой хранятся ссылки (symlink) на распакованные файлы для каждого экземпляра Scheduler. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/bin".

tcs_scheduler_instance_directory

Путь к директории с файлами экземпляров Scheduler, запущенных на этом хосте. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_bin_directory }}/{{ cartridge_app_name }}.{{ inventory_hostname }}".

tcs_scheduler_binary_name

Путь к бинарному файлу компонента Scheduler относительно распакованного архива с поставкой TCS. Тип: string. Значение по умолчанию: "bin/scheduler".

tcs_scheduler_config_directory

Путь к директории с файлом конфигурации компонентов Scheduler, которые запущены на данном хосте. Тип: string. Значение по умолчанию: "/app/tarantool/{{ cartridge_app_name }}/etc/conf.d/scheduler".

tcs_scheduler_config_name

Путь к файлу конфигурации компонента Scheduler, который запущен на данном хосте. Тип: string. Значение по умолчанию: "scheduler-{{ inventory_hostname }}.yml".

tcs_scheduler_config_path

Полный путь к конфигурации компонента Scheduler (директория и имя файла). Тип: string. Значение по умолчанию: "{{ tcs_scheduler_config_directory }}/{{ tcs_scheduler_config_name }}".

tcs_scheduler_service_unit_name

Имя systemd-юнита, которое используется для создания systemd-сервиса Scheduler. Тип: string. Значение по умолчанию: "{{ cartridge_app_name }}-scheduler@{{ inventory_hostname }}.service".

tcs_scheduler_service_dir

Имя поддиректории для переопределения директив из systemd-юнита, указанного в переменной tcs_scheduler_service_unit_name. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_service_unit_name }}.d".

tcs_scheduler_service_env_file

Полный путь к файлу с переменными окружения для сервиса Scheduler. Тип: string. Значение по умолчанию: "{{ tcs_scheduler_service_dir }}/env.conf".

tcs_scheduler_metrics_enabled

Включить передачу метрик с компонента Scheduler. Доступно с версии 1.10.0. Тип: boolean. Значение по умолчанию: false.

tcs_scheduler_features_enabled

Включить использование дополнительных возможностей (параметра features) компонента Scheduler. Доступно с версии 1.10.0. Тип: boolean. Значение по умолчанию: false.

tcs_scheduler_features

Дополнительные возможности, которые должны быть активированы у компонента Scheduler. Поддерживается только для TCS 0.x настройки ["sharding_api"]. Доступно с версии 1.10.0. Тип: object. Значение по умолчанию: [].

tcs_extra_env

Словарь переменных окружения, которые будут добавлены в сервис компонента Scheduler. Тип: array. Значение по умолчанию: null.

tcs_additional_config

Дополнительные опции конфигурации, которые автоматически добавляются в конец сгенерированной YAML-конфигурации компонента Scheduler. Поддерживаются словарь или список (mapping/sequence), которые сериализуются в YAML. Доступно с версии 1.14.0. Тип: object.

tcs_scheduler_config_template

Путь к Jinja2-шаблону на контроллере, который полностью заменяет встроенный шаблон конфигурации компонента Scheduler. Если переменная задана, роль использует указанный файл вместо roles/tcs/templates/tcs-scheduler-config.yml.j2. Доступно с версии 1.14.0. Тип: string.

tcs_scheduler_etcd_endpoints

Список узлов централизованного хранилища конфигурации etcd. Тип: string. Значение по умолчанию: "{{ tarantool_config_etcd_endpoints | default(['http://' + tarantool_etcd_host + ':' + '2379']) }}".

tcs_scheduler_http_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/scheduler.http.credentials, если используется динамический инвентарь для установки TCS 1.x. В TCS 1.0 применяется для экземпляров хранилища (storage), а с версии TCS 1.1 — для экземпляров хранилища и Scheduler. Доступно с версии 1.12.0. Тип: object.

tcs_scheduler_sql_credentials

Имя пользователя (username) и пароль (password) для секции конфигурации roles_cfg.tcs_roles/scheduler.arrow_flight_sql.credentials, если используется динамический инвентарь для установки TCS 1.x. В TCS 1.0 применяется для экземпляров хранилища (storage), а с версии TCS 1.1 — для экземпляров хранилища и Scheduler. Доступно с версии 1.12.0. Тип: object.

tcs_storage_group_name

Название группы, в которую может входить несколько наборов реплик с экземплярами хранилища. Тип: string. Значение по умолчанию: "aggregators".

tcs_storage_replicaset_name

Название набора реплик с экземплярами хранилища. Тип: string.

tcs_tls_cert_file

Путь к существующему на целевой машине файлу с TLS-сертификатом для работы с TCS 1.1.0 и выше. Будет передан в секцию конфигурации tcs_roles/storage.tcs_cert_file для экземпляров хранилища и tcs_roles/scheduler.tls_cert_file для экземпляров Scheduler. Доступно с версии 1.15.0. Тип: string.

tcs_tls_key_file

Путь к существующему на целевой машине файлу с TLS-ключом для работы с TCS 1.1.0 и выше. Будет передан в секцию конфигурации tcs_roles/storage.tcs_key_file для экземпляров хранилища и tcs_roles/scheduler.tls_key_file для экземпляров Scheduler. Доступно с версии 1.15.0. Тип: string.

tcs_confirm_restore

Подтверждение запуска восстановления данных (restore). Если явно указать true, плейбук выполняется без дополнительных вопросов — подходит для CI/CD и автоматизации. Если не задано (или false), плейбук в интерактивном режиме предложит подтвердить операцию нажатием Enter перед продолжением; в неинтерактивном окружении (без TTY) это приведёт к зависанию — используйте явный true для таких сценариев. Тип: boolean. Значение по умолчанию: false.

tcs_backup_dir

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

tcs_data_hosts

Группа/паттерн хостов TCS для сохранения и восстановления данных Tarantool (без экземпляра типа coordinator, у которого нет собственных данных). Тип: string. Значение по умолчанию: tcs:!coordinator.

tcs_stop_start_hosts

Группа/паттерн хостов TCS для остановки/запуска кластера (включая экземпляр типа coordinator). Тип: string. Значение по умолчанию: tcs.

tcs_restore_backup_time

Идентификатор конкретного момента восстановления (подстрока, например часть временной метки в имени файла сохранения данных), позволяющий восстановить не последний, а конкретный снимок данных. Если не задана, используется последний найденный снимок. Тип: string. Значение по умолчанию: не задано (используется последний снимок).

tcs_etcd_hosts

Группа хостов, на которых развёрнут ETCD. Тип: string. Значение по умолчанию: etcd_hosts.

tcs_etcd_become_user

Пользователь ОС, от имени которого выполняются операции с ETCD (snapshot save/restore, управление systemd-сервисом). Тип: string. Значение по умолчанию: etcd.

tcs_etcd_advertise_host

Сетевой адрес/DNS-имя, по которому конкретный ETCD-узел доступен другим узлам кластера и клиентам (используется при построении peer- и client-URL). По умолчанию берётся из ansible_host, а если он не задан — из inventory_hostname. Переопределите эту переменную, если фактический адрес подключения отличается от значений в инвентаре (например, при NAT). Тип: string.

tcs_etcd_port

Порт, на котором ETCD принимает клиентские запросы. Тип: integer. Значение по умолчанию: 2379.

tcs_etcd_peer_port

Порт для внутренней коммуникации между узлами ETCD. Тип: integer. Значение по умолчанию: 2380.

tcs_etcd_data_dir

Директория с данными ETCD на ETCD-узлах. Тип: string. Значение по умолчанию: /app/etcd/data.

tcs_etcd_cluster_token

Уникальный токен, идентифицирующий кластер ETCD при восстановлении из снимка. Тип: string. Значение по умолчанию: tcs-etcd.

tcs_etcd_backup_dir

Директория на ETCD-узлах для временного хранения снимка ETCD сразу после его создания. Тип: string. Значение по умолчанию: /tmp/tcs_etcd_backup.

tcs_etcd_fetch_backups_dir

Директория на управляющем узле (машине, откуда запускается ansible-playbook), куда снимок ETCD скачивается с ETCD-узла после создания, и откуда затем раздаётся на все ETCD-узлы при восстановлении. Значение по умолчанию (/tmp/tcs_etcd_backup_fetched) подходит для быстрого/тестового использования. Для постоянного храненияснимков в производственном окружении рекомендуется переопределить на более надёжный путь (например, /opt/tarantool/backups/etcd), доступный для записи текущему пользователю. Тип: string.

tcs_config_etcd_ssl_ca_file

Путь к CA-сертификату для TLS-соединений с ETCD. Тип: string. Значение по умолчанию: /certs/ca-dir/rootCA.crt.