コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

Recipe の入力の種類

このページでは 1 つの考え方、つまり Recipe がレンダリングの元にする 3 つの入力と、それらがどのように積み重なるかを説明します。このページは実行可能なワークスペースではありません。MariaDB + Adminer — 実行可能なデュアルターゲットの例 は、合成された Recipe、取得したチャート、およびその横に置かれたアーティファクトによって 1 つのコンポーネントを実現します。次のコマンドで自分のフォルダーに書き出してください:

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 には 3 つの入力があり、それらを任意に組み合わせて使用します:

  • Workload(workload:)、つまりコンテナ、ポート、ボリューム、サービスについてのビルド独自の記述で、プロバイダーがターゲットのリソースに合成するもの — Kubernetes では Deployment と Service、Docker Compose ではサービス;
  • ソース(source:)、つまりプロバイダーがレンダリングするチャート、モジュール、またはテンプレートで、Recipe の valuesMapping から値が供給されるもの;
  • アーティファクト(artifacts:)、つまり Recipe がテンプレート処理の後にそのまま書き出すファイルで、他の 2 つが生成するものの横に置かれるもの。

3 つがどのように合成されるかは 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 が参照するファイルを追加します。ConfigMap をマウントする 2 つ目のコンテナを持つ Workload と、アーティファクトとしての 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 を読み取ります。コンテナのポートは、Workload がどの形式で書いたかにかかわらず、その番号を port の下に持つオブジェクトとしてアーティファクトに届きます。ConfigMap の名前は、.context.rendered_name(helm プロバイダーがコンポーネントのリソースに付ける名前)に、local が持つサフィックスを続けたものです。local はレンダリングされた名前を読み取れないため、ボリュームとアーティファクトがそれぞれ両者を結合し、ボリュームがマウントする名前はアーティファクトが書き出す名前と一致します。

ソースとアーティファクト

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 ファイルは、インラインの Workload と同じコンテキストでテンプレート処理されます。artifacts: エントリがインポートするファイルは、ビルドが読み取る前に固定されます。aggrega pin <recipe-dir>/recipe.yaml は、Recipe の隣にファイルのダイジェストを記録した entity.lock を書き出し、ロックにそのファイルの固定値が記録されていない間、またはファイルがそれと一致しなくなった間は、ビルドはこのコマンドを示して停止します。Workload ライブラリのインポート — $import による共有 Workload 本体 は、Workload がインポートされる Recipe をビルドします。