Przejdź do głównej zawartości
AggregaAggrega
Wybierz język: Polski
Ta strona została przetłumaczona maszynowo. Przeczytaj oryginał w języku angielskim.

Rodzaje wejść encji Recipe

Ta strona wyjaśnia jedną ideę, trzy wejścia, z których renderuje encja Recipe, i to, jak się sumują, i nie jest uruchamialną przestrzenią roboczą. MariaDB + Adminer — uruchamialny przykład z dwoma celami realizuje jeden komponent za pomocą syntetyzowanej encji Recipe, pobranego chartu i artefaktów obok nich; można go zapisać we własnym folderze poleceniem:

Terminal window
aggrega scaffold --example mariadb-adminer

Następnie wypisuje polecenia do uruchomienia w dalszej kolejności:

Terminal window
cd mariadb-adminer
aggrega pull --release release-compose.yaml
aggrega build --release release-compose.yaml

Encja Recipe ma trzy wejścia i używa dowolnej ich kombinacji:

  • Workload (workload:), własny opis buildu dotyczący kontenerów, portów, woluminów i usług, który dostawca syntetyzuje w zasoby celu — Deployment i Service w Kubernetes, usługa w Docker Compose;
  • źródło (source:), chart, moduł lub szablon renderowany przez dostawcę, zasilany przez valuesMapping encji Recipe;
  • artefakty (artifacts:), pliki, które encja Recipe zapisuje w niezmienionej postaci, po przetworzeniu szablonów, obok tego, co tworzą pozostałe dwa wejścia.

To, jak te trzy wejścia się składają, opisano w Kompozycja wejść encji Recipe; własna powierzchnia encji Workload to entities/workload.md, a kontekst odczytywany przez każdy szablon — .values, .infra, .context, .locals, .features — to vocabulary/data-pillars.md.

Poniższe encje Recipes implementują encję Component, którą przestrzeń robocza deklaruje dla siebie, local/compute/api-server, z image i port wśród jej values, replicas wśród jej infra oraz host, port i protocol wśród tego, co publikuje.

Sama encja Workload

Bez source: i bez artifacts: encja Workload steruje całym wyjściem:

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 }}

Dla komponentu o nazwie api dostawca helm zapisuje Deployment i ClusterIP Service. Zmienne dostarczane przez połączenia trafiają do .context.inject.env i są zapisywane w kontenerze.

Encja Workload i artefakty

Artefakty dodają pliki, do których odwołuje się encja Workload. Encja Workload z drugim kontenerem montującym ConfigMap oraz ConfigMap jako artefakt:

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 }}"

Artefakt odczytuje encję Workload w .workload, zamiast powtarzać jej wartości: port kontenera dociera do niego jako obiekt przechowujący swój numer pod port, niezależnie od tego, w jakiej postaci zapisała go encja Workload. Nazwa obiektu ConfigMap składa się z .context.rendered_name, czyli nazwy, którą dostawca helm nadaje zasobom komponentu, oraz przyrostka przechowywanego w zmiennej lokalnej; zmienna lokalna nie może odczytać wyrenderowanej nazwy, dlatego wolumin i artefakt każdy z osobna łączą te dwie części, a nazwa montowana przez wolumin jest nazwą zapisywaną przez artefakt.

Źródło i artefakty

Encja Recipe może wyrenderować pobrany chart i dodać obok niego własne pliki. Tutaj core/datastore/mariadb z katalogu jest realizowany przez chart producenta, a artefakt dodaje 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

Chart oznacza swoje zasoby etykietą z nazwą wydania, którą nadaje mu build, więc selektor jest budowany z .context.rendered_name; selektor zbudowany z .context.instance_id nie dopasowałby niczego dla komponentu, którego nazwa zawiera podkreślenie lub wielką literę. Klucz artefaktu jest nazwą jego pliku wyjściowego, użytą dosłownie, a build zatrzymuje się, jeśli chart również renderuje plik o tej nazwie.

Encja Workload przechowywana we własnym pliku

workload: i wpis artifacts: mogą każdy zaimportować plik, zamiast przechowywać tekst inline:

spec:
workload:
$import: ./workload/workload.yaml
artifacts:
networkpolicy:
$import: ./artifacts/networkpolicy.yaml

Zaimportowany plik encji Workload jest przetwarzany jako szablon w tym samym kontekście co encja Workload zapisana inline. Plik importowany przez wpis artifacts: jest przypinany, zanim build go odczyta: aggrega pin <recipe-dir>/recipe.yaml zapisuje obok encji Recipe plik entity.lock ze skrótem pliku, a build zatrzymuje się, wskazując to polecenie, dopóki blokada nie zawiera przypięcia dla pliku albo plik nie odpowiada mu już. Import z biblioteki Workload — wspólna treść encji Workload przez $import buduje encję Recipe, której encja Workload jest importowana.