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

Шаблоны приложений

tt create создаёт приложение из шаблона.

Шаблон может быть встроенным и задаваться по имени (tt create cluster) либо собственным и задаваться путём: каталогом или архивом .tgz или .tar.gz, который можно указывать без расширения (tt create ./templates/basic). Путь отличает от имени наличие слэша, поэтому шаблон из текущего каталога задаётся как ./<name>.

Приложение создаётся в подкаталоге --name текущего каталога либо каталога, переданного в --dst.

Встроенные шаблоны

Встроенные шаблоны - single_instance, cluster, vshard_cluster и config_storage. Каждый из них разворачивает проект, сразу готовый к запуску на localhost: код приложения лежит в каталоге проекта, а пара файлов, по которой оно работает, instances.yaml и config.yaml, - в .templates/default/:

$ tt create cluster --name app1
app1/
├── .templates
│   └── default
│       ├── config.yaml
│       └── instances.yaml
└── app.lua

app.file и остальные пути в config.yaml отсчитываются от каталога проекта - того каталога, в котором запускаются экземпляры; данные, журналы и сокеты пишутся там же в .tarantool/var/. Проект получает имя по своему каталогу; кроме того, vshard_cluster создаёт app.manifest.toml, где имя записывается как --name с заменой _ на -, и перед запуском требует выполнить tt package build для сборки зависимости vshard. Шаблону config_storage необходим Tarantool Enterprise Edition, предоставляющий роль config.storage.

Когда шаблон создаёт app.manifest.toml, tt create отвергает значение --name, из которого нельзя получить допустимое имя пакета - строчные буквы, цифры и дефисы, начинающиеся с буквы, - и ничего не создаёт: --name my_app даёт шаблону vshard_cluster имя my-app, а --name My_App отвергается.

Собственные шаблоны

Собственный шаблон создаёт проект с такой же структурой, если в нём есть .templates/<name>/instances.yaml и config.yaml; файлы внутри .templates/ обрабатываются по шаблону точно так же, как и любые другие.

Шаблон приложения может содержать:

  • *.tt.template - файлы шаблона, в которых при создании приложения выполняется подстановка переменных.
  • MANIFEST.yaml - манифест шаблона (подробности ниже).

MANIFEST.yaml

Манифест шаблона MANIFEST.yaml имеет следующий формат:

description: Template description
vars:
    - prompt: User name
      name: user_name
      default: admin
      re: ^\w+$

    - prompt: Retry count
      default: "3"
      name: retry_count
      re: ^\d+$
pre-hook: ./hooks/pre-gen.sh
post-hook: ./hooks/post-gen.sh
include:
- init.lua
- .templates/default/instances.yaml
- .templates/default/config.yaml
follow-up-message: Run "tt instance start" in {{.name}}.

Где:

  • description (строка) - описание шаблона.
  • vars - переменные шаблона, используемые для подстановки.
  • prompt - текст приглашения для ввода значения переменной.
  • name - имя переменной.
  • default - значение переменной по умолчанию.
  • re - регулярное выражение для проверки значения.
  • pre-hook (строка) - исполняемый файл, запускаемый перед подстановкой шаблона.
  • post-hook (строка) - исполняемый файл, запускаемый после подстановки шаблона.
  • include (список) - список файлов, которые остаются в каталоге приложения после создания.
  • follow-up-message (строка) - сообщение, выводимое после создания приложения, с подставленными в него переменными.

В тексте шаблона доступна предопределённая переменная: name - имя приложения. Ей присваивается значение аргумента командной строки --name.

В шаблон приложения не следует включать каталог .rocks. Зависимости приложения объявляются в секции [dependencies] файла app.manifest.toml (см. Packages).

Переменные

tt create запрашивает значение каждой переменной из vars, предлагая её значение по умолчанию. Флаг --var name=value, который можно повторять, и --vars-file FILE задают значения заранее, а -s (--non-interactive) берёт значения остальных переменных по умолчанию без запроса. Флаг -f перезаписывает каталог приложения, если он уже существует.