Ikhtisar referensi entitas
Kosakata penulisan Aggrega terdiri dari Aggregate, Component, Feature, Recipe, FeatureRecipe, Plugin, Manifest, Release, SchemaLibrary, MappingLibrary, WorkloadLibrary, dan ArtifactLibrary — ditambah jenis Workload milik platform yang tertanam di dalam input hasil sintesis milik Recipe. Setiap entitas adalah dokumen YAML yang sesuai dengan JSON Schema; setiap field, kata kunci, dan referensi lintas entitas yang dijelaskan Referensi ini merupakan bagian dari kontrak penulisan tersebut.
Kumpulan bab ini mencakup permukaan penulisan: field mana yang diterima setiap entitas, apa arti setiap field bagi penulis, bagaimana field berinteraksi lintas entitas (implements: milik Recipe yang menyebutkan Component yang diimplementasikannya, penunjuk manifest: milik Release ke Manifest, containers.<name>.attachments milik Workload yang mereferensikan slot yang dideklarasikan dalam featuresSchema milik Component). Peran konseptual setiap entitas — mengapa taksonominya berbentuk seperti itu, domain mana yang memiliki entitas mana, bagaimana Empat Domain memisahkan urusan penulisan — dijelaskan di ../architecture/04-entity-taxonomy.md. Peran arsitektural jenis Workload sebagai salah satu dari tiga jenis input Recipe dijelaskan di ../architecture/16-recipe-input-composition.md.
Cara referensi ini disusun
Dua permukaan mendokumentasikan kosakata penulisan, dan keduanya menjawab pertanyaan yang berbeda.
Setiap jenis yang tercantum di atas memiliki referensi skema yang dihasilkan. Halaman-halaman tersebut dihasilkan dari skema yang dipublikasikan compiler itu sendiri, dan schema/README.md mengindeks kumpulan lengkapnya — jenis entitas, bentuk wire plugin, dan file workspace sekaligus. Gunakan referensi skema untuk menjawab “apa yang boleh dimuat dokumen ini”: setiap field, tipenya, apakah wajib, dan batasan yang ditegakkan envelope.
Halaman-halaman di bawah adalah panduan penulisan. Panduan ini ditulis secara manual untuk mengajarkan apa yang tidak dapat diajarkan skema: untuk apa suatu jenis, bagaimana field-nya berinteraksi dengan jenis lain, bentuk penulisan mana yang cocok untuk situasi mana, dan konvensi yang diikuti katalog pustaka standar. Gunakan panduan penulisan untuk menjawab “bagaimana cara menulisnya, dan mengapa bentuknya seperti ini”.
Referensi per entitas
- Aggregate — artefak niat deklaratif milik pengembang. Mendeklarasikan komponen, topologinya melalui
uses, kontrak parameter untuk variasi per lingkungan, dan attachment Feature. - Component — entitas katalog yang ditulis Platform Architect yang mendefinisikan jenis komponen yang dapat digunakan ulang. Mendeklarasikan skema
valuesdaninfra-nya (masing-masing berupa deklarasi JSON Schema 2020-12 dalam bentuk ringkas atau lengkap), kontrak outputprovides, kontrak edge masukusesSchema, dan slot kredensial melaluifeaturesSchema. - Feature — entitas katalog yang ditulis Platform Architect untuk urusan lintas bidang (sidecar pemantauan, penyamaran data, kebijakan routing). Mendeklarasikan skema
valuesdaninfra-nya (masing-masing berupa deklarasi JSON Schema 2020-12), selektor attachmentappliesTo, dan batasan interoperabilitas. - Recipe — terjemahan yang ditulis Ops dari Component ke provider tertentu. Menyusun tiga jenis input (
source:+valuesMapping:,workload:,artifacts:— masing-masing menerima konten inline atau$import:sesuai kosakata impor file terpadu) ditambah blokprovidesyang membentuk kontrak injeksi ke pemanggil. - FeatureRecipe — terjemahan yang ditulis Ops dari Feature ke provider tertentu. Menggunakan kontrak tiga jenis input yang sama dengan Recipe ditambah
injectMappingyang mencegat pipe inject untuk penulisan ulang variabel di sisi pemanggil. - Plugin — plugin WebAssembly yang dialamatkan berdasarkan konten. Mendeklarasikan satu tipe socket yang diimplementasikannya —
provider,linter,pipeline-step,governance,cli,parser, atauimporter— versi ABI-nya, dan kapabilitas yang dilayani tipe socket tersebut. Plugin perender provider (pluginType: provider) mendeklarasikan nama provider yang dilayaninya dispec.provider.capabilitiesdan membawa metadata socket provider-nya —workloadSchemadanwellKnownAnnotations— di blokspec.provideryang sama. - Manifest — tabel pemetaan per proyek. Mengikat tipe abstrak Component dan Feature ke URI Recipe dan FeatureRecipe yang konkret, di bawah
componentsdanfeatures, dengan urutan pencarianname>typeberversi >typetanpa versi. - Release — router deployment per lingkungan. Mengikat Aggregate ke Manifest, memetakan komponen ke batas fisik, menyediakan nilai parameter per lingkungan, dan melampirkan Features yang dikelola Ops.
Entitas pustaka
Empat jenis pustaka berada di Tingkat 3 — entitas penggunaan ulang yang bersifat opsional. Katalog mendeklarasikan salah satunya ketika konten yang sama berulang di seluruh entitasnya, dan tidak menyertakannya jika tidak. Masing-masing memuat satu jenis konten, dan fragmen dalam referensi (#/schemas/, #/mappings/, #/workloads/, #/artifacts/) menyatakan pustaka mana yang dituju sebuah referensi.
- SchemaLibrary — definisi JSON Schema 2020-12 yang dapat digunakan ulang ditambah helper berparameter opsional, direferensikan dari skema Component atau Feature dengan
$ref: <Library>#/schemas/<name>. - MappingLibrary — fragmen template Go yang dapat digunakan ulang, diimpor ke
valuesMapping:milik Recipe atau FeatureRecipe dengan$import: <Library>#/mappings/<name>. - WorkloadLibrary — konten Workload yang dapat digunakan ulang, diimpor ke
workload:milik Recipe atau FeatureRecipe dengan$import: <Library>#/workloads/<name>. - ArtifactLibrary — bundel file output tambahan yang dapat digunakan ulang, diimpor ke
artifacts:milik Recipe atau FeatureRecipe dengan$import: <Library>#/artifacts/<name>. Bundel adalah unit penggunaan ulang: satu impor diperluas menjadi satu output per file dalam bundel.
Jenis milik platform
- Workload — jenis compiler milik platform (bukan entitas katalog yang ditulis pengguna). Tertanam di dalam field
workload:milik Recipe (inline atau melalui$import:); menjelaskan bentuk deployment yang disintesis provider menjadi manifest asli provider.