Skema Aggrega Infrastructure Base (Recipe)
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/recipe-v1beta1.schema.json
Lapisan penunjuk dan pemetaan yang ditulis oleh tim Ops, yang menghubungkan intensi Dev dengan penyedia infrastruktur tertentu. Secara ketat 1:1 dengan satu penyedia fisik dan satu komponen katalog.
Lihat referensi penulisan Recipe untuk panduan prosa tentang penulisan entitas Recipe; halaman ini mendokumentasikan skema struktural yang dijelaskan oleh referensi tersebut.
Jenis tingkat teratas: object
Properti
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | ya | Konstanta: "aggrega.ai/v1beta1" |
kind | const “Recipe” | ya | Konstanta: "Recipe" |
metadata | object | ya | |
spec | object | ya | Pengikatan provider, sumber, pemetaan nilai, dan pipeline untuk sebuah Recipe. Mendukung tiga jenis masukan yang digabungkan secara penjumlahan: sourced (source ditambah overlay valuesMapping), synthesized (workload), dan artifacts (berkas keluaran bernama). Terpisah dari itu, sebuah Recipe dapat menyumbangkan berkas ke keluaran bersama dari boundary tempat ia dirender, di bawah ‘boundary’. |
Properti tambahan tidak diizinkan.
recipe.metadata
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | Panjang minimal 1 karakter. |
version | string | ya | Semantic Versioning ketat dari recipe implementasi (misalnya, 2.1.0). Pola: ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$. |
description | string | tidak | Apa entitas ini dan untuk apa, ditulis bagi orang yang sedang memutuskan apakah akan menggunakannya. Awali dengan kalimat yang menyebut hal tersebut, lalu tambahkan apa yang dibutuhkan pembaca untuk memilihnya dan menggunakannya dengan benar — apa yang diharapkannya dari Release yang men-deploy-nya, dan apa pun yang mengejutkan tentang perilakunya. Panjang yang lazim adalah satu paragraf pendek. |
maintainers | object[] | tidak | Daftar pemelihara yang memiliki entitas ini. |
license | string | tidak | Pengidentifikasi SPDX untuk lisensi perangkat lunak yang dideskripsikan entitas ini, seperti MIT atau AGPL-3.0. Pengidentifikasi ini mencatat ketentuan perangkat lunak tersebut, bukan ketentuan berkas ini. |
repository | string | tidak | URL ke repositori Git tempat berkas sumber berada. |
home | string | tidak | URL halaman beranda, wiki, atau dokumentasi entitas ini. |
keywords | string[] | tidak | Daftar kata kunci deskriptif untuk kemudahan penemuan di UI. |
Properti tambahan tidak diizinkan.
recipe.metadata.maintainers[]
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | |
email | string | tidak | |
url | string | tidak |
Properti tambahan tidak diizinkan.
recipe.spec
Pengikatan provider, sumber, pemetaan nilai, dan pipeline untuk sebuah Recipe. Mendukung tiga jenis masukan yang digabungkan secara penjumlahan: sourced (source ditambah overlay valuesMapping), synthesized (workload), dan artifacts (berkas keluaran bernama). Terpisah dari itu, sebuah Recipe dapat menyumbangkan berkas ke keluaran bersama dari boundary tempat ia dirender, di bawah ‘boundary’.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
capability | string | ya | Kapabilitas provider eksplisit yang diikat oleh recipe ini (misalnya, ‘helm’, ‘terraform’, ‘compose’) — jenis provider yang merendernya. Menerima pin versi opsional, dalam tiga bentuk yang sama seperti ‘implements’: tanpa versi (‘helm’), persis (‘helm:1.0.0’), atau rentang kompatibel mayor (‘helm:^1.0.0’). Nama polos memilih jenis provider; pin, bila ada, memilih versi plugin perender provider yang melayani kapabilitas tersebut yang merender recipe ini — versi tertinggi yang tersedia bila tanpa pin, versi persis untuk pin persis, dan versi tertinggi dalam rentang untuk caret. Pin yang tidak dipenuhi oleh versi plugin mana pun yang melayani akan menghentikan build secara tegas. Segala sesuatu di hilir pemilihan provider — pengelompokan keluaran, segmen path, kompatibilitas pipeline, dan pilihan codec — berpatokan pada kapabilitas polos, sehingga dua recipe yang mem-pin versi plugin berbeda dari kapabilitas yang sama dapat hidup berdampingan dalam satu build. |
implements | string | ya | Menyatakan jenis komponen katalog mana yang dapat diimplementasikan oleh recipe ini (versi persis ‘core/api-server:1.0.0’, rentang kompatibel mayor ‘core/api-server:^1.0.0’, atau tanpa versi ‘core/api-server’). Compiler menggunakannya untuk memverifikasi pemetaan Manifest dan untuk menyarankan kandidat dalam diagnostik dan pelengkapan editor; compiler tidak pernah menggunakannya untuk me-resolve build. aggrega lint juga membacanya, untuk menemukan Component yang kontrak provides yang dideklarasikannya menjadi pembanding bagi kunci yang dipublikasikan sebuah Recipe. Pemetaan Manifest adalah pilihan implementasi eksplisit pengguna, yang di-pin dalam lockfile milik Release. |
source | string atau object | tidak | Lokasi kode infrastruktur. Menerima string URI, atau objek terstruktur terbuka yang kunci-kuncinya ditentukan provider dan diekspos ke template Recipe sebagai ‘.source.*’. |
locals | map of string | tidak | Private Ops State. Hasil komputasi internal yang tersedia di dalam template Recipe ini sebagai ‘.locals.*’. Setiap entri itu sendiri adalah template Go, yang dievaluasi terhadap konteks lokal node yang mandiri: ‘.context.instance_id’, ‘.values’, ‘.infra’, dan entri-entri dari blok yang sama ini yang telah di-resolve sejauh ini. Entri di-resolve sesuai urutan penulisannya, dan sebuah entri BOLEH membaca entri saudara yang didefinisikan DI ATASNYA, dan menerima nilai saudara yang telah di-resolve, bukan teks templatenya. Urutan penulisan merupakan bagian dari kontrak di mana pun satu entri membaca entri lain: memindahkan definisi ke bawah pembacanya akan merusak build, dan blok tidak pernah diurutkan ulang agar sebuah referensi dapat di-resolve. Referensi ‘.locals. |
provides | map dari string atau number atau boolean | tidak | Public Developer API. Variabel keluaran kontraktual yang tersedia untuk resolusi inject Caller di hilir. Compiler mengevaluasi template provides terhadap konteks yang mandiri, dalam urutan apa pun di antara sesamanya — tidak ada entri provides yang membaca entri lain. Locals node di-resolve dalam pembukaan locals, sebelum provides-nya, sehingga template provides dapat membaca ‘.locals’ dan menerima nilai yang telah di-resolve; menyebut kunci yang tidak dideklarasikan blok locals akan berhenti. Pemanggil me-resolve kunci inject terhadap nilai-nilai ini saat hidrasi inject. Nilainya berupa skalar — pipa membawanya apa adanya dan mengubahnya menjadi string secara deterministik pada batas injeksi. |
valuesMapping | string atau object | tidak | Konten pemetaan nilai dengan tiga mode penulisan melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): skalar string template Go (biasanya YAML block-scalar |) yang menghasilkan format nilai yang diharapkan provider dari konteks Aggrega (.values, .features, .infra). Mode 2 (impor berkas): map YAML dengan tepat satu kunci, $import: ./relative/path.tmpl, yang menunjuk ke berkas template Go lokal. Mode 3 (impor pustaka): map YAML dengan tepat satu kunci, $import: <Library>#/mappings/<entry>, yang merujuk entri MappingLibrary berdasarkan identitas nama polos (versinya disediakan oleh lockfile per Release; tidak ada host registry yang muncul dalam referensi). Dalam bentuk objek, $import tidak boleh cocok dengan ^oci://; nilai yang cocok akan ditolak. |
workload | string atau object | tidak | Penghasil YAML Workload dengan tiga mode penulisan melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): skalar string templat Go yang keluarannya diurai sebagai ‘aggrega.ai/v1beta1 Workload’. Mode 2 (impor file): map YAML dengan tepat satu kunci, $import: ./relative/path.yaml, yang menunjuk ke file templat Go lokal. Mode 3 (impor pustaka): map YAML dengan tepat satu kunci, $import: <Library>#/workloads/<entry>, yang merujuk entri WorkloadLibrary berdasarkan identitas nama polos (versi disediakan oleh lockfile per Release; tidak ada host registri yang muncul dalam referensi). Provider target harus mendukung sintesis workload; katalog pustaka standar mendeklarasikan workloadSchema pada provider semacam itu sebagai kontrak yang didokumentasikan. Recipe workload: yang terikat pada provider yang tidak dapat melakukan sintesis akan berhenti secara mencolok pada waktu render. Dalam bentuk objek, $import tidak boleh cocok dengan ^oci://; nilai yang cocok akan ditolak. |
artifacts | map dari string atau object | tidak | Map dari nama entri ke penulisan konten artefak. Nilai setiap entri membawa salah satu dari tiga mode melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): skalar string templat Go yang keluarannya adalah isi artefak. Mode 2 (impor file): map YAML dengan tepat satu kunci, $import: ./relative/path.yaml, yang menunjuk ke file templat Go lokal. Mode 3 (impor pustaka): map YAML dengan tepat satu kunci, $import: <Library>#/artifacts/<entry>, yang merujuk bundel ArtifactLibrary berdasarkan identitas nama polos (versi disediakan oleh lockfile per Release; tidak ada host registri yang muncul dalam referensi). Sebuah bundel diperluas menjadi satu keluaran per file, masing-masing bersarang di bawah kunci entri sebagai <key>/<filename>. Kunci menamai keluaran entri: kunci entri mode 1 atau mode 2 adalah nama file keluarannya, digunakan sebagaimana ditulis, dan file yang diimpor oleh entri mode 2 menyediakan konten tanpa menamai keluaran, sehingga dua entri yang mengimpor file berbeda dengan nama yang sama adalah dua keluaran yang berbeda. Tabrakan antara entri artefak, file bundel, keluaran source, dan sintesis workload menghentikan build saat node dirender. Blok artifacts ditulis secara identik pada Recipe dan pada FeatureRecipe — tiga mode yang sama, aturan kunci-ke-keluaran yang sama, dan perilaku tabrakan yang sama — itulah sebabnya bagian deskripsi ini sama pada kedua jenis; contoh yang ditulis untuk salah satunya berlaku untuk yang lain tanpa perubahan. Dalam bentuk objek, $import tidak boleh cocok dengan ^oci://; nilai yang cocok akan ditolak. Kunci: Kunci menamai keluaran entri, sehingga dibatasi pada satu nama file: diawali huruf atau angka dan dilanjutkan dengan huruf, angka, titik, tanda hubung, atau garis bawah. Titik setelah karakter pertama mempertahankan ekstensi yang dibawa kunci artefak (main.tf, template.yaml, serviceaccount.yaml). Sebuah / akan membuat satu kunci menamai path alih-alih file, dan . di awal akan memungkinkan .., yang menamai lokasi di luar direktori keluaran — kelas karakter pertama menolak keduanya. Untuk impor pustaka, kunci menamai direktori tempat file bundel bersarang, sehingga batas yang sama berlaku. Pola: ^[A-Za-z0-9][A-Za-z0-9._-]*$. |
omits | object[] | tidak | Apa yang dikecualikan dari hasil render source Recipe ini — untuk source yang diambil apa adanya dan merender sesuatu yang tidak boleh dikirim oleh Release: dokumen yang dirender oleh chart yang diambil, seperti Secret yang menyimpan kunci yang dibuat ulang oleh chart pada setiap render, service, volume, atau config yang dibundel oleh file compose yang diambil, atau resource yang dideklarasikan oleh templat CloudFormation yang diambil. Sebagian besar Recipes tidak pernah membutuhkannya. Setiap entri menamai satu unit yang dirender source berdasarkan jenisnya, namanya, dan, bila entri memberikannya, namespace-nya serta subchart asalnya, masing-masing dalam kosakata provider yang merender source — untuk chart, dokumen berdasarkan kind dan metadata.name miliknya; untuk file compose, service, volume, atau config berdasarkan kuncinya di bawah services:, volumes:, atau configs:; untuk templat CloudFormation, resource berdasarkan Type dan ID logisnya. Provider tersebut mengecualikan setiap unit yang cocok dengan entri, dan apa yang dicocokkan oleh entri, serta apa yang ditolak provider karena suatu entri, merupakan kontrak terdokumentasi milik provider itu sendiri. Provider yang tidak dapat mengecualikan apa pun menolak Recipe yang mendeklarasikan kunci ini sebelum apa pun dirender. Hanya hasil render source: yang difilter — entri workload: atau artifacts: tidak pernah difilter — sehingga kunci ini memerlukan source. Setiap nilai adalah templat, yang dievaluasi terhadap konteks yang sama dengan konteks evaluasi valuesMapping. when sebuah entri dievaluasi terlebih dahulu, dan entri yang when-nya merender nilai falsy akan dibuang. Setiap entri yang tetap aktif harus mengecualikan sesuatu: entri aktif yang tidak cocok dengan apa pun yang dirender source menghentikan build, dengan menyebut entri tersebut. Source tetap dirender secara penuh — setiap templat chart tetap dijalankan, sehingga templat yang gagal tetap menggagalkan build — dan hanya keluarannya yang dikecualikan. Minimal 1 entri. |
boundary | object | tidak | Apa yang dikontribusikan Recipe ini ke keluaran bersama dari boundary tempat ia dirender, alih-alih ke keluaran komponennya sendiri. Sebagian besar Recipes tidak pernah membutuhkannya: ini untuk file yang dibaca target satu kali untuk seluruh boundary — misalnya konfigurasi provider Terraform, yang hanya diterima Terraform di konfigurasi root suatu boundary dan tidak pernah di dalam modul satu komponen. Sebuah provider hanya menerima file semacam itu jika kontraknya mendeklarasikan boundaryArtifacts, dan Recipe yang mendeklarasikan blok ini untuk provider yang tidak mendeklarasikannya akan ditolak sebelum apa pun dirender. FeatureRecipe tidak membawa blok semacam itu. |
outputLabels | map of string | tidak | Label yang dideklarasikan oleh penulis Recipe, dicap pada setiap objek yang dihasilkan oleh output render resep ini, lalu diterjemahkan oleh provider ke permukaan label masing-masing provider (metadata.labels Kubernetes untuk sintesis helm, source-render, dan artifacts; label layanan Compose; tag per sumber daya pada badan artefak .tf.json Terraform). Label ini menempuh jalur yang sama dengan label provenans tetap, tetapi dimiliki oleh penulis, bukan oleh kompiler. Namespace aggrega.ai/ dan app.kubernetes.io/ dicadangkan untuk provenans bawaan platform dan ditolak saat pemuatan. Kunci atau nilai yang bukan label valid untuk provider target merupakan tanggung jawab penulis resep; inti tidak mengawasi set karakter label di luar aturan namespace yang dicadangkan. |
outputComponentLabels | string[] | tidak | Kunci label identitas Component yang dipromosikan resep ini ke output render-nya. Setiap entri menyebut satu kunci label; nilainya diambil dari label instans komponen yang di-render oleh resep ini, sehingga label yang dicap membawa nilai yang dideklarasikan komponen tersebut, bukan nilai yang diulang di sini. Label yang dipromosikan mencapai permukaan label yang sama dengan outputLabels, yang sebaliknya membawa pasangan kunci-nilai literal yang ditulis di tempat. Kunci yang dideklarasikan di kedua blok ditolak saat pemuatan, sehingga setiap kunci yang dicap memiliki satu sumber. Namespace aggrega.ai/ dan app.kubernetes.io/ dicadangkan untuk provenans bawaan platform dan ditolak saat pemuatan; kunci berlingkup seperti component.aggrega.ai/hosting berada di luar akar yang dicadangkan tersebut dan dapat dipromosikan. |
pipeline | object[] | tidak | Daftar berurutan langkah pipeline Wasm yang dijalankan setelah render atas himpunan dokumen yang dirender, masing-masing mengembalikan patch RFC 6902 dan efek samping. |
assertions | map of string | tidak | Validasi lintas-bidang pada waktu build. Setiap entri adalah asersi bernama: kuncinya adalah pengenal aturan yang stabil yang ditampilkan dalam pesan kesalahan; nilainya adalah string template Go dengan semantik penghentian {{ fail "message" }}. Beberapa asersi bernama per entitas dievaluasi per instans dalam urutan yang dideklarasikan penulis; asersi pertama yang gagal menghentikan build. Asersi Recipe dievaluasi setelah pengikatan recipe dan setelah provides dievaluasi, sebelum render, dan menyatakan invarian implementasi dari chart atau modul spesifik yang menjadi sumber Recipe. Konteks template: .values / .infra / .uses / .features / .metadata ditambah .provides / .locals / .recipe. Evaluator menggunakan missingkey=error: referensi ke kunci yang tidak terdefinisi berhenti dengan diagnostik no-such-key. Karena referensi polos berhenti sebelum fallback apa pun dapat berjalan, default biasa tidak menyediakan fallback bidang opsional pada permukaan ini — lindungi referensi tersebut dengan hasKey, atau gunakan helper optional, yang melakukan pemeriksaan keberadaan secara langsung. Membaca kunci melalui index juga tidak menyediakannya: index berhenti pada kunci map yang tidak dimiliki map tersebut, dengan menyebutkan kuncinya. |
Properti tambahan tidak diizinkan.
recipe.spec.omits[]
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
kind | string | ya | Jenis unit yang akan dikecualikan, dalam kosakata provider yang merender sumber: untuk chart, kind milik dokumen yang dirender, seperti Secret; untuk file compose, service, volume atau config; untuk templat CloudFormation, Type milik sebuah resource, seperti AWS::S3::Bucket. Nilai ini menyebut jenis yang dirender oleh sumber, dan tidak berkaitan dengan kind: yang dibawa oleh source: terstruktur. Sebuah templat. |
name | string | ya | Nama unit yang akan dikecualikan, dalam kosakata provider yang merender sumber: untuk chart, metadata.name milik dokumen yang dirender; untuk file compose, kunci unit tersebut di bawah services:, volumes: atau configs:; untuk templat CloudFormation, ID logis resource tersebut, yaitu kuncinya di bawah Resources. Sebuah templat. |
namespace | string | tidak | Namespace tempat unit yang akan dikecualikan berada, bila entri hanya boleh cocok dengan unit di namespace tersebut — untuk provider yang keluarannya memiliki namespace, seperti dokumen yang dirender oleh chart. Jika tidak ada, atau dirender menjadi string kosong, entri cocok dengan unit dengan jenis dan nama tersebut apa pun namespace-nya. File compose dan templat CloudFormation tidak memiliki namespace, dan provider-nya menolak entri yang menyebutkan namespace. Sebuah templat. |
subchart | string | tidak | Subchart asal unit yang dikecualikan, ketika entri hanya boleh cocok dengan salinan yang dirender oleh satu subchart — untuk source yang dirakit dari source bersarang, seperti chart yang dirakit dari subchart-nya. Untuk chart, nama subchart itu sendiri, atau alias yang diberikan dependensi induknya, dengan nama-nama subchart bersarang digabungkan dengan / dari yang terluar: operator, atau operator/webhooks. Entri kemudian cocok dengan dokumen yang dirender dari templates/ atau crds/ milik subchart tersebut, dan tidak cocok dengan dokumen yang dirender oleh chart itu sendiri maupun dokumen yang dirender oleh subchart yang bersarang di dalamnya. Jika tidak ada, atau dirender menjadi string kosong, entri cocok dengan unit sesuai jenis dan namanya dari mana pun asalnya. Chart yang tidak merender subchart dengan nama tersebut menghentikan build, dengan menyebut entri tersebut. File compose dan templat CloudFormation tidak memiliki subchart, dan provider-nya menolak entri yang menyebutkan subchart. Sebuah templat. |
when | string | tidak | Templat Go inline yang dievaluasi sebelum bidang-bidang lain pada entri. Jika templat ini merender nilai falsy, entri dibuang: bidang-bidang lainnya tidak dievaluasi, tidak ada yang dikecualikan karenanya, dan entri tidak wajib cocok. when yang kosong atau tidak ada mempertahankan entri. Penentuan nilai benar mengikuti konvensi standar untuk keluaran templat yang menyerupai boolean: string true/True/TRUE, angka bukan nol apa pun, dan string tidak kosong lainnya bernilai benar, sedangkan false/False/FALSE, string kosong, dan nol bernilai salah. when yang gagal dirender menghentikan build. |
Properti tambahan tidak diizinkan.
recipe.spec.boundary
Apa yang dikontribusikan Recipe ini ke keluaran bersama dari boundary tempat ia dirender, alih-alih ke keluaran komponennya sendiri. Sebagian besar Recipes tidak pernah membutuhkannya: ini untuk file yang dibaca target satu kali untuk seluruh boundary — misalnya konfigurasi provider Terraform, yang hanya diterima Terraform di konfigurasi root suatu boundary dan tidak pernah di dalam modul satu komponen. Sebuah provider hanya menerima file semacam itu jika kontraknya mendeklarasikan boundaryArtifacts, dan Recipe yang mendeklarasikan blok ini untuk provider yang tidak mendeklarasikannya akan ditolak sebelum apa pun dirender. FeatureRecipe tidak membawa blok semacam itu.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
artifacts | map dari string atau object | ya | Map dari nama file ke penulisan konten file, berbentuk persis seperti artifacts milik Recipe ini sendiri: tiga mode yang sama — string template Go inline, $import: dari file Go-template lokal, atau $import: dari bundel ArtifactLibrary, yang file-filenya bersarang di bawah kunci entri sebagai <key>/<filename> — aturan kunci-ke-nama-file yang sama, dan konteks template yang sama, sehingga sebuah entri dapat membaca .values, .infra, .locals dan lainnya persis seperti entri artifacts. Yang berbeda adalah tempat setiap file ditulis: sekali, di direktori yang menampung output boundary yang telah dirakit, di samping file-file yang ditulis oleh perakitan milik provider sendiri di sana, alih-alih di direktori milik komponen ini sendiri. Setiap entri dievaluasi untuk setiap komponen yang dirender Recipe ini dalam boundary, dan file-file yang dihasilkan evaluasi tersebut digabungkan berdasarkan nama: satu nama yang dievaluasi menjadi byte identik oleh beberapa komponen, atau oleh beberapa Recipes, adalah satu file, sedangkan satu nama yang dievaluasi menjadi byte berbeda menghentikan build dengan menyebutkan file tersebut dan setiap kontributornya, demikian pula nama yang sudah ditulis oleh perakitan milik provider sendiri. Tidak ada yang dicap ke dalam file semacam itu untuk menyatakan komponen mana yang menulisnya, karena file tersebut milik setiap komponen yang mendeklarasikannya. Entri yang templatenya dirender menjadi kosong tidak menulis file. Entri-entri tersebut tidak diserahkan kepada provider, yang menulis sisa output boundary tanpa membacanya. Dalam bentuk objek, $import tidak boleh cocok dengan ^oci://; nilai yang cocok akan ditolak. Kunci: Kunci menamai file, sehingga dibatasi pada satu nama file, mengikuti aturan yang berlaku untuk kunci artifacts: diawali dengan huruf atau angka dan dilanjutkan dengan huruf, angka, titik, tanda hubung, atau garis bawah. / akan membuat satu kunci menamai sebuah path alih-alih file, dan . di awal akan mengizinkan .., yang menamai lokasi di luar direktori output boundary — kelas karakter pertama menolak keduanya. Untuk impor pustaka, kunci menamai direktori tempat file-file bundel bersarang, sehingga batasan yang sama berlaku. Pola: ^[A-Za-z0-9][A-Za-z0-9._-]*$. Minimal 1 entri. |
Properti tambahan tidak diizinkan.
recipe.spec.pipeline[]
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
id | string | ya | Pengenal terprogram untuk langkah ini, unik di antara langkah-langkah pipeline ini: dokumen yang mendeklarasikan satu id pada dua langkahnya ditolak saat dibaca. Langkah berikutnya dalam pipeline yang sama membaca output langkah ini sebagai .steps.<id>.outputs. Pola: ^[a-zA-Z0-9_]+$. |
plugin | string | ya | Referensi ke entitas Plugin yang dijalankan langkah ini, selalu dibatasi oleh jenis soket milik plugin tersebut: <pluginType>/<name> dengan versi opsional, seperti parser/yaml atau parser/yaml:1.0.0. Cakupan ini wajib, bukan salah satu dari beberapa bentuk — name:version tanpa cakupan ditolak, karena dua soket dapat memuat plugin dengan nama yang sama dan cakupanlah yang membuat entitas dapat di-resolve. Build me-resolve entitas ke artefak .wasm yang dialamatkan berdasarkan konten — yang lokasinya ditentukan dari identitas plugin dan registri yang dikonfigurasi, dengan digest yang disematkan di lockfile — dan memuat byte-nya. Referensi .wasm atau artefak langsung tidak diterima di sini. |
function | string | ya | Fungsi Wasm yang diekspor untuk dipanggil. |
with | string | tidak | Templat Go inline yang dievaluasi menjadi map JSON/YAML yang secara ketat memenuhi skema masukan eksplisit plugin ini. |
optional | boolean | tidak | Jika true, kegagalan langkah ini (trap guest, patch yang menargetkan dokumen yang tidak ada dalam set, patch yang salah bentuk, atau diagnostik dengan tingkat keparahan halt) diturunkan menjadi peringatan yang jelas: set dokumen sebelum langkah dipulihkan, keluaran langkah ini dibuang, dan pipeline berlanjut. Jika false atau tidak ada, kegagalan langkah apa pun menghentikan build setelah set dokumen sebelum langkah dipulihkan. |
when | string | tidak | Templat Go inline yang dievaluasi saat penelusuran pipeline. Jika templat ini merender nilai falsy, langkah dilewati — sebagai pass-through: set dokumen mengalir ke langkah berikutnya tanpa perubahan, tanpa menyumbangkan patch, efek samping, atau catatan langkah. when yang kosong atau tidak ada selalu menjalankan langkah. Penentuan nilai benar mengikuti konvensi standar untuk keluaran templat yang menyerupai boolean: string true/True/TRUE, angka bukan nol apa pun, dan string tidak kosong lainnya bernilai benar, sedangkan false/False/FALSE, string kosong, dan nol bernilai salah. when dan optional tidak saling bergantung: sebuah langkah dapat mendeklarasikan keduanya. |
Properti tambahan tidak diizinkan.