Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema Aggrega Infrastructure Base (FeatureRecipe)

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

Id skema: https://aggrega.ai/schemas/featurerecipe-v1beta1.schema.json

Definisi yang ditulis oleh tim Ops yang memetakan Feature katalog yang abstrak ke implementasi konkret dan berversi untuk satu kapabilitas provider. Secara ketat 1:1 dengan provider fisik dan fitur katalog.

Lihat referensi penulisan FeatureRecipe untuk panduan prosa tentang penulisan entitas FeatureRecipe; halaman ini mendokumentasikan skema struktural yang dijelaskan oleh referensi tersebut.

Jenis tingkat teratas: object

Properti

PropertiJenisWajibDeskripsi
apiVersionconst “aggrega.ai/v1beta1”yaKonstanta: "aggrega.ai/v1beta1"
kindconst “FeatureRecipe”yaKonstanta: "FeatureRecipe"
metadataobjectya
specobjectyaPengikatan kapabilitas provider, pemetaan, pipeline, dan pemetaan inject untuk sebuah FeatureRecipe. Membawa tiga jenis input yang sama seperti sebuah Recipe (sourced, synthesized, artifacts) ditambah injectMapping yang khusus untuk FeatureRecipe; FeatureRecipe yang murni berupa pengkabelan dan hanya mendeklarasikan capability serta implements adalah valid dan tidak merender apa pun.

Properti tambahan tidak diizinkan.

featurerecipe.metadata

PropertiJenisWajibDeskripsi
namestringyaPanjang minimal 1 karakter.
versionstringyaSemantic Versioning ketat dari FeatureRecipe (misalnya, 1.2.5). 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-]+)*))?$.
descriptionstringtidakApa 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.
maintainersobject[]tidakDaftar pemelihara yang memiliki entitas ini.
licensestringtidakPengidentifikasi 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.
repositorystringtidakURL ke repositori Git tempat berkas sumber berada.
homestringtidakURL halaman beranda, wiki, atau dokumentasi entitas ini.
keywordsstring[]tidakDaftar kata kunci deskriptif untuk kemudahan penemuan di UI.

Properti tambahan tidak diizinkan.

featurerecipe.metadata.maintainers[]
PropertiJenisWajibDeskripsi
namestringya
emailstringtidak
urlstringtidak

Properti tambahan tidak diizinkan.

featurerecipe.spec

Pengikatan kapabilitas provider, pemetaan, pipeline, dan pemetaan inject untuk sebuah FeatureRecipe. Membawa tiga jenis input yang sama seperti sebuah Recipe (sourced, synthesized, artifacts) ditambah injectMapping yang khusus untuk FeatureRecipe; FeatureRecipe yang murni berupa pengkabelan dan hanya mendeklarasikan capability serta implements adalah valid dan tidak merender apa pun.

PropertiJenisWajibDeskripsi
capabilitystringyaKapabilitas provider eksplisit yang diikat oleh recipe ini (misalnya, ‘helm’, ‘terraform’, ‘compose’) — jenis provider yang merendernya.
implementsstringyaMendeklarasikan jenis Feature katalog mana yang dapat diimplementasikan oleh recipe ini (termasuk Features kredensial berlabel feature.aggrega.ai/kind: secret; versi persis, rentang yang kompatibel secara mayor ’^’, atau tanpa versi). Compiler menggunakannya untuk memverifikasi pemetaan Manifest dan untuk menyarankan kandidat dalam diagnostik dan pelengkapan editor; compiler tidak pernah menggunakannya untuk me-resolve build. Pemetaan Manifest adalah pilihan implementasi eksplisit pengguna, yang dipatok dalam lockfile milik Release.
localsmap of stringtidakPrivate Ops State. Hasil komputasi internal yang hanya tersedia di dalam template FeatureRecipe ini sebagai ‘.locals.*’. Setiap entri itu sendiri adalah template Go, yang dievaluasi terhadap konteks mandiri: ‘.context.instance_id’ (HOST COMPONENT yang sedang di-resolve oleh attachment ini, yang merupakan makna referensi tersebut di setiap permukaan template), ‘.attachment_name’ (instans attachment yang sedang di-resolve, dan satu-satunya jalur menuju nama tersebut dari sebuah local), ‘.values’ dan ‘.infra’ milik attachment itu sendiri, serta entri-entri 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, dengan menerima nilai saudara tersebut 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.’ ke entri yang didefinisikan blok ini KEMUDIAN akan menghentikan build dengan menyebutkan kesalahan urutan; referensi yang menyebutkan kunci yang sama sekali tidak dideklarasikan blok akan menghentikan build dengan menyebutkan kunci tersebut. Kedua pemeriksaan membaca path yang menjadi hasil RESOLVE referensi, bukan ketikannya, sehingga keduanya sama-sama mencakup bentuk langsung, pembacaan di dalam blok ’{{ with .locals }}’, pembacaan melalui variabel yang terikat langsung ke ‘.locals’, dan kunci yang dibaca dari blok dalam tanda kurung, ‘(.locals).’ atau ’($.locals).’. Ada satu penulisan yang tidak dicakup: referensi yang path-nya tidak ditentukan oleh teks template — yang dicapai melalui fungsi, seperti ‘index .locals’ atau ‘(default dict .locals).’, atau melalui blok ‘with’ atau pengikatan variabel yang pipeline-nya menerapkan fungsi, karena hasil pipeline semacam itu ditentukan saat evaluasi, bukan oleh teksnya. Penulisan ini tidak dianalisis, dan kunci yang tidak ada yang dicapai dengan cara itu tidak menghentikan build: kunci tersebut merender teks literal '', bukan kosong sama sekali. Satu-satunya pengecualian adalah ‘index’ itu sendiri: di setiap permukaan template, fungsi ini menghentikan build dengan menyebutkan kunci, ketika map yang dibacanya tidak memuat kunci yang diminta, sehingga kunci yang tidak ada yang dicapai melalui ‘index .locals’ akan menghentikan build. Locals FeatureRecipe ini di-resolve SEBELUM provides-nya, sehingga template provides dapat membaca ‘.locals’ dan menerima nilai yang telah di-resolve, sedangkan template provides yang menyebutkan kunci yang tidak dideklarasikan blok ini akan menghentikan build. Aturannya sama dengan yang diikuti blok locals sebuah Recipe. Jika executionScope adalah boundary, blok ini dievaluasi sekali untuk attachment boundary, terhadap konteks template lingkup boundary alih-alih konteks sebuah komponen, dan setiap komponen yang dijangkau attachment membaca entri-entri yang telah di-resolve tersebut, termasuk ‘.locals’ yang dibaca oleh injectMapping-nya. Digunakan untuk mengekspor realitas fisik (misalnya, container target, path JSON) bagi plugin Wasm di hilir. Tidak pernah diekspos ke pemanggil — gunakan provides untuk API publik.
providesmap of stringtidakAPI Developer Publik. Variabel keluaran kontraktual yang tersedia untuk resolusi inject oleh Caller di hilir. Jika executionScope adalah boundary, provides dievaluasi sekali untuk attachment boundary, terhadap konteks template lingkup boundary, dan setiap komponen yang dijangkau attachment membaca satu evaluasi itu di ‘.features..provides’, demikian pula koneksi yang dibawa attachment; kontrak provides yang dideklarasikan Feature yang diimplementasikan diperiksa sekali, pada evaluasi itu, dengan menyebutkan attachment boundary tersebut.
sourcestring atau objecttidakPath opsional ke kode infrastruktur. Menerima string URI atau objek terstruktur terbuka. Jika diberikan bersama valuesMapping, compiler merendernya, dan dokumen yang dirender bergabung ke keluaran FeatureRecipe sebelum langkah-langkah pipeline-nya dijalankan.
valuesMappingstring atau objecttidakKonten pemetaan values dengan tiga mode penulisan melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): skalar string template Go yang menghasilkan format values yang diharapkan provider. Mode 2 (impor file): map YAML dengan tepat satu kunci, $import: ./relative/path.tmpl, yang menunjuk ke file template Go lokal. Mode 3 (impor library): map YAML dengan tepat satu kunci, $import: <Library>#/mappings/<entry>, yang mereferensikan 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.
workloadstring atau objecttidakPenghasil YAML Workload dengan tiga mode penulisan melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): skalar string template Go yang output-nya di-parse sebagai ‘aggrega.ai/v1beta1 Workload’. Mode 2 (impor file): map YAML dengan tepat satu kunci, $import: ./relative/path.yaml, yang menunjuk ke file template Go lokal. Mode 3 (impor library): map YAML dengan tepat satu kunci, $import: <Library>#/workloads/<entry>, yang mereferensikan entri WorkloadLibrary berdasarkan identitas nama polos (versinya disediakan oleh lockfile per Release; tidak ada host registry yang muncul dalam referensi). Provider target harus mendukung sintesis workload; katalog pustaka standar mendeklarasikan workloadSchema pada provider semacam itu sebagai kontrak yang terdokumentasi. FeatureRecipe dengan workload: yang diikat ke provider yang tidak dapat melakukan sintesis akan berhenti secara eksplisit saat waktu render. Workload FeatureRecipe yang disintesis mengeluarkan manifest native provider-nya di bawah direktori output fitur tersebut. Dalam bentuk objek, $import tidak boleh cocok dengan ^oci://; nilai yang cocok akan ditolak.
artifactsmap dari string atau objecttidakPeta 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): peta YAML dengan tepat satu kunci, $import: ./relative/path.yaml, yang menunjuk ke file templat Go lokal. Mode 3 (impor pustaka): peta YAML dengan tepat satu kunci, $import: <Library>#/artifacts/<entry>, yang merujuk ke bundel ArtifactLibrary berdasarkan identitas nama polos (versinya disediakan oleh lockfile per Release; tidak ada host registri yang muncul dalam rujukan). 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 tertulis, 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. Sumber daya tambahan yang dihasilkan oleh FeatureRecipe penghasil sumber daya (ConfigMap, ServiceMonitor, NetworkPolicy, CRD ExternalSecret, dll.) berbentuk artefak; artifacts: adalah mekanisme utama pembuatan sumber daya. 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 dapat dipakai 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). / akan membuat sebuah kunci menamai jalur alih-alih file, dan . di awal akan mengizinkan .., 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._-]*$.
omitsobject[]tidakApa yang dikecualikan dari hasil render source FeatureRecipe ini — untuk source yang diambil apa adanya yang merender sesuatu yang tidak boleh dikirimkan 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 sumber daya yang dideklarasikan oleh templat CloudFormation yang diambil. Sebagian besar FeatureRecipes tidak pernah memerlukannya. Setiap entri menamai satu unit yang dirender oleh source berdasarkan jenisnya, namanya, dan, jika entri memberikannya, namespace-nya serta subchart asalnya, masing-masing dalam kosakata provider yang merender source tersebut — untuk chart, dokumen berdasarkan kind dan metadata.name-nya sendiri; untuk file compose, service, volume, atau config berdasarkan kuncinya di bawah services:, volumes:, atau configs:; untuk templat CloudFormation, sumber daya berdasarkan Type dan ID logisnya. Provider tersebut mengecualikan setiap unit yang cocok dengan sebuah entri, dan apa yang dicocokkan oleh entri, serta apa yang ditolak provider karena entri tersebut, adalah kontrak terdokumentasi milik provider itu sendiri. Provider yang tidak dapat mengecualikan apa pun menolak FeatureRecipe yang mendeklarasikan kunci ini sebelum apa pun dirender. Hanya hasil render source: yang difilter — entri workload: atau artifacts: tidak pernah — sehingga kunci ini memerlukan source. Setiap nilai adalah templat, 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. Kunci ini ditulis secara identik pada Recipe dan pada FeatureRecipe. Setidaknya 1 entri.
injectMappingstringtidakTemplat Go inline opsional yang dievaluasi selama fase Pre-Render Interception, sekali untuk setiap komponen yang dijangkau lampiran, terhadap konteks templat komponen tersebut: templat ini membaca ‘.context’ dan ‘.features’ milik komponen serta ‘.attachment_name’, ‘.values’, ‘.infra’, dan ‘.locals’ milik lampiran, apa pun nilai executionScope, dan rujukan ke ‘.boundary’, yang tidak dibawa oleh konteks komponen mana pun, menghentikan build. Menghasilkan kamus JSON/YAML yang secara native di-deep-merge oleh compiler Go di atas pipa memori ‘.context.inject’ milik Caller. Digunakan untuk mutasi di sisi Caller tanpa Wasm terhadap variabel lingkungan dan kontrak pengiriman.
pipelineobject[]tidakDaftar berurutan langkah pipeline Wasm yang dijalankan setelah render atas himpunan dokumen yang dirender, masing-masing mengembalikan patch RFC 6902 dan efek samping.
executionScopestring (enum)tidakApakah Resource Generation FeatureRecipe ini berjalan per komponen (default) atau sekali per lampiran boundary. FeatureRecipes dengan cakupan boundary melakukan deduplikasi berdasarkan (boundary_path, instans FeatureRecipe) dan setiap templat kecuali injectMapping membaca konteks templat cakupan boundary: pilar .boundary.* alih-alih pilar .context.* per komponen, yang jika dirujuk akan menghentikan build. injectMapping berjalan sekali untuk setiap komponen yang dijangkau lampiran terlepas dari executionScope, sehingga membaca konteks komponen tersebut dan tidak pernah membaca .boundary. Nilai yang diizinkan: "component", "boundary" Default: "component"
readsCallerRenderFactsbooleantidakMendeklarasikan bahwa templat FeatureRecipe ini membaca hasil render Components yang terhubung ke Component tempat FeatureRecipe ini dilampirkan: fakta render yang dilaporkan provider masing-masing pemanggil tersebut tentang keluarannya sendiri. Jika bernilai true dan FeatureRecipe dirender per komponen, setiap lampirannya dirender setelah setiap Component dalam build selesai dirender, alih-alih tepat setelah Component tempat ia dilampirkan, sehingga render setiap pemanggil sudah lengkap sebelum lampiran dievaluasi. Jika bernilai false atau tidak ada, tidak ada entri pemanggil pada ‘.context.used_by’ yang membawa fakta render, lampiran dirender tepat setelah Component-nya kecuali readsTargetRenderFacts bernilai true, dan build berhenti pada templat yang ditulis inline di FeatureRecipe ini yang membaca fakta render pemanggil di bawah ‘.context.used_by’. Default: false
readsTargetRenderFactsbooleantidakMendeklarasikan bahwa templat FeatureRecipe ini membaca hasil render Components yang dihubungkan dengan Component tempat FeatureRecipe ini dilampirkan: fakta render yang dilaporkan provider masing-masing target tersebut tentang keluarannya sendiri, pada setiap entri ‘.context.uses’. Jika bernilai true dan FeatureRecipe dirender per komponen, setiap lampirannya dirender setelah setiap Component dalam build selesai dirender, alih-alih tepat setelah Component tempat ia dilampirkan, sehingga render setiap target sudah lengkap sebelum lampiran dievaluasi. Ini adalah render tertunda yang sama dengan yang disebabkan readsCallerRenderFacts, sehingga menetapkan salah satu kunci, atau keduanya, membuat lampiran dirender pada saat itu. Jika bernilai false atau tidak ada, tidak ada entri pada ‘.context.uses’ yang membawa fakta render, lampiran dirender tepat setelah Component-nya kecuali readsCallerRenderFacts bernilai true, dan build berhenti pada templat yang ditulis inline di FeatureRecipe ini yang membaca fakta render target di bawah ‘.context.uses’. Default: false
assertionsmap of stringtidakValidasi lintas bidang saat build. Setiap entri adalah asersi bernama: kuncinya adalah pengenal aturan yang stabil yang ditampilkan dalam pesan galat; nilainya adalah string templat Go dengan semantik penghentian {{ fail "message" }}. Beberapa asersi bernama per entitas dievaluasi per instans sesuai urutan yang dideklarasikan penulis; asersi pertama yang gagal menghentikan build. Asersi FeatureRecipe dievaluasi setelah pengikatan recipe dan setelah provides dievaluasi, sebelum render, dan menyatakan invarian implementasi dari chart atau modul spesifik yang menjadi source FeatureRecipe. Konteks templat: .values / .infra / .uses / .features / .metadata ditambah .provides / .locals / .recipe. Evaluator menggunakan missingkey=error: rujukan ke kunci yang tidak terdefinisi berhenti dengan diagnostik no-such-key. Karena rujukan polos berhenti sebelum fallback apa pun dapat berjalan, default biasa tidak menyediakan fallback untuk bidang opsional pada permukaan ini — lindungi rujukan dengan hasKey, atau gunakan helper optional, yang melakukan pemeriksaan keberadaan secara langsung. Membaca kunci melalui index juga tidak menyediakannya: index berhenti pada kunci peta yang tidak dimiliki peta tersebut, dengan menyebut kuncinya.

Properti tambahan tidak diizinkan.

featurerecipe.spec.omits[]
PropertiJenisWajibDeskripsi
kindstringyaJenis 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.
namestringyaNama 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.
namespacestringtidakNamespace 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.
subchartstringtidakSubchart 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.
whenstringtidakTemplat 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.

featurerecipe.spec.pipeline[]
PropertiJenisWajibDeskripsi
idstringyaPengenal 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_]+$.
pluginstringyaReferensi 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.
functionstringyaFungsi Wasm yang diekspor untuk dipanggil.
withstringtidakTemplat Go inline yang dievaluasi menjadi map JSON/YAML yang secara ketat memenuhi skema masukan eksplisit plugin ini.
optionalbooleantidakJika 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.
whenstringtidakTemplat 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.