跳转到内容
AggregaAggrega
选择语言: 简体中文
本页面由机器翻译。阅读英文原文。

Recipe 输入类型

本页解释一个概念,即 Recipe 进行渲染所依据的三种输入以及它们如何叠加,它不是一个可运行的工作区。MariaDB + Adminer——一个可运行的双目标示例用一个合成的 Recipe、一个获取的 chart 以及它们旁边的制品实现一个组件;用以下命令将其写入你自己的文件夹:

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:),即构建自身对容器、端口、卷和服务的描述,提供方会将其合成为目标的资源——在 Kubernetes 上是一个 Deployment 和一个 Service,在 Docker Compose 上是一个服务;
  • 一个源(source:),即提供方渲染的 chart、模块或模板,由 Recipe 的 valuesMapping 提供数据;
  • 制品(artifacts:),即 Recipe 在模板处理后原样写出的文件,与另外两种输入的产物并列放置。

三者如何组合,见 Recipe 输入组合;Workload 自身的接口见 entities/workload.md,每个模板读取的上下文——.values、.infra、.context、.locals、.features——见 vocabulary/data-pillars.md。

下面的 Recipes 实现了一个由工作区自行声明的 Component,即 local/compute/api-server,其 values 中包含 image 和 port,其 infra 中包含 replicas,其发布的内容中包含 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,而不是重复其值:无论 Workload 以哪种形式书写容器端口,该端口都会以一个对象的形式到达制品,端口号位于 port 下。ConfigMap 的名称由 .context.rendered_name——helm 提供方为该组件的资源所起的名称——加上一个 local 携带的后缀组成;local 无法读取渲染后的名称,因此卷和制品各自将两者拼接,卷挂载的名称就是制品写出的名称。

源与制品

Recipe 可以渲染一个获取的 chart,并在其旁边添加自己的文件。这里,目录中的 core/datastore/mariadb 由一个厂商的 chart 实现,并由一个制品添加 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 用构建为其指定的 release 名称为其资源打标签,因此选择器基于 .context.rendered_name 构建;对于名称中含下划线或大写字母的组件,基于 .context.instance_id 构建的选择器将匹配不到任何资源。制品的键就是其输出文件名,按原样使用,如果 chart 也渲染出同名文件,构建会中止。

将 Workload 保存在单独的文件中

workload: 和 artifacts: 条目都可以导入一个文件,而不是以内联方式包含文本:

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

导入的 Workload 文件与内联的 Workload 使用相同的上下文进行模板渲染。artifacts: 条目导入的文件在构建读取之前会被固定:aggrega pin <recipe-dir>/recipe.yaml 会在 Recipe 旁写出一个 entity.lock,记录该文件的摘要;只要锁文件没有记录该文件的固定值,或者该文件与其不再匹配,构建就会停止并指出这条命令。Workload 库导入——通过 $import 共享的 Workload 主体 构建了一个其 Workload 为导入所得的 Recipe。