Tipos de entrada da Recipe
Esta página explica uma ideia, as três entradas a partir das quais uma Recipe renderiza e como elas se somam, e não é um espaço de trabalho executável. MariaDB + Adminer — um exemplo executável com dois destinos realiza um componente com uma Recipe sintetizada, um chart obtido e artefatos ao lado deles; escreva-o em uma pasta sua com:
aggrega scaffold --example mariadb-adminerEm seguida ele imprime os próximos comandos a executar:
cd mariadb-admineraggrega pull --release release-compose.yamlaggrega build --release release-compose.yamlUma Recipe tem três entradas e usa qualquer combinação delas:
- um Workload (
workload:), a descrição própria do build de contêineres, portas, volumes e serviços, que o provedor sintetiza nos recursos do destino — um Deployment e um Service no Kubernetes, um serviço no Docker Compose; - uma origem (
source:), um chart, um módulo ou um template que o provedor renderiza, alimentada pelovaluesMappingda Recipe; - artefatos (
artifacts:), arquivos que a Recipe escreve como estão, após o processamento de templates, ao lado do que os outros dois produzem.
Como os três se compõem é exposto em Composição das entradas da Recipe; a superfície própria do Workload é entities/workload.md, e o contexto que todo template lê — .values, .infra, .context, .locals, .features — é vocabulary/data-pillars.md.
As Recipes abaixo implementam um Component que o espaço de trabalho declara para si mesmo, local/compute/api-server, com um image e um port entre os seus values, replicas entre o seu infra, e host, port e protocol entre o que ele publica.
Um Workload sozinho
Sem source: e sem artifacts:, o Workload conduz toda a saída:
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 }}Para um componente chamado api, o provedor helm escreve um Deployment e um Service ClusterIP. As variáveis que as conexões entregam chegam em .context.inject.env e são escritas no contêiner.
Um Workload e artefatos
Os artefatos adicionam arquivos aos quais o Workload se refere. Um Workload com um segundo contêiner que monta um ConfigMap, e o ConfigMap como artefato:
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 }}"Um artefato lê o Workload em .workload em vez de repetir os seus valores: uma porta de contêiner chega até ele como um objeto que contém o seu número em port, seja qual for a forma em que o Workload a escreveu. O ConfigMap recebe o nome de .context.rendered_name, o nome que o provedor helm dá aos recursos do componente, seguido de um sufixo que um local carrega; um local não pode ler o nome renderizado, então o volume e o artefato juntam cada um as duas partes, e o nome que o volume monta é o nome que o artefato escreve.
Uma origem e artefatos
Uma Recipe pode renderizar um chart obtido e adicionar arquivos próprios ao lado dele. Aqui, core/datastore/mariadb do catálogo é realizado pelo chart de um fabricante, e um artefato adiciona um ServiceMonitor do Prometheus:
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: 30sO chart rotula os seus recursos com o nome de release que o build lhe dá, então o seletor é construído a partir de .context.rendered_name; um construído a partir de .context.instance_id não corresponderia a nada para um componente cujo nome contenha um sublinhado ou uma maiúscula. A chave de um artefato é o nome do seu arquivo de saída, usado como está escrito, e o build é interrompido se o chart também renderizar um arquivo com esse nome.
Um Workload mantido em um arquivo próprio
workload: e uma entrada artifacts: podem cada um importar um arquivo em vez de conter o texto inline:
spec: workload: $import: ./workload/workload.yaml artifacts: networkpolicy: $import: ./artifacts/networkpolicy.yamlO arquivo de Workload importado é processado como template com o mesmo contexto que um inline. Um arquivo que uma entrada artifacts: importa é fixado antes que um build o leia: aggrega pin <recipe-dir>/recipe.yaml escreve um entity.lock ao lado da Recipe registrando o digest do arquivo, e um build é interrompido, nomeando esse comando, enquanto o lock não registrar nenhum pin para o arquivo ou o arquivo não corresponder mais a ele. Importação de uma biblioteca de Workload — um corpo de Workload compartilhado via $import constrói uma Recipe cujo Workload é importado.