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

Проекты и области установки

У tt нет конфигурационного файла. То, с чем работает утилита, определяется местом её запуска и переданным команде флагом --scope: проект, область установки (scope) текущего пользователя или область установки всей системы.

Проекты

Проект - это каталог разрабатываемого приложения. Каталог считается проектом, если содержит:

  • app.manifest.toml, манифест пакета, или
  • шаблон экземпляра: instances.yaml, config.yaml или оба файла в .templates/<name>/ (см. Экземпляры).

tt ищет проект от текущего каталога вверх по дереву, поэтому команды работают из любого его подкаталога: команды экземпляров, tt package, tt run, которая запускает Tarantool в текущем каталоге, tt test, которая запускает тесты в корне проекта, tt wasm и модули, такие как tt emmylua. Команда, нашедшая проект выше текущего каталога, сообщает об этом в stderr (working on the project in DIR). Флаг -C DIR у команд tt package и tt test задаёт сам проект: DIR берётся как есть, каталоги над ним не просматриваются. tt new создаёт проект в текущем каталоге или, с -C, в DIR, а tt binary build работает с дистрибутивом в каталоге, где запущен. Выигрывает ближайший проект, поэтому проект, вложенный в другой, находится из собственных подкаталогов. Другие файлы - .rocks/, .git/, файлы Lua, config.yaml в других местах - не делают каталог проектом. Каталог .tarantool/ тоже: tt binary install создаёт его в каталоге, который ещё не является проектом.

Приложение проекта получает имя из [package].name в манифесте, а без манифеста называется по имени каталога проекта.

Области установки

Бинарные файлы, установленные приложения и данные их экземпляров находятся в одной из трёх областей установки, у каждой из которых есть свой корневой каталог, <root>:

Область установки <root>
project .tarantool/ в каталоге проекта; текущий каталог вне проекта
user $TT_USER_ROOT; иначе $XDG_DATA_HOME/tarantool, если это абсолютный путь; иначе ~/.local/share/tarantool. На macOS: ~/Library/Application Support/tarantool
system $TT_SYSTEM_ROOT; иначе /opt/tarantool. На macOS: /Library/Application Support/tarantool

Переменные TT_USER_ROOT и TT_SYSTEM_ROOT должны содержать абсолютные пути. У каждого корня одна и та же структура каталогов:

<root>/
├── bin/          # активные tarantool, tt и tcm (ссылки)
├── include/      # заголовочные файлы активного tarantool
├── versions/     # установленные бинарные файлы и (в user и system) приложения
├── apps/<app>    # user и system: ссылка на активную версию <app>
├── etc/<app>/    # user и system: пара хоста, запись для systemd
└── var/          # lib/, log/, run/ каждого экземпляра по приложениям

Команда действует в одной области установки и никогда не переходит в другую: её результат не должен зависеть от того, что случайно оказалось установлено в другом месте.

  • tt binary устанавливает и переключает бинарные файлы в --scope project (по умолчанию), user или system.
  • tt package install устанавливает архив в проект (по умолчанию) или делает его версией приложения в области установки пользователя или системы. См. Пакеты.
  • Команды управления экземплярами работают с <app>:<instance>: текущим проектом, если он называется <app>, и областью установки системы в противном случае. В область установки пользователя можно попасть только через --scope user, а сам флаг --scope позволяет выбрать любую область установки напрямую.

Область установки проекта

Область установки проекта принадлежит самому проекту: tt binary install в проекте кладёт бинарные файлы в его каталог .tarantool/, отдельно от других приложений, а экземпляры проекта хранят свои данные в .tarantool/var/.

Команды, запускающие Tarantool в проекте, - tt instance, tt run, tt test, tt package build - выполняют .tarantool/bin/tarantool, если он есть в проекте, и первый tarantool из PATH в противном случае. Переменная TT_USE_SYSTEM_TARANTOOL=1 заставляет проект работать на Tarantool из PATH, даже если у проекта есть собственный; на установленные приложения она не распространяется. Если версия Tarantool отличается от версии, зафиксированной в локфайле, выводится предупреждение, а не ошибка.

Первый вызов tt binary install в проекте создаёт в нём .env/activate.sh и .env/deactivate.sh:

$ source .env/activate.sh     # .tarantool/bin первым в PATH, переменная TT_PROJECT_DIR установлена
$ source .env/deactivate.sh   # возврат к прежнему состоянию

Скрипт activate.sh также указывает TT_CLI_TARANTOOL_PREFIX на .tarantool, чтобы rocks с частями на C собирались с заголовками Tarantool проекта.

Области установки пользователя и системы

Области установки пользователя и системы содержат установленные приложения. Приложение представляет собой набор версий, <root>/versions/<app>/<app>_<version>/, каждая из которых является пакетом с структурой каталогов проекта, а <root>/apps/<app> указывает на активную версию. Установленное приложение работает на том Tarantool, который поставляется в его пакете, независимо от <root>/bin/tarantool. В каталог версии ничего не записывается: экземпляры хранят свои данные в <root>/var/, а пара хоста, <root>/etc/<app>/, описывает то, что работает на этом хосте независимо от версии, поэтому и то и другое сохраняется при обновлении.

Чтобы использовать бинарные файлы этих областей установки, <root>/bin добавляют в PATH.