Перейти к содержанию

instances.yaml

Описание того, что работает на хосте: половина пары, по которой запускается приложение, рядом с конфигурацией кластера config.yaml. Находится в .templates/<name>/ проекта или пакета либо в <root>/etc/<app>/ для пары хоста. См. Экземпляры.

"*":
  restart: on-failure
router-001:
  restart: always
  stop_timeout: 60s
gateway:
  binary: gateway
  args: [--port, "8080"]
  env: {GATEWAY_MODE: production}
  logrotate_signal: SIGHUP
legacy:
  script: init.lua

Документ сопоставляет имена экземпляров с записями. Имя без записи, storage-001:, задаёт экземпляр Tarantool со значениями всех полей по умолчанию. Экземпляры запускаются в том порядке, в котором они записаны; экземпляры, заменяющие собой "*", встают на её место по порядку своих имён.

Имя экземпляра не может быть пустым, . или .., а также содержать слэш или управляющий символ: оно задаёт имена каталогов экземпляра. Алиасы и ключи слияния YAML не поддерживаются.

Вид записи

Запись Вид
без binary и без script экземпляр Tarantool, настроенный конфигурацией кластера; должен присутствовать в топологии config.yaml
script экземпляр Tarantool, настраиваемый своим скриптом; см. Запуск приложения на box.cfg
binary внешний процесс; см. Запуск внешнего процесса

Поля binary и script взаимоисключающие. Ни экземпляр со скриптом, ни внешний процесс не могут называться именем экземпляра из топологии.

Запись "*" - в кавычках, поскольку отдельный символ * является алиасом YAML - обозначает каждый экземпляр топологии, для которого нет другой записи. Она не может содержать binary или script. Запись конкретного экземпляра из топологии полностью заменяет собой "*", не наследуя ни одного её поля.

Поля

Поле Виды По умолчанию
restart все no no, on-failure или always: когда процесс-наблюдатель снова запускает экземпляр после его самостоятельного завершения
stop_signal все SIGTERM сигнал, отправляемый при останове: SIGINT или INT
stop_timeout все 30s сколько времени ожидать перед принудительным завершением экземпляра; положительная длительность, например 10s или 1m30s
env все переменные окружения, накладываемые поверх окружения tt
script script скрипт на Lua, относительно каталога приложения
binary external программа: путь относительно каталога приложения, если он содержит слэш; иначе имя программы, которое ищется в .rocks/bin/ приложения, а затем в PATH
args external аргументы программы, список строк
workdir external каталог данных рабочий каталог относительно каталога приложения
logrotate_signal external нет сигнал, который tt instance logrotate отправляет процессу

Под systemd restart становится директивой Restart= unit-файла, а stop_timeout - его TimeoutStopSec=; см. Запуск экземпляров под systemd.

С флагом --integrity-check секция env у экземпляра Tarantool отвергается: эти значения должны находиться в конфигурации кластера. См. Подпись пакетов.