Jenis input Recipe
Halaman ini menjelaskan satu gagasan, yaitu tiga input yang menjadi dasar Recipe merender dan cara input-input itu dijumlahkan, dan bukan ruang kerja yang dapat dijalankan. MariaDB + Adminer — contoh dua target yang dapat dijalankan merealisasikan satu komponen dengan Recipe yang disintesis, chart yang diambil, dan artefak di sampingnya; tuliskan ke folder Anda sendiri dengan:
aggrega scaffold --example mariadb-adminerKemudian ia mencetak perintah yang dijalankan berikutnya:
cd mariadb-admineraggrega pull --release release-compose.yamlaggrega build --release release-compose.yamlRecipe memiliki tiga input, dan menggunakan kombinasi apa pun dari ketiganya:
- sebuah Workload (
workload:), deskripsi milik build sendiri tentang kontainer, port, volume, dan layanan, yang disintesis provider menjadi sumber daya target — sebuah Deployment dan sebuah Service di Kubernetes, sebuah layanan di Docker Compose; - sebuah sumber (
source:), chart, modul, atau templat yang dirender provider, yang diisi olehvaluesMappingmilik Recipe; - artefak (
artifacts:), file yang ditulis Recipe apa adanya, setelah pemrosesan templat, di samping apa yang dihasilkan dua input lainnya.
Cara ketiganya dikomposisikan dijelaskan di Komposisi input Recipe; permukaan milik Workload sendiri adalah entities/workload.md, dan konteks yang dibaca setiap templat — .values, .infra, .context, .locals, .features — adalah vocabulary/data-pillars.md.
Recipes di bawah ini mengimplementasikan Component yang dideklarasikan ruang kerja untuk dirinya sendiri, local/compute/api-server, dengan image dan port di antara values-nya, replicas di antara infra-nya, serta host, port, dan protocol di antara apa yang dipublikasikannya.
Workload saja
Tanpa source: dan tanpa artifacts:, Workload menentukan seluruh output:
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 }}Untuk komponen bernama api, provider helm menulis sebuah Deployment dan sebuah ClusterIP Service. Variabel yang dikirimkan koneksi tiba di .context.inject.env dan ditulis ke dalam kontainer.
Workload dan artefak
Artefak menambahkan file yang dirujuk oleh Workload. Sebuah Workload dengan kontainer kedua yang me-mount sebuah ConfigMap, dan ConfigMap tersebut sebagai artefak:
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 }}"Artefak membaca Workload di .workload alih-alih mengulang nilai-nilainya: port kontainer sampai kepadanya sebagai objek yang menyimpan nomornya di bawah port, dalam bentuk apa pun Workload menuliskannya. ConfigMap dinamai menurut .context.rendered_name, nama yang diberikan provider helm kepada sumber daya komponen, diikuti sufiks yang dibawa oleh sebuah local; local tidak dapat membaca nama yang dirender, sehingga volume dan artefak masing-masing menggabungkan keduanya, dan nama yang di-mount oleh volume adalah nama yang ditulis oleh artefak.
Sumber dan artefak
Recipe dapat merender chart yang diambil dan menambahkan file miliknya sendiri di sampingnya. Di sini core/datastore/mariadb dari katalog direalisasikan oleh chart dari vendor, dan sebuah artefak menambahkan ServiceMonitor 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: 30sChart melabeli sumber dayanya dengan nama release yang diberikan build kepadanya, sehingga selektor dibangun dari .context.rendered_name; selektor yang dibangun dari .context.instance_id tidak akan cocok dengan apa pun untuk komponen yang namanya mengandung garis bawah atau huruf kapital. Kunci artefak adalah nama file output-nya, digunakan sebagaimana tertulis, dan build berhenti jika chart juga merender file dengan nama tersebut.
Workload yang disimpan dalam file tersendiri
workload: dan entri artifacts: masing-masing dapat mengimpor file alih-alih memuat teks secara inline:
spec: workload: $import: ./workload/workload.yaml artifacts: networkpolicy: $import: ./artifacts/networkpolicy.yamlFile Workload yang diimpor diproses sebagai templat dengan konteks yang sama seperti Workload inline. File yang diimpor oleh entri artifacts: disematkan sebelum build membacanya: aggrega pin <recipe-dir>/recipe.yaml menulis entity.lock di samping Recipe yang mencatat digest file, dan build berhenti, dengan menyebutkan perintah tersebut, selama lock tidak mencatat pin untuk file itu atau file tidak lagi cocok dengannya. Impor pustaka Workload — badan Workload bersama melalui $import membangun Recipe yang Workload-nya diimpor.