Виды входных данных Recipe
Эта страница объясняет одну идею, три входа, из которых рендерит сущность Recipe, и то, как они складываются, и не является запускаемым рабочим пространством. MariaDB + Adminer — запускаемый пример с двумя целями реализует один компонент с помощью синтезированной сущности Recipe, полученного чарта и артефактов рядом с ними; запишите его в собственную папку командой:
aggrega scaffold --example mariadb-adminerЗатем она выводит команды, которые нужно выполнить дальше:
cd mariadb-admineraggrega pull --release release-compose.yamlaggrega build --release release-compose.yamlУ сущности Recipe три входа, и она использует любое их сочетание:
- Workload (
workload:), собственное описание контейнеров, портов, томов и сервисов в сборке, которое провайдер синтезирует в ресурсы цели — Deployment и Service в Kubernetes, сервис в Docker Compose; - источник (
source:), чарт, модуль или шаблон, который рендерит провайдер, с данными изvaluesMappingсущности Recipe; - артефакты (
artifacts:), файлы, которые сущность Recipe записывает как есть, после шаблонизации, рядом с тем, что создают два других входа.
То, как складываются эти три входа, изложено в Композиция входных данных Recipe; собственная поверхность сущности Workload — entities/workload.md, а контекст, который читает каждый шаблон, — .values, .infra, .context, .locals, .features — это vocabulary/data-pillars.md.
Приведённые ниже сущности Recipes реализуют сущность Component, которую рабочее пространство объявляет для себя, local/compute/api-server, с image и port среди её values, replicas среди её infra, а также host, port и protocol среди того, что она публикует.
Только сущность Workload
Без source: и без artifacts: сущность Workload определяет весь вывод:
kind: Recipemetadata: name: api-server-helmspec: capability: helm implements: local/compute/api-server:1.0.0 locals: port: "{{ optional .values `port` 8080 }}" provides: host: "{{ .context.rendered_name }}-http" port: "{{ .locals.port }}" protocol: http workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload replicas: {{ optional .infra `replicas` 1 }} containers: main: image: "{{ .values.image }}" variables: {{- range $k, $v := .context.inject.env }} {{ $k }}: "{{ $v }}" {{- end }} ports: web: {{ .locals.port }} services: http: type: ClusterIP ports: web: {{ .locals.port }}Для компонента с именем api провайдер helm записывает Deployment и ClusterIP Service. Переменные, которые доставляют соединения, поступают в .context.inject.env и записываются в контейнер.
Сущность Workload и артефакты
Артефакты добавляют файлы, на которые ссылается сущность Workload. Сущность Workload со вторым контейнером, монтирующим ConfigMap, и ConfigMap в качестве артефакта:
spec: locals: proxy_cm: "proxy-config" workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload containers: main: image: "{{ .values.image }}" ports: web: 8080 proxy: image: envoyproxy/envoy:v1.28 volumeMounts: - name: proxy-config path: /etc/envoy readonly: true volumes: proxy-config: configmap: source: "{{ .context.rendered_name }}-{{ .locals.proxy_cm }}" artifacts: proxy-config.yaml: | apiVersion: v1 kind: ConfigMap metadata: name: {{ .context.rendered_name }}-{{ .locals.proxy_cm }} data: listen-port: "{{ .workload.containers.main.ports.web.port }}"Артефакт читает сущность Workload в .workload, а не повторяет её значения: порт контейнера доходит до него как объект, содержащий свой номер под port, в какой бы форме его ни записала сущность Workload. ConfigMap получает имя по .context.rendered_name — имени, которое провайдер helm даёт ресурсам компонента, — за которым следует суффикс из локальной переменной; локальная переменная не может прочитать отрендеренное имя, поэтому том и артефакт каждый сами соединяют эти две части, и имя, которое монтирует том, — это имя, которое записывает артефакт.
Источник и артефакты
Сущность Recipe может отрендерить полученный чарт и добавить рядом с ним собственные файлы. Здесь core/datastore/mariadb из каталога реализуется чартом поставщика, а артефакт добавляет Prometheus ServiceMonitor:
kind: Recipemetadata: name: mariadb-with-monitorspec: capability: helm implements: core/datastore/mariadb:1.0.0 provides: host: "{{ .context.rendered_name }}" port: "{{ .infra.port }}" protocol: mariadb source: kind: helm-oci-chart url: oci://registry-1.docker.io/bitnamicharts/mariadb version: "25.0.8" valuesMapping: | fullnameOverride: "{{ .context.rendered_name }}" auth: database: "{{ .values.database }}" artifacts: servicemonitor.yaml: | apiVersion: monitoring.coreos.com/v1 kind: ServiceMonitor metadata: name: {{ .context.rendered_name }}-monitor spec: selector: matchLabels: app.kubernetes.io/instance: {{ .context.rendered_name }} endpoints: - port: mysql interval: 30sЧарт помечает свои ресурсы меткой с именем релиза, которое ему даёт сборка, поэтому селектор строится из .context.rendered_name; селектор, построенный из .context.instance_id, ничего бы не нашёл для компонента, имя которого содержит подчёркивание или заглавную букву. Ключ артефакта — это имя его выходного файла, используемое как есть, и сборка останавливается, если чарт тоже рендерит файл с этим именем.
Сущность Workload в отдельном файле
workload: и запись artifacts: могут каждая импортировать файл вместо того, чтобы содержать текст встроенно:
spec: workload: $import: ./workload/workload.yaml artifacts: networkpolicy: $import: ./artifacts/networkpolicy.yamlИмпортированный файл сущности Workload обрабатывается как шаблон в том же контексте, что и встроенный. Файл, который импортирует запись artifacts:, фиксируется до того, как его прочитает сборка: aggrega pin <recipe-dir>/recipe.yaml записывает рядом с сущностью Recipe файл entity.lock с дайджестом файла, и сборка останавливается, называя эту команду, пока lock-файл не содержит фиксации для файла или файл больше ей не соответствует. Импорт библиотеки Workload — общее тело сущности Workload через $import собирает сущность Recipe, сущность Workload которой импортирована.