Перейти до вмісту
AggregaAggrega
Обрати мову: Українська
Цю сторінку перекладено машинним способом. Читати оригінал англійською.

Види вхідних даних Recipe

Ця сторінка пояснює одну ідею, три входи, з яких рендерить сутність Recipe, і те, як вони додаються, і не є робочим простором, який можна запустити. MariaDB + Adminer — приклад із двома цілями, який можна запустити реалізує один компонент за допомогою синтезованої сутності Recipe, отриманого чарта й артефактів поруч із ними; запишіть його у власну теку командою:

Terminal window
aggrega scaffold --example mariadb-adminer

Потім вона виводить команди, які слід виконати далі:

Terminal window
cd mariadb-adminer
aggrega pull --release release-compose.yaml
aggrega 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: Recipe
metadata:
name: api-server-helm
spec:
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: Recipe
metadata:
name: mariadb-with-monitor
spec:
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 якої імпортовано.