ATE Documentation portal logo
Помощь
Обновлена 30 октября 2026 г. в 12:05

Плейбуки продуктов

Плейбуки для управления компонентами Tarantool Enterprise: TCF, TCM, TCS, TQE и TDB Worker.

Установка компонентов выполняется универсальным плейбуком install.yml (см. раздел «Жизненный цикл»), за исключением TDB Worker — он устанавливается отдельным плейбуком tdb_worker/install.yml, описанным в этом же разделе. Здесь приведены плейбуки управления уже установленными компонентами: запуск, остановка, перезапуск, обновление, резервное копирование и восстановление.

Tarantool Clusters Federation

tcf/stop.yml

Плейбук для остановки TCF. На хостах группы destination останавливает systemd-юнит tcf_destination_systemd_unit, на хостах группы gateway — tcf_gateway_systemd_unit.

По умолчанию применяется к группе хостов tcf.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcf/stop.yml

tcf/restart.yml

Плейбук для перезапуска TCF. На хостах группы destination перезапускает systemd-юнит tcf_destination_systemd_unit, на хостах группы gateway — tcf_gateway_systemd_unit.

По умолчанию применяется к группе хостов tcf.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcf/restart.yml

tcf/update.yml

Плейбук для обновления TCF. Переустанавливает компонент (задачи установки роли tcf), затем отдельно перезапускает хосты групп destination и gateway.

По умолчанию применяется к группе хостов tcf.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcf/update.yml

Tarantool Cluster Manager

tcm/restart.yml

Плейбук для перезапуска TCM. Выполняет подготовку переменных и вызывает задачи перезапуска роли cluster_manager.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcm/restart.yml --limit ${LIMIT}

tcm_add_tbcs.yml

Плейбук для управления кластером Tarantool-based Config Storage (TbCS) в TCM как статическим кластером. Добавляет, обновляет и удаляет кластер TbCS в работающем TCM через универсальные операции cluster.add / cluster.update / cluster.delete с провайдером подключения static.

Требует TCM версии 1.11 или новее (версия проверяется через API). Статическая конфигурация берётся из переменной tcm_tbcs_static_config_content или из сгенерированной конфигурации кластера хранилища (tarantool_config_filepath на хосте с is_config_storage: true).

По умолчанию применяется к группе хостов cluster-manager; выполняется один раз.

Переменные

Переменная

Описание

tcm_tbcs_state

Целевое состояние кластера TbCS в TCM: present (добавить, если отсутствует), update (заменить конфигурацию и настройки подключения), absent (удалить, если присутствует). Значение по умолчанию: present.

tcm_tbcs_name

Имя кластера TbCS в TCM. Значение по умолчанию: TbCS.

tcm_tbcs_static_config_content

Содержимое статической конфигурации кластера TbCS. Если не задано, читается сгенерированная конфигурация кластера хранилища.

tcm_tbcs_config_file_path

Путь к файлу конфигурации кластера хранилища. Используется, если конфигурацию нельзя взять из фактов подготовленной роли prepare.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcm_add_tbcs.yml

Tarantool Column Store

tcs/restart.yml

Плейбук для перезапуска TCS. Выполняет подготовку переменных и вызывает задачи перезапуска роли tcs.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcs/restart.yml --limit ${LIMIT}

tcs/backup.yml

Плейбук для резервного копирования кластера TCS: создаёт резервные копии данных Tarantool (экземпляров группы tcs, кроме координатора) и снимок состояния кластера etcd.

Снимок состояния etcd создаётся командой etcdctl snapshot save на первом узле etcd, проверяется на целостность и забирается на управляющий узел Ansible.

Переменные

Основные переменные (полный список — в разделе «Переменные окружения», страница переменных TCS):

Переменная

Описание

tcs_backup_dir

Директория резервных копий данных Tarantool.

tcs_data_hosts

Группа хостов с данными Tarantool. Значение по умолчанию: tcs:!coordinator.

tcs_etcd_hosts

Группа хостов etcd. Значение по умолчанию: etcd_hosts.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcs/backup.yml

tcs/restore.yml

Плейбук для восстановления кластера TCS из резервных копий: данных Tarantool и кластера etcd.

Плейбук выполняет шаги в следующем порядке:

  1. Запрашивает интерактивное подтверждение (если не задана переменная tcs_confirm_restore: true).
  2. Останавливает кластер TCS и etcd на всех узлах.
  3. Выбирает снимок состояния etcd на управляющем узле и распределяет его по узлам etcd.
  4. Восстанавливает etcd из снимка состояния (утилитой etcdutl snapshot restore) и запускает etcd с проверкой здоровья.
  5. Восстанавливает данные Tarantool из резервных копий.
  6. Запускает кластер TCS и проверяет здоровье кластера etcd.

Переменные

Основные переменные (полный список — в разделе «Переменные окружения», страница переменных TCS):

Переменная

Описание

tcs_confirm_restore

Не запрашивать интерактивное подтверждение восстановления. Значение по умолчанию: false.

tcs_restore_backup_time

Время резервной копии для выбора снимка состояния etcd (формат YYYY-MM-DD-HHMMSS). Если не задано, используется самый свежий снимок.

tcs_backup_dir

Директория с резервными копиями данных Tarantool.

tcs_stop_start_hosts

Группа хостов кластера TCS для остановки и запуска. Значение по умолчанию: tcs.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tcs/restore.yml

Tarantool Queue Enterprise

Плейбуки управления TQE учитывают двухслойную архитектуру продукта: ядро (storage и router) и модуль API (gRPC). Ядро всегда обрабатывается первым при запуске и последним при остановке; шаги с модулем API выполняются, только если задана переменная tqe_api_hosts.

Переменные плейбуков TQE (группы хостов tqe_core_hosts и tqe_api_hosts, параметры ожидания готовности) приведены в разделе «Переменные окружения», страница переменных TQE.

tqe/start.yml

Плейбук для запуска TQE. Запускает ядро, дожидается его готовности, затем запускает модуль API и проверяет его здоровье.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tqe/start.yml

tqe/stop.yml

Плейбук для остановки TQE. Сначала останавливает модуль API (чтобы он не обращался к останавливаемому ядру), затем ядро.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tqe/stop.yml

tqe/restart.yml

Плейбук для перезапуска TQE. Останавливает модуль API, перезапускает ядро, дожидается его готовности, затем запускает модуль API и проверяет его здоровье.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tqe/restart.yml

tqe/update_api.yml

Плейбук для обновления экземпляров модуля API TQE до доставленной версии пакета: переключает символическую ссылку экземпляра на новый дистрибутив и перезапускает сервис. Пакет доставляется окружающим сценарием (например, continuous_update.yml), а не самим плейбуком.

Обновление выполняется пакетами (serial) размером update_batch_size. Используется сценарием последовательного обновления continuous_update.yml для экземпляров модуля API.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tqe/update_api.yml --limit ${LIMIT}

tqe/health.yml

Плейбук для проверки здоровья модуля API TQE. С повторными попытками опрашивает точки подключения readyz (готовность) и livez (живость) на порту tqe_health_port каждого целевого хоста.

Используется плейбуками tqe/start.yml и tqe/restart.yml после запуска модуля API.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tqe/health.yml --limit ${LIMIT}

TDB Worker

tdb_worker/install.yml

Плейбук для установки TDB Worker. Выполняет подготовку переменных и вызывает роль tarantool.enterprise.tdb_worker. По умолчанию применяется к группе хостов tdb-worker.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tdb_worker/install.yml

tdb_worker/uninstall.yml

Плейбук для удаления TDB Worker. Выполняет подготовку переменных и вызывает роль tarantool.enterprise.tdb_worker с задачей удаления. По умолчанию применяется к группе хостов tdb-worker.

Примеры

Запуск через коллекцию:

ansible-playbook -i ${PATH_TO_INVENTORY} \    --user ${SUPER_USER_NAME} \    -e ansible_ssh_private_key_file=${PATH_TO_PRIVATE_KEY} \    playbooks/tdb_worker/uninstall.yml
Была ли статья полезна?
Была ли статья полезна?