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

Основной артефакт, определяющий окружение tt и различные аспекты его работы – это конфигурационный файл. Его можно создать с помощью команды tt init. В режиме запуска по умолчанию файл создается в текущем каталоге, который становится корнем окружения.

По умолчанию конфигурационный файл называется tt.yaml и находится в корневом каталоге окружения tt. Расположение зависит от режима запуска.

Имя и расположение конфигурационного файла можно задать явно следующими способами:

1. Глобальный параметр -c/--cfg.
2. Переменная окружения TT_CLI_CFG.

Переменная TT_CLI_CFG имеет более низкий приоритет, чем параметр --cfg.

Конфигурационный файл tt - это YAML-файл со следующей структурой:

 
env:  instances_enabled: path/to/available/applications  bin_dir: path/to/bin_dir  inc_dir: path/to/inc_dir  restart_on_failure: bool  tarantoolctl_layout: boolmodules:  directory: path/to/modules/dirapp:  run_dir: path/to/run_dir  log_dir: path/to/log_dir  wal_dir: path/to/wal_dir  vinyl_dir: path/to/vinyl_dir  memtx_dir: path/to/memtx_dirrepo:  rocks: path/to/rocks  distfiles: path/to/installee:  credential_path: path/to/filetemplates:  - path: path/to/app/templates1  - path: path/to/app/templates2

• instances_enabled - каталог, в котором хранятся экземпляры. Значение по умолчанию: instances.enabled.

• bin_dir - каталог для хранения исполняемых файлов. Значение по умолчанию: bin.

• inc_dir - базовый каталог для хранения заголовочных файлов. Они помещаются в подкаталог include внутри указанного каталога. Значение по умолчанию: include.

• restart_on_failure – перезапуск экземпляра при сбое: true или false. Значение по умолчанию: false.

• tarantoolctl_layout – использование структуры файлов, совместимой с устаревшей утилитой tarantoolctl: управляющие сокеты, .pid-файлы, файлы журналов. Значение по умолчанию: false.

• directory – каталог, в котором хранятся внешние модули.

• run_dir – каталог для рабочих артефактов экземпляра, таких как консольные сокеты или PID-файлы. Значение по умолчанию: var/run.
• log_dir – каталог для хранения файлов журналов. Значение по умолчанию: var/log.
• wal_dir – каталог для хранения файлов журнала упреждающей записи (.xlog). Значение по умолчанию: var/lib.
• memtx_dir - каталог, в котором memtx хранит файлы снимков (.snap). Значение по умолчанию: var/lib.
• vinyl_dir - каталог для хранения файлов или подкаталогов vinyl. Значение по умолчанию: var/lib.

• rocks - каталог для хранения файлов rock-пакетов.

• distfiles - каталог для хранения установочных файлов.

• credential_path - путь к файлу с учетными данными, используемыми для загрузки Tarantool Enterprise Edition (учетные данные клиентской зоны Tarantool). Файл должен содержать имя пользователя и пароль, каждый на отдельной строке. Пример приведен в описании команды tt install.

• path – путь к шаблонам приложений, используемым для создания приложений с помощью команды tt create. Может быть указан более одного раза.

Режим запуска tt определяет рабочий каталог и способ поиска конфигурационного файла. Существует три режима запуска:

• default (по умолчанию);
• system (системный);
• local (локальный).

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

Конфигурационный файл: поиск выполняется от текущего каталога до корневого. Если файл не найден, он берется из /etc/tarantool.

Рабочий каталог: каталог, в котором найден конфигурационный файл.

Глобальный параметр: --system или -S

Конфигурационный файл: берется из /etc/tarantool.

Рабочий каталог: текущий каталог.

Глобальный параметр: --local=DIRECTORY или -L=DIRECTORY

Конфигурационный файл: поиск выполняется от указанного каталога до корневого. Если файл не найден, он берется из /etc/tarantool.

Рабочий каталог: указанный каталог. Если в рабочем каталоге найдены исполняемые файлы tarantool или tt, они будут использованы.

Конфигурация tt и структура каталогов приложений были изменены в версии 2.0. При использовании tt 1.* для перехода на tt 2.0 или более позднюю версию выполните следующие шаги:

1. Обновите конфигурационный файл tt. В tt 2.0 в конфигурационный файл внесены следующие изменения:

   • Корневая секция tt удалена. Её дочерние секции – app, repo, modules и другие - перенесены на верхний уровень.
   • Параметры конфигурации окружения перенесены из секции app в новую секцию env. Это параметры instances.enabled, bin_dir, inc_dir и restart_on_failure.
   • Пути в секции app теперь задаются относительно каталога приложения в instances.enabled, а не относительно корня окружения. Для создания конфигурационного файла с новой структурой и значениями параметров по умолчанию можно использовать команду tt init.

2. Переместите артефакты приложений. В tt 1.* артефакты приложений (журналы, снимки, pid-файлы и другие файлы) создавались в каталоге var внутри корня окружения. Начиная с tt 2.0 эти артефакты создаются в каталоге var внутри каталога приложения, то есть instances.enabled/<имя-приложения>. Структура каталога приложения выглядит так:

    
   instances.enabled/app/├── init.lua├── instances.yaml└── var    ├── lib    │   ├── instance1    │   └── instance2    ├── log    │   ├── instance1    │   └── instance2    └── run        ├── instance1        └── instance2

   Чтобы продолжить использовать существующие артефакты приложений после перехода с tt 1.*:

   1. Создайте каталог var внутри каталога приложения.
   2. Создайте каталоги lib, log и run внутри var.
   3. Переместите каталоги с артефактами экземпляров из старого каталога var в новые каталоги var в каталогах приложений.

3. Переместите файлы, к которым обращается код приложения. Рабочий каталог процессов экземпляра изменен с рабочего каталога tt на каталог приложения внутри instances.enabled. Если приложение обращается к файлам по относительным путям, переместите соответствующие файлы или измените код приложения.