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

Konvensi penamaan

Bab ini membahas aturan penamaan dan huruf besar-kecil yang berlaku untuk konten Aggrega yang ditulis: pola untuk nama instans yang ditulis pengguna, disiplin huruf besar-kecil untuk nama field dalam DSL, gaya huruf yang digunakan platform untuk pengidentifikasi yang didefinisikannya sendiri, bukan oleh Anda, dan sintaks komentar yang digunakan pada permukaan penulisan YAML.

Nama instans

Nama instans yang ditulis pengguna — kunci yang ditulis pengembang untuk komponen, fitur, agregat, subsistem, batas, serta socket dan alias uses — semuanya mengikuti satu pola: ^[a-zA-Z0-9_-]+$. Baik kebab-case (pii-filter, my-agent) maupun snake_case (openai_key, db_credentials) valid; tim dapat mengadopsi konvensi mana pun yang mereka sukai.

Karakter yang diizinkan: alfanumerik (a-z, A-Z, 0-9), tanda hubung (-), dan garis bawah (_). Tidak ada karakter lain yang diizinkan.

Contoh:

components:
web-server: # kebab-case
finance_worker: # snake_case
features:
pii-filter: # kebab-case
audit_logger: # snake_case
openai_key: # snake_case — natural for a credential attachment
db-password: # kebab-case — also valid
PolaCakupanContoh
^[a-zA-Z0-9_-]+$Semua nama instans yang ditulis penggunaweb-server, openai_key, pii-filter

Pola ini ditegakkan saat resolusi melalui patternProperties JSON Schema.

Berapa biaya nama komponen, dan mengapa huruf kapital lebih mahal pada beberapa target

Pola di atas menyatakan apa yang boleh Anda tulis. Berapa biaya sebuah nama adalah pertanyaan terpisah, dan jawabannya berbeda menurut target tempat sebuah komponen di-deploy — jadi sebaiknya Anda mengetahuinya sebelum memilih nama, bukan saat sebuah build menolaknya.

Nama komponen menjadi identitas yang dicapkan pada setiap sumber daya yang dihasilkannya, dan setiap target menurunkan namanya sendiri dari identitas tersebut: penginstal chart menurunkan nama release, orkestrator kontainer menurunkan nama service. Target yang alfabetnya lebih sempit daripada pola tidak dapat memuat karakter yang tidak diizinkannya, dan Aggrega tidak akan diam-diam mengubah karakter semacam itu menjadi karakter yang mirip — dua nama yang dapat dibedakan oleh penulis tidak boleh menjadi satu nama di dalam kluster. Karena itu, karakter yang tidak diizinkan target ditulis sebagai escape, dan escape lebih panjang daripada karakter yang digantikannya.

Konsekuensi praktisnya: huruf kapital gratis pada beberapa target dan mahal pada target lain.

  • Pada target yang namanya mengizinkan huruf kapital — misalnya file compose untuk orkestrasi kontainer — PaymentsAPI dibawa persis seperti yang Anda tulis dan memakan sebelas karakter.
  • Pada target yang namanya hanya boleh huruf kecil — nama release dari penginstal chart — setiap huruf kapital di-escape, dan nama yang terdiri dari enam huruf kapital saja sudah melampaui batas yang diterima target tersebut.

Ada efek kedua, dan efek inilah yang lebih tajam: escape dimulai dengan tanda hubung. Target yang mengharuskan nama diawali huruf kecil atau angka karenanya akan menolak nama yang karakter pertama-nya tidak diizinkan olehnya, sependek apa pun sisanya — tidak ada pemendekan yang dapat mengatasinya.

Panduannya mengikuti dari kedua efek tersebut. Utamakan huruf kecil dan angka, dengan tanda hubung di antara kata, dan awali nama dengan huruf kecil. payments-api dibawa tanpa perubahan oleh setiap target yang provider-nya disertakan Aggrega. payments_api dibawa oleh file compose tetapi tidak oleh target helm, yang nama sumber dayanya tidak mengizinkan garis bawah: Service, workload, dan release yang dinamainya menurut komponen dieja payments-zuapi. PaymentsAPI bahkan lebih mahal di sana. Recipe yang memublikasikan alamat sumber daya semacam itu membaca ejaan milik target itu sendiri alih-alih menebaknya — lihat templates/rendered-resource-names.md.

Angka di awal sah untuk ditulis dan tidak memakan biaya pada file compose, tetapi target helm menolaknya. Nama Service Kubernetes harus diawali huruf, dan Service yang dihasilkan oleh chart atau workload hasil sintesis dinamai menurut komponennya, sehingga komponen bernama 1cache menghentikan build helm — penolakannya menyebut komponen tersebut dan menyatakan bahwa nama Service harus diawali huruf — alih-alih merender Service yang akan ditolak kluster.

Semua ini bukan aturan yang diterapkan compiler atas kehendaknya sendiri — compiler tidak menyimpan aturan penamaan target mana pun dan tidak mengarang batas apa pun. Provider dari setiap target bertanggung jawab atas namanya sendiri, sehingga sebuah nama hanya ditolak ketika target tempat komponen benar-benar di-deploy menyatakan tidak dapat menggunakannya, dan penolakan itu membawa alasan milik target tersebut serta menunjuk ke kunci spec.components yang Anda tulis. Nama yang diterima pada satu target dan ditolak pada target lain adalah perilaku yang diharapkan, bukan inkonsistensi.

Nama yang disusun Aggrega sendiri — misalnya identitas fitur yang dilampirkan pada sebuah batas — diperlakukan sebaliknya: nama tersebut dipendekkan agar sesuai dengan target alih-alih ditolak, karena dirangkai dari bagian-bagian yang ditulis di beberapa tempat dan tidak ada satu penulis pun yang dapat melihat panjang yang dicapainya. Hanya nama yang Anda tulis yang ditolak.

Titik sebagai pemisah jalur yang dicadangkan

Karakter titik (.) dikecualikan dari semua nama instans yang ditulis pengguna. Titik memiliki fungsi struktural sebagai pemisah jalur yang dihasilkan compiler untuk referensi komponen lintas agregat.

Ketika Aggregate akar mengimpor subagregat bernama data-layer yang berisi komponen bernama main-db, compiler membangun ID absolut yang diratakan data-layer.main-db dengan menggabungkan nama instans agregat dan nama instans komponen menggunakan titik. Jalur bertitik ini muncul di:

  • Target uses pengembang: target: data-layer.public_db — mereferensikan komponen yang diekspor dari agregat bersarang.
  • Diagnostik build itu sendiri: penghentian atau peringatan tentang komponen tersebut menyebutnya dengan jalur bertitiknya, sehingga nama yang Anda baca adalah nama yang dapat Anda cari di dokumen Anda.

Pemisah tidak sampai ke nama

Jalur bertitik adalah alamat di dalam dokumen Anda, dan bukan nama yang akan diterima target deployment. Nama Service Kubernetes sama sekali tidak mengizinkan titik; lebih buruk lagi, titik di dalam alamat kluster adalah pemisah antara service dan namespace tempatnya berada, sehingga nama bertitik yang diberikan kepada konsumen sebagai host akan diresolusikan ke service yang berbeda alih-alih gagal.

Karena itu pemisah tersebut dituliskan ulang di setiap nama dan label yang diturunkan build dari identitas komponen, dan dituliskan ulang alih-alih diganti: data-layer.main-db menjadi data-layer-zdmain-db. Menggantinya dengan karakter yang diterima target akan memungkinkan dua komponen berbeda berakhir pada satu nama — data-layer.main-db dan komponen yang ditulis seseorang sebagai data-layer-main-db — dan nama yang dicapai dua komponen tidak mengidentifikasi satu pun dari keduanya.

Apa yang terjangkau olehnya, dan apa yang tidak:

  • Ini menjangkau nama dan label yang diturunkan dari identitas — metadata.name pada sumber daya yang disintesis Aggrega, label aggrega.ai/component-id dan app.kubernetes.io/name, selektor yang mencocokkannya, nama file yang dihasilkan, {{ .context.instance_id }}, dan nama yang diturunkan provider untuk dirinya sendiri, seperti nama release helm. Semuanya berubah bersama, sehingga alamat yang disusun Recipe dari kunci yang menamai sumber daya — .context.instance_id jika target menamainya menurut identitas, .context.rendered_name jika target melaporkan namanya sendiri — tetap menamai sumber daya yang dihasilkan build.
  • Ini tidak menjangkau nama yang Anda tulis. Nama komponen yang tidak memuat pemisah kembali sama persis byte demi byte, sehingga hanya komponen yang disumbangkan Aggregate yang diimpor yang dieja berbeda di output dibandingkan di dokumen.
  • Ini tidak menjangkau nama di dalam chart atau fragmen yang disediakan penulis. Nama-nama itu milik siapa pun yang menulisnya, dan nama yang dibawa dari chart pihak ketiga — nama custom resource berbentuk <plural>.<group>, tempat titik sah digunakan — dihasilkan persis seperti yang ditulis chart tersebut.

🔴 Poin terakhir itu berdampak pada apa yang seharusnya dipublikasikan Recipe, dan inilah hal yang paling mudah keliru di halaman ini. Template milik chart yang disediakan menamai sumber dayanya menurut identitas yang diberikan platform kepadanya — sebuah nama release, yang ditulis dalam alfabet milik platform itu sendiri, bukan alfabet yang dijelaskan di atas — dan target helm menamai workload yang disintesisnya menurut nama release yang sama. Jadi, untuk output yang dirender dari sumber yang Anda sediakan, dan untuk workload yang disintesis pada target semacam itu, {{ .context.instance_id }} bukan nama yang disandang sumber daya tersebut, dan alamat yang dipublikasikan darinya tidak menamai apa pun setiap kali kedua alfabet berbeda. Kunci yang membawa nama platform, dan provider mana yang melaporkannya, dijelaskan di templates/rendered-resource-names.md.

Menuliskan ulang pemisah memakan karakter, dan nama yang panjangnya dibatasi bisa kehabisan karakter. Pemisah diganti dengan escape pendek alih-alih satu karakter, sehingga identitas yang memenuhi syarat sedikit lebih panjang saat dituliskan dibandingkan saat dibaca di dokumen Anda. Hal itu hanya penting jika nama yang dihasilkannya dibatasi panjangnya: target yang merender komponen menyatakan seberapa panjang nilai label yang akan diterimanya, dan jika identitas yang dituliskan akan melampauinya, build berhenti alih-alih menghasilkan nilai yang akan ditolak target. Penghentian itu menyebutkan panjang yang harus dipenuhi identitas itu sendiri — panjang sebelum dituliskan ulang, sehingga nama yang dipilih dalam batas itu langsung berhasil pada percobaan pertama — dan perbaikannya adalah memendekkan bagian-bagian yang ditulis penulis: nama yang diberikan dokumen pengimpor kepada subagregat, atau nama komponen itu sendiri di dalamnya.

Pemisah adalah alasan umum sebuah nama ditulis lebih panjang daripada yang terbaca, tetapi bukan satu-satunya. Dua bentuk yang secara sah dapat diambil oleh nama yang ditulis penulis juga tidak dapat dibawa apa adanya, karena membiarkannya akan membuat escape menjadi ambigu: nama yang diakhiri tanda hubung, dan nama yang tanda hubungnya langsung diikuti z. Masing-masing dituliskan ulang dengan cara yang sama, dengan biaya yang sama. Setiap nama lain yang ditulis penulis kembali sama persis byte demi byte, sehingga nama yang tersusun dari huruf, angka, garis bawah, dan tanda hubung di antara kata sama sekali tidak terpengaruh oleh semua ini.

Nama socket di blok uses milik komponen sendiri cocok dengan kunci di usesSchema milik entitas katalog — socket yang dideklarasikan — atau menamai socket ad-hoc milik pengembang sendiri, yang tetap dapat di-build bahkan pada entitas yang sama sekali tidak mendeklarasikan usesSchema; nama yang hanya berjarak satu suntingan dari socket yang dideklarasikan memunculkan peringatan yang menyebutkan kedua ejaan. uses per edge milik Release, dan pengaturan serupa pada lampiran Feature, hanya boleh menamai socket yang dideklarasikan entitas, dan nama lain apa pun gagal dengan galat validasi unknown-uses-socket.

Penulisan huruf nama field

DSL memisahkan YAML untuk pengembang (ditulis oleh manusia) dari kontrak internal compiler (dikonsumsi oleh template dan perkakas):

  • YAML untuk pengembang (camelCase): Nama field multikata dalam skema Aggregate, Release, Component, Feature, Recipe, FeatureRecipe, Manifest, dan Plugin menggunakan camelCase. Contoh: exportedComponents, syncWave, subDirectory, featuresSchema, usesSchema, valuesMapping, injectMapping, executionScope, appliesTo, appliesToAnyOf, conflictsWith. Mengikuti konvensi API Kubernetes.
  • Kontrak internal (snake_case): Nama field multikata dalam skema IR Graph dan skema Template Context menggunakan snake_case. Contoh yang terlihat oleh pengguna dan dijumpai penulis Recipe: instance_id (dalam .context.instance_id — identitas Recipe), inject_raw (dalam .inject_raw, pilar tingkat atas di samping .inject alih-alih kunci di bawah .context — kontrak injeksi yang tidak dimutasi), attachment_name (dalam konteks FeatureRecipe lampiran — mengidentifikasi slot yang diisi lampiran, atau nama yang digunakan saat ia dilampirkan). Mengikuti konvensi JSON API dan selaras dengan pembuatan tag struct JSON di Go.
  • Field satu kata: Huruf kecil apa pun konteksnya. Contoh: values, infra, inject, provides, locals, features, labels, annotations, boundaries, components, subsystems, pipeline, source.

Pengembang tidak menjumpai snake_case dalam YAML yang mereka tulis, dan penulis template tidak menjumpai camelCase dalam template Go mereka. Penambahan skema mengikuti konvensi ini.

Tiga gaya penulisan huruf yang bersilangan dalam satu pernyataan

Penulisan Recipe secara rutin menyilangkan ketiga konvensi penulisan huruf dalam satu pernyataan: field DSL yang didefinisikan skema menggunakan camelCase, nama instans yang ditulis pengguna menggunakan kebab-case atau snake_case, dan referensi konteks template menggunakan snake_case. Penulis yang menyadari persilangan ini sebagai konvensi yang terpisah membaca YAML yang dihasilkan dengan lancar; penulis yang mencoba merasionalisasi gaya penulisan tersebut sebagai satu konvensi kesulitan dengan batas-batasnya.

Contoh kanonis: template valuesMapping: milik Recipe yang mereferensikan instans Component yang dirender melalui konteks template.

# Recipe authored against a Component the developer instantiated as "web-server"
# (kebab-case instance name) in their Aggregate.
spec:
valuesMapping: | # camelCase — schema-defined DSL field
name: "{{ .context.instance_id }}" # snake_case — template context
# internal contract
image: "{{ .values.image }}" # snake_case — template context
# internal contract

Tiga gaya penulisan huruf, satu pernyataan:

  • valuesMapping — camelCase. Nama field DSL yang didefinisikan skema untuk template pemetaan milik Recipe. Camel karena YAML bahasa ini yang ditujukan untuk pengembang mengikuti konvensi API Kubernetes.
  • web-server (direferensikan secara tidak langsung melalui komponen yang dirender) — kebab-case. Nama instans yang ditulis pengguna di dalam Aggregate; pengembang memilih bentuk dengan tanda hubung. Bisa juga web_server (snake_case); keduanya valid menurut pola nama instans.
  • instance_id, image — snake_case. Nama field di dalam konteks template (.context.instance_id, .values.image). Snake karena IR Graph dan konteks template mengikuti konvensi JSON-API dan selaras dengan pembuatan tag struct JSON di Go.

Ketiga gaya penulisan huruf ini tidak dapat dipertukarkan. Penulis Recipe yang menulis {{ .context.instanceId }} (camelCase) menghentikan build: .context mendeklarasikan kuncinya, dan instanceId bukan salah satunya, sehingga referensi itu ditolak sebelum apa pun dirender dan diagnostiknya mencantumkan kunci yang memang didefinisikan .context — lihat errors/fatal-halts.md “Template references a root the render context does not define (Template mereferensikan akar yang tidak didefinisikan konteks render)”. Pengembang yang menulis web.server (dengan titik) terkena penolakan pola nama instans karena titik dicadangkan sebagai pemisah jalur. Sasaran disiplinnya: ingat ketiga konvensi saat membaca atau menulis; andalkan batas-batasnya (di mana Anda berada dalam YAML atau template) untuk mengetahui gaya penulisan mana yang berlaku.

Pengidentifikasi yang didefinisikan platform

Semua yang di atas mengatur nama pada permukaan penulisan — nama instans yang Anda pilih, field skema yang didefinisikan bahasa untuk Anda isi, kunci konteks template yang Anda baca. Dua register lain mengatur pengidentifikasi yang didefinisikan oleh platform itu sendiri dan hanya Anda baca kembali atau ketik. Keduanya terpisah karena menjalankan tugas yang berbeda, dan tugas itulah yang menentukan bentuknya.

Register deskriptif: kebab-case, secara seragam. Pengidentifikasi di sini menyatakan dengan kata-kata apa yang dinamainya, sehingga Anda dapat membacanya dan bertindak berdasarkan itu tanpa mencari apa pun. Flag CLI, id aturan lint publikasi, kode kelas diagnostik, dan kode tempat kondisi penghentian didaftarkan semuanya termasuk di dalamnya.

--no-unsupported-field-warnings # a CLI flag you type
category-matches-directory # a lint rule id, printed in `aggrega lint` output
unsupported-field # a diagnostic class code
artifact-provenance-skipped # another
parameter-contract-violation # the code a halting condition is registered under

Jika suatu kelas diagnostik memiliki flag penekan, kode dan flag tersebut terdiri dari kata yang sama dalam urutan yang sama — unsupported-field dibungkam oleh --no-unsupported-field-warnings — sehingga kelas yang Anda cocokkan memberi tahu flag yang perlu digunakan, tanpa ada yang perlu diterjemahkan. Kode kelas adalah nama stabil yang dicocokkan perkakas untuk mengenali sebuah temuan tanpa mengurai teks pesannya; kata-kata pesan dapat diperbaiki, kodenya tidak berubah.

Register kode pendek: huruf E dan empat digit. Kondisi penghentian juga membawa kode pendek — E0007 — dan itulah satu-satunya pengidentifikasi yang didefinisikan platform yang tidak berbentuk kebab-case. Alasannya adalah posisi: kode ini membuka setiap diagnostik penghentian, di samping kategori, sebelum file dan baris yang akan Anda baca.

[DEVELOPER_ERROR E0007] aggregate.yaml at .spec.components.edge

Kode deskriptif tidak dapat ditempatkan di sana. Kode yang terpanjang saja akan memenuhi terminal yang sempit, sebelum lokasi yang memberi tahu Anda ke mana harus melihat. Jadi bagian awal itu memakai pengidentifikasi yang dipilih berdasarkan lebarnya, dan kompromi ini disengaja: empat digit tidak menyatakan apa pun tentang suatu kondisi, itulah sebabnya setiap kode pendek dipublikasikan di samping kondisi yang dinamainya dan teks yang ditampilkan kondisi itu dalam referensi sentinel galat. Kutip kode pendek dalam laporan, ketikkan dalam pencarian, dan temukan penjelasannya di sana.

Kedua register menamai kondisi yang sama dari dua arah, dan tidak ada yang menggantikan yang lain. Cocokkan kode deskriptif saat Anda menulis perkakas yang bergantung pada suatu kondisi; kutip kode pendek saat Anda membicarakan suatu kondisi dengan seseorang.

Kebab-case yang muncul di sini dan dalam nama instans bukanlah tabrakan. Pola nama instans berkaitan dengan apa yang boleh Anda tulis — di sana kebab-case dan snake_case sama-sama valid, dan tim memilih salah satunya. Register ini berkaitan dengan apa yang ditulis oleh platform, yang di dalamnya tidak ada yang perlu dipilih: Anda tidak pernah memilih ejaan id aturan lint, dan platform tidak pernah memilih ejaan nama komponen Anda.

Ini tidak mengubah gaya penulisan huruf field. Field skema yang ditulis penulis tetap camelCase dan kunci konteks template tetap snake_case. Tidak ada pengidentifikasi dalam register ini yang merupakan field pada salah satu permukaan tersebut — semuanya adalah nama pendek dan stabil untuk flag, aturan, atau kelas temuan — sehingga kode diagnostik yang berbentuk kebab-case tidak menyatakan apa pun tentang cara field skema dieja.

Disiplin akhiran penamaan jalur dokumen

Sebagian field di seluruh bahasa ini membawa nilai jalur dokumen — string yang menunjuk ke posisi di dalam dokumen lain (bagian volumes dari Workload yang dirender, entri featuresSchema dari Component, tingkat mappings dari Manifest). Nilai-nilai tersebut mengikuti sintaksis RFC 6901 JSON Pointer — token yang dipisahkan garis miring yang mengidentifikasi jalur melalui dokumen target.

RFC 6901 adalah tata bahasa jalur dasar untuk setiap permukaan jalur dokumen di Aggrega. Kontrak plugin Wasm mengonsumsi dokumen JSON Patch RFC 6902 yang jalurnya berupa pointer RFC 6901 (sesuai output JSONPatch peran label-transform dalam plugins/plugin-contract.md); inventaris format-string tata bahasa URI menyebut RFC 6901 bersama sintaksis template Go dan helper Sprig (sesuai vocabulary/uri-grammar.md “Format-string inventory”); ekspor .locals per Recipe menggunakan RFC 6901 untuk menunjuk ke posisi Workload hasil sintesis yang diterima plugin Wasm Injector dalam pipeline plugin melalui payload with dari langkahnya. Satu tata bahasa, beberapa permukaan yang mengonsumsinya.

Disiplin akhiran penamaan membedakan dua sisi penulisan nilai jalur ini melalui pembagian akhiran yang disengaja, selaras dengan bagian penulisan huruf nama field yang lebih luas di atas:

  • Field skema yang membawa JSON Pointer RFC 6901 menggunakan akhiran camelCase *Path. Field tersebut merupakan bagian dari skema YAML untuk pengembang, sehingga mengikuti konvensi camelCase. Tidak ada skema entitas yang mendeklarasikan field seperti itu; jalur dokumen yang ditulis penulis adalah kunci ekspor .locals di bawah.
  • Kunci ekspor .locals yang membawa JSON Pointer RFC 6901 menggunakan akhiran snake_case *_path. Kunci tersebut merupakan bagian dari permukaan ekspor internal Recipe — dibaca oleh template Recipe itu sendiri yang berikutnya, dan oleh pipeline plugin Wasm melalui payload pipeline[].with yang mereferensikan .locals — sehingga mengikuti konvensi snake_case. Contoh:
    • volumes_path — .locals.volumes_path: "/spec/template/spec/volumes" mengekspos posisi array volumes dari Workload hasil sintesis.
    • containers_path — .locals.containers_path: "/spec/template/spec/containers" mengekspos posisi array containers.
    • resource_path — .locals.resource_path: "/resource/aws_s3_bucket/main" mengekspos jalur sumber daya asli Terraform.
    • root_path — .locals.root_path: "/data" mengekspos jalur akar yang dikonsumsi pipe renderer.

Kedua konvensi akhiran mencerminkan konvensi dua tingkat pada bagian penulisan huruf nama field: field yang didefinisikan skema menggunakan camelCase; pengidentifikasi yang ditulis pengguna atau yang privat bagi Recipe menggunakan snake_case (atau kebab-case). Disiplin akhiran *Path / *_path membuat sifat tata bahasa jalur dari nilai terlihat pada tingkat pengidentifikasi — pembaca yang melihat salah satu akhiran tahu bahwa nilainya mengikuti sintaksis RFC 6901 tanpa harus memeriksa nilai itu sendiri.

Contoh lengkap: Wasm Injector yang mengonsumsi ekspor *_path milik Recipe.

# Recipe (Domain 3) — declares .locals exports the Wasm Injector consumes
spec:
locals:
primary_compute: "worker-container"
containers_path: "/spec/template/spec/containers"
volumes_path: "/spec/template/spec/volumes"
# Credential FeatureRecipe (Domain 3) — attached to the component the Recipe
# above realizes. Its templates read `.locals`: an attachment sees the host
# Recipe's resolved locals merged with the attachment's own block.
spec:
pipeline:
- id: workload_injector
plugin: pipeline-step/k8s-workload-injector:2.0.0
function: inject_secret
with: |
target_container: "{{ .locals.primary_compute }}"
containers_path: "{{ .locals.containers_path }}"
volumes_path: "{{ .locals.volumes_path }}"

Kunci *_path adalah ekspor yang privat bagi Recipe; nilai containers_path / volumes_path adalah string JSON Pointer RFC 6901. Plugin Injector mengonsumsi string tersebut untuk memosisikan output JSONPatch-nya terhadap AST Workload yang dirender. Attachment menjangkaunya pada pilar .locals-nya sendiri — tidak ada field .context.uses[].locals, sehingga konsumen tidak dapat membaca locals milik targetnya melalui edge uses; yang melintasi edge adalah provides milik target.

Untuk inventaris format-string yang lebih luas (sintaksis template Go, fungsi Sprig, JSON Pointer bersama regex SemVer dan tata bahasa selektor label), lihat vocabulary/uri-grammar.md “Format-string inventory”. Untuk permukaan kontrak plugin Wasm yang mengonsumsi patch RFC 6902 yang dialamatkan dengan pointer RFC 6901, lihat plugins/plugin-contract.md.

Sintaksis komentar

Karakter komentar bergantung pada bahasa di sekitarnya:

  • Konteks YAML (permukaan penulisan bawaan untuk setiap entitas Aggrega): gunakan #
  • Konteks template Go (di dalam skalar blok valuesMapping: milik Recipe, skalar blok injectMapping: milik FeatureRecipe, entri pemetaan MappingLibrary, isi assertions: dari blok asersi): gunakan {{/* ... */}} untuk komentar template yang dikenali dan dihapus mesin template saat render, atau # untuk komentar tingkat YAML di luar isi template.

Skema bentuk ringkas di bawah schema:, usesSchema:, featuresSchema:, dan parameters: sepenuhnya berupa YAML; anotasi description: per field adalah permukaan yang terdokumentasi untuk dokumentasi field secara inline (port: { type: integer, description: "TCP listen port" }).