Обзор

Шаблоны микросервисов задают структуру репозитория нового микросервиса: код-заготовку, CI/CD, манифесты развёртывания и конфигурацию. Deckhouse Development Portal (DDP, портал) создаёт репозиторий микросервиса из шаблона, а при выходе новой версии шаблона переносит изменения в репозиторий через запрос на слияние.

Основные понятия

Механизм шаблонов использует следующие понятия:

• пакет шаблона — директория с манифестом template.yaml, схемой параметров values.yaml и файлами на Go-шаблонах. Пакет публикуется в хранилище образов контейнеров как OCI-артефакт; версия пакета — тег артефакта в формате semver;
• реестр шаблонов — подключения портала к хранилищам образов контейнеров, в которых опубликованы пакеты. Портал синхронизирует реестр по расписанию и ведёт каталог версий шаблонов;
• последняя версия — рекомендованная версия шаблона: максимальная стабильная версия среди доступных. Её предлагает мастер создания и на неё обновляются микросервисы;
• lock-файл — файл .ddp/template.lock.yaml в репозитории микросервиса. Хранит идентификатор шаблона, его версию и значения параметров, с которыми создан репозиторий;
• привязка микросервиса к шаблону — параметры сущности микросервиса в каталоге: идентификатор шаблона, версия, реестр и политика обновления;
• действия по шаблонам — процессы создания, развёртывания, удаления с окружения и обновления, привязанные к конкретному шаблону в правилах маппинга главной.

Жизненный цикл шаблона

Схема ниже показывает путь от публикации шаблона до обновления репозитория микросервиса:

  sequenceDiagram
  participant A as Автор шаблона
  participant O as Хранилище образов (OCI)
  participant D as DDP
  participant G as GitLab
  A->>O: ddp-template publish (версия 1.0.0)
  D->>O: Синхронизация реестра
  Note over D: Версия 1.0.0 — последняя
  D->>G: Создание микросервиса: проект, файлы, lock-файл
  A->>O: ddp-template publish (версия 1.1.0)
  D->>O: Синхронизация реестра
  Note over D: Версия 1.1.0 — последняя
  D->>G: Обновление: ветка, коммит, запрос на слияние
  Note over G: Владелец микросервиса принимает запрос на слияние
  D->>G: Сверка версии по lock-файлу
  Note over D: Версия микросервиса в каталоге — 1.1.0

Этапы жизненного цикла:

1. Автор шаблона готовит пакет и публикует версию утилитой ddp-template. Формат пакета описан в разделе «Пакет шаблона».
2. Портал синхронизирует реестр шаблонов и добавляет версию в каталог версий.
3. Администратор привязывает к шаблону процессы в блоке «Действия по шаблонам» правил маппинга.
4. Разработчик создаёт микросервис в разделе главной «Создать микросервис». Процесс создания создаёт проект GitLab, записывает в него отрисованные файлы шаблона и lock-файл, регистрирует микросервис в каталоге.
5. При выходе новой версии шаблона портал показывает в карточке микросервиса уведомление «Доступна версия {version}». Обновление запускается кнопкой «Обновить» или автоматически.
6. Процесс обновления создаёт ветку с изменениями шаблона и открывает запрос на слияние. После принятия запроса на слияние портал обновляет версию шаблона микросервиса в каталоге.

Подробно механизм обновления описан в разделе «Обновление из шаблона».

Роли участников

С шаблонами работают разные участники:

Ограничения

Механизм шаблонов имеет следующие ограничения: