Создание приложения по шаблону

Директория проекта

В директории <имя_приложения>/ находится несколько групп файлов.

• Файлы приложения:

  • app/roles/custom-role.lua — пример кластерной роли с простым HTTP API. Эту роль можно включить, передав ее как app.roles.custom.
  • <имя_приложения>-scm-1.rockspec — файл, содержащий зависимости приложения.
  • init.lua — точка входа в приложение.
  • stateboard.init.lua — точка входа в экземпляр stateboard приложения.

• Файлы, необходимые для сборки и упаковки:

  • cartridge.pre-build
  • cartridge.post-build
  • Dockerfile.build.cartridge
  • Dockerfile.cartridge

  Подробную информацию вы найдете в документации по скриптам pre-build и post-build, сборке приложения с помощью Docker и созданию Docker-образа приложения.

• Файлы, необходимые для разработки:

  • deps.sh решает проблемы с зависимостями из файла .rockspec и устанавливает зависимости для тестирования (например, luatest).
  • instances.yml содержит конфигурацию экземпляров и используется командой cartridge start.
  • .cartridge.yml содержит конфигурацию Cartridge и используется командой cartridge start.
  • systemd-unit-params.yml содержит параметры systemd.
  • tmp — директория для временных файлов, выступающая в качестве директории запуска (см. .cartridge.yml).
  • .git — директория Git-репозитория.
  • В файле .gitignore можно указать файлы, игнорируемые Git.

• Файлы, необходимые для тестирования, и примеры тестов:

test
├── helper
│   ├── integration.lua
│   └── unit.lua
│   ├── helper.lua
│   ├── integration
│   │   └── api_test.lua
│   └── unit
│       └── sample_test.lua

• Файлы конфигурации:
  • .luacheckrc
  • .luacov
  • .editorconfig

Работа с пользовательскими шаблонами

По умолчанию команда create задействует стандартный шаблон под названием cartridge. Вы также можете использовать собственный шаблон. Чтобы создать по нему приложение, передайте в команде cartridge create параметр --from, указав в качестве аргумента путь к своему шаблону.

Если шаблон находится в Git-репозитории, при создании приложения по этому шаблону все файлы в директории .git игнорируются. Вместо этого для нового приложения создается новый Git-репозиторий.

Чтобы задать зависимости для приложения, не следует создавать директорию .rocks в своем шаблоне — используйте файлы .rockspec и cartridge.pre-build.

my-template
├── {{ .Name }}-scm-1.rockspec
└── init.lua
└── stateboard.init.lua
└── test
    └── sample_test.lua

print("Здравствуйте! Я приложение {{ .Name }}")
print("У меня есть экземпляр stateboard под названием {{ .StateboardName }}")