Skema Release Aggrega
Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.
Id skema: https://aggrega.ai/schemas/release-v1beta1.schema.json
Lihat referensi penulisan Release untuk panduan prosa tentang penulisan entitas Release; 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 “Release” | ya | Konstanta: "Release" |
metadata | object | ya | |
spec | object | ya | Apa yang diikat dan dirutekan oleh Release: Aggregate dan Manifest yang di-deploy-nya (atau basis extends), pemenuhan parameter khusus lingkungan, serta batas tempat komponen-komponennya dirutekan. |
Properti tambahan tidak diizinkan.
release.metadata
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | Panjang minimal 1 karakter. |
environment | string | ya | |
version | string | ya | Semantic Versioning ketat dari rilis (misalnya, 1.0.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 seseorang yang sedang memutuskan apakah akan menggunakannya. Awali dengan kalimat yang menyebutkan hal tersebut, lalu tambahkan apa yang perlu diketahui pembaca untuk memilih dan menggunakannya dengan benar — apa yang diharapkannya dari platform tempat ia di-deploy, dan apa pun yang mengejutkan tentang perilakunya. Satu paragraf pendek adalah panjang yang lazim. |
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.
release.metadata.maintainers[]
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
name | string | ya | |
email | string | tidak | |
url | string | tidak |
Properti tambahan tidak diizinkan.
release.spec
Apa yang diikat dan dirutekan oleh Release: Aggregate dan Manifest yang di-deploy-nya (atau basis extends), pemenuhan parameter khusus lingkungan, serta batas tempat komponen-komponennya dirutekan.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
aggregate | string | tidak | Referensi ke Aggregate (Developer Intent) yang di-deploy oleh rilis ini. Token polos di-resolve berdasarkan identitas — metadata.name dari Aggregate yang dirujuk, dicari di direktori milik Release itu sendiri lalu di katalog. Nilai yang diawali ’./’ atau ’../’ adalah file lokal eksplisit yang di-resolve relatif terhadap Release (misalnya ’../shared/app.yaml’ untuk berbagi satu Aggregate di antara varian rilis dalam subdirektori). |
manifest | string | tidak | Referensi ke Manifest yang me-resolve antarmuka abstrak yang menjadi sasaran deployment rilis ini. Token polos di-resolve berdasarkan identitas — metadata.name dari Manifest yang dirujuk, dicari di direktori milik Release itu sendiri. Nilai yang diawali ’./’ atau ’../’ adalah file lokal eksplisit yang di-resolve relatif terhadap Release. Manifest berada di sisi deployment dan tidak diindeks katalog, sehingga hanya di-resolve dari direktori Release atau path eksplisit. |
extends | string | tidak | Referensi ke Release basis yang permukaan penulisannya diwarisi oleh Release ini — pohon batasnya beserta lampiran infra dan Feature per komponen di bawahnya, parameternya, anotasinya, dan penunjuk Manifest-nya. Nilainya adalah path ke file di samping Release ini, diawali ’./’ atau ’../’; nama polos maupun koordinat registry sama-sama ditolak, karena Release berada di sisi deployment dan tidak diindeks katalog. Apa yang diwarisi dapat diganti kunci demi kunci, hingga nilai pertama yang tidak dapat dibagi — skalar, daftar, templat — yang diganti secara utuh; kunci yang ditulis sebagai null menghapus apa yang diwarisi. Tidak ada field metadata yang ikut terbawa, sehingga turunan membawa nama, versi, dan lingkungannya sendiri. Mendeklarasikan ‘aggregate’ bersama ‘extends’ ditolak oleh skema ini, sehingga turunan men-deploy Developer Intent yang sama dengan basisnya; ‘manifest’ tetap opsional dan dapat ditimpa untuk menukar lockfile dependensi. |
parameters | object | tidak | Kontrak pemenuhan variabel khusus lingkungan dengan dua mode penulisan melalui dispatch berdasarkan bentuk konten. Mode 1 (inline): map YAML yang langsung membawa nilai parameter bersarang yang terstruktur. Mode 2 (impor file): map YAML dengan tepat satu kunci, $import: ./relative/path.yaml, yang menunjuk ke satu file lokal yang menyediakan nilai parameter. Hanya satu sumber di lokasi ini — pelapisan multi-file adalah ranah rantai extends: Release (Release induk menyediakan parameter basis; turunan meng-extend + menimpa). |
boundaries | map dari boundary | tidak | Kotak logis akar tempat komponen-komponen Aggregate dirutekan. Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
components | map dari boundary_component | tidak | Instans komponen tingkat atas yang membawa infra operator per komponen, untuk Release lingkup tunggal tanpa batas bernama. Saling eksklusif dengan boundaries: deklarasikan components untuk Release datar atau boundaries untuk perutean multi-target, jangan keduanya. Ketika components digunakan, compiler menyintesis batas default yang menampungnya dan mengeluarkan artefaknya ke dist/ secara datar. Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
Properti tambahan tidak diizinkan.
Definisi
boundary_component
Instans komponen yang dirutekan ke dalam sebuah boundary, dengan ukuran fisik dan lampiran fitur yang opsional.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
description | string | tidak | Dokumentasi opsional yang menjelaskan peran komponen ini di boundary ini dalam Release. |
subDirectory | string | tidak | Penimpaan sub-path tingkat Component yang ditambahkan ke direktori boundary induk. Jika dihilangkan atau kosong pada boundary dan komponen sekaligus, nilai bawaannya adalah ’{{ .capability }}’; string kosong yang ditulis di sini dibaca sebagai dihilangkan. Setel ke ’.’, atau ke templat yang dievaluasi menjadi string kosong, untuk menonaktifkan pembuatan subdirektori. |
annotations | map dari string atau object atau null | tidak | Anotasi Operator khusus Component yang menimpa anotasi tingkat boundary untuk komponen ini. Digabungkan secara mendalam di atas anotasi boundary (komponen menang saat terjadi tabrakan kunci; nilai terstruktur digabungkan per subkunci dengan induk terstruktur). Nilainya berupa string, objek terstruktur, atau null. Digunakan untuk penimpaan anotasi well-known provider per komponen (mis., aggrega.ai/namespace pada provider helm). Null eksplisit pada kunci yang diwarisi dari boundary induk menghapus binding warisan dari komponen ini (opt-out Feature berbasis anotasi); komponen saudara tetap mempertahankan binding warisan tersebut. |
infra | object | tidak | Ukuran fisik yang sepenuhnya lokal untuk komponen ini (mis., replika, IOPS disk). |
features | map of object | tidak | Features yang dilampirkan ke komponen ini melalui Release. Untuk fitur yang juga dideklarasikan di Aggregate, hanya infra yang disediakan (nilai berasal dari Aggregate). Untuk fitur khusus Release (diinjeksi Operator), type wajib diisi. Kunci adalah nama instans fitur dan dapat memuat URI type fitur lengkap (titik dan garis miring diizinkan). Release TIDAK BOLEH menyediakan values untuk fitur — ini adalah domain Developer. Kunci: satu atau lebih huruf, angka, garis bawah, titik, garis miring, atau tanda hubung. Pola: ^[a-zA-Z0-9_./-]+$. |
uses | release_uses_block | tidak | Permukaan edge Operator. Di dalam socket yang dideklarasikan Architect, Release dapat menghubungkan socket yang dideklarasikan tetapi belum terikat ke komponen yang sudah ada (target) dan/atau menyediakan infra per edge. Tidak ada values (larangan values: pada Release berlaku) dan tidak ada pembuatan compute; menargetkan ulang edge yang dideklarasikan developer akan dihentikan saat build. |
Properti tambahan tidak diizinkan.
release_uses_block
Permukaan uses per edge yang ditulis di Release, dikunci per socket lalu per alias (mencerminkan bentuk topologi uses pada Aggregate). Setiap koneksi dapat menyetel target (untuk membuat edge ke socket yang dideklarasikan tetapi belum terikat, yang menunjuk ke komponen yang sudah ada), infra (konfigurasi operator per edge, divalidasi terhadap infraSchema socket ketika Release di-resolve) dan features (lampiran yang mengisi slot yang dideklarasikan socket), dalam kombinasi apa pun. values dilarang (larangan values: pada Release); menargetkan ulang edge yang dideklarasikan developer merupakan pengaman yang tegas saat build.
Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$.
Nilainya adalah map of object.
Kunci lain tidak diizinkan.
release_connection_attachment
Satu lampiran yang dibawa entri koneksi Release: Feature yang mengisi slot yang dideklarasikan socket koneksi tersebut, beserta ukuran dari operator untuknya.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
type | string | tidak | URI dari Feature. Wajib untuk lampiran yang hanya dibuat oleh Release. Harus cocok dengan type pada Aggregate jika keduanya mendeklarasikannya. |
description | string | tidak | Dokumentasi opsional yang menjelaskan mengapa Operator melampirkan fitur ini ke koneksi. |
infra | object | tidak | Ukuran operasional untuk lampiran ini, divalidasi oleh deklarasi skema Feature. |
Properti tambahan tidak diizinkan.
aggregate_routing
Merutekan komponen internal sub-modul Aggregate bersarang ke dalam boundary ini. Mencerminkan struktur component/aggregate pada boundary untuk komposisi rekursif.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
components | map dari boundary_component | tidak | Instans Component di dalam aggregate bersarang yang akan dirutekan ke boundary ini. Kuncinya adalah nama lokal yang dimiliki setiap komponen di dalam sub-modul tersebut — ‘main-db’ untuk komponen yang dialamatkan oleh map components milik boundary sendiri sebagai ‘data.main-db’ — karena hanya nama itulah yang dimilikinya di sana. Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
aggregates | map of aggregate_routing | tidak | Aggregate bersarang lebih lanjut di dalam sub-aggregate ini (untuk komposisi modul yang bersarang dalam). Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
Properti tambahan tidak diizinkan.
boundary
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
description | string | tidak | Dokumentasi opsional yang menjelaskan tujuan dan target fisik boundary ini (misalnya, ‘Primary production EKS cluster in us-east-1, PCI-DSS compliant’). |
directory | string | tidak | Jalur keluaran fisik untuk pembuatan artefak GitOps. Mendukung variabel templat Go ({{ .capability }}, {{ .boundary_name }}, {{ .parameters.X }}). Digabungkan dengan subDirectory sebagai penggabungan jalur untuk menghasilkan jalur artefak akhir. |
subDirectory | string | tidak | Sub-jalur tingkat boundary yang ditambahkan ke directory. Jika dihilangkan atau kosong pada boundary maupun component, nilai bawaannya adalah ’{{ .capability }}’ untuk partisi otomatis CI/CD; string kosong yang ditulis di sini dibaca sebagai dihilangkan. Atur ke ’.’, atau ke templat yang dievaluasi menjadi string kosong, untuk menonaktifkannya. |
syncWave | integer | tidak | Gelombang deployment opsional per boundary (bilangan bulat bertanda, bawaan 0). Setiap component dalam boundary ini mewarisi gelombang boundary ke dalam node-nya. Nilai negatif diizinkan (dijalankan sebelum yang lainnya); nilai yang lebih besar dijalankan setelah nilai yang lebih kecil. Pada K8s dan Helm, gelombanglah yang menentukan urutan deployment: gelombang menjadi anotasi argocd.argoproj.io/sync-wave, dan pada resource yang sudah ditandai chart sebagai hook Helm, gelombang juga menjadi helm.sh/hook-weight hook tersebut. Pada compose, gelombang dicatat sebagai label service sekaligus mengurutkan service dalam file tempat ia dirender, melalui depends_on di antara service tersebut — sehingga gelombang menjangkau setiap service dalam satu file itu dan tidak ada di luarnya. Pada cloudformation, gelombang mengurutkan provisioning stack tempat boundary dirakit: setiap resource dalam suatu gelombang dideklarasikan bergantung pada resource gelombang sebelumnya, yang menetapkan urutan pembuatannya dan, secara terbalik, urutan penghapusannya. Itu hanya urutan pembuatan dan penghapusan — templat stack tidak mengenal konsep resource yang siap, sehingga tidak ada yang menunggu suatu resource dapat melayani. Pada terraform, gelombang mengurutkan blok module dari konfigurasi root tempat boundary dirakit: setiap module dalam suatu gelombang dideklarasikan bergantung pada module gelombang sebelumnya, yang menetapkan urutan engine menjalankan tindakannya. Itu hanya urutan tindakan — konfigurasi tidak mengenal konsep resource yang siap, sehingga tidak ada yang menunggu suatu resource dapat melayani — dan nilainya juga dicatat bersama provenans build node. Compiler membawa nilai yang sama ke setiap node dalam boundary sebagai sync_wave node tersebut, tempat perilaku per target dijelaskan kembali dari sisi node. Boundary bertingkat tidak mewarisi secara implisit — masing-masing mendeklarasikan gelombangnya sendiri. |
annotations | map dari string atau object atau null | tidak | Anotasi Operator untuk seluruh boundary yang menurun ke bucket .context.annotations.release. Nilainya berupa string, objek terstruktur, atau null. Nilai terstruktur membawa konfigurasi per subkunci yang di-deep-merge dengan induk terstruktur (per subkunci, anak menang) dan mengalir melalui ekspansi Feature berbasis anotasi; hanya nilai skalar yang muncul dalam konteks render. Null eksplisit pada kunci yang diwarisi dari boundary induk menghapus binding yang diwarisi dari kumpulan anotasi efektif boundary ini (opt-out Feature berbasis anotasi), yang menyebar ke setiap component yang dirutekan ke boundary ini kecuali override yang lebih dalam memperkenalkan kembali binding tersebut. |
features | map of object | tidak | Feature untuk seluruh boundary yang diterapkan ke semua component bertingkat (misalnya, mesh keamanan bawaan). Blok uses suatu feature diproyeksikan ke setiap component dalam boundary, sehingga dependensi bersama dideklarasikan sekali di boundary alih-alih diulang pada setiap component. Kunci adalah nama instans feature dan dapat memuat URI jenis feature lengkap (titik dan garis miring diizinkan). Kunci: satu atau lebih huruf, angka, garis bawah, titik, garis miring, atau tanda hubung. Pola: ^[a-zA-Z0-9_./-]+$. |
boundaries | map dari boundary | tidak | Boundary logis bertingkat (misalnya, namespace dalam sebuah cluster). Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
components | map dari boundary_component | tidak | Component mana dari Aggregate yang ditempatkan dalam boundary ini. Kunci adalah nama instans component; component dari sub-aggregate dialamatkan dengan jalur bertitik yang terkualifikasi (misalnya, ‘data.main-db’ — nama instans aggregate, titik, nama component). Kunci: satu atau lebih huruf, angka, garis bawah, titik, atau tanda hubung. Pola: ^[a-zA-Z0-9_.-]+$. |
aggregates | map of aggregate_routing | tidak | Merutekan component sub-modul Aggregate bertingkat ke dalam boundary ini. Kunci adalah nama instans aggregate yang cocok dengan map spec.aggregates milik Aggregate. Semua instans aggregate harus ditempatkan tepat dalam satu boundary jika boundary didefinisikan. Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$. |
Properti tambahan tidak diizinkan.
uses_block
Topologi struktural - dimiliki oleh Developer. Mendeklarasikan edge jaringan logis dan dependensi.
Kunci: satu atau lebih huruf, angka, garis bawah, atau tanda hubung. Titik tidak diizinkan. Pola: ^[a-zA-Z0-9_-]+$.
Nilainya adalah string[] or map of object.
Kunci lain tidak diizinkan.
inject_block
Perutean injeksi yang agnostik pada sebuah koneksi. Memetakan variabel lokal ke kunci provides milik target. Setiap mekanisme pengiriman (env, file, arg, atau custom) ditulis sebagai array entri {in, from} — dengan ‘from’ eksplisit untuk referensi provides. Mekanisme kustom boleh memakai nama apa pun kecuali all: template membaca semua mekanisme yang digabungkan menjadi satu tampilan di .context.inject.all, sehingga mekanisme dengan nama itu akan tertutupi olehnya, dan menamai mekanisme seperti itu menghentikan build.
| Properti | Jenis | Wajib | Deskripsi |
|---|---|---|---|
env | inject_delivery | tidak | Satu mekanisme pengiriman, ditulis sebagai array entri. Setiap entri membawa ‘in’ (pengidentifikasi lokal — nama variabel lingkungan, path file, flag argumen, atau kunci khusus mekanisme kustom) ditambah tepat satu dari ‘from’ (kunci provides yang akan diresolusi) atau ‘value’. Pada Release, setiap entri berada pada sebuah koneksi, sehingga ‘from’ diresolusi terhadap provides milik target dan entri yang membawa ‘value’ ditolak. |
file | inject_delivery | tidak | Satu mekanisme pengiriman, ditulis sebagai array entri. Setiap entri membawa ‘in’ (pengidentifikasi lokal — nama variabel lingkungan, path file, flag argumen, atau kunci khusus mekanisme kustom) ditambah tepat satu dari ‘from’ (kunci provides yang akan diresolusi) atau ‘value’. Pada Release, setiap entri berada pada sebuah koneksi, sehingga ‘from’ diresolusi terhadap provides milik target dan entri yang membawa ‘value’ ditolak. |
arg | inject_delivery | tidak | Satu mekanisme pengiriman, ditulis sebagai array entri. Setiap entri membawa ‘in’ (pengidentifikasi lokal — nama variabel lingkungan, path file, flag argumen, atau kunci khusus mekanisme kustom) ditambah tepat satu dari ‘from’ (kunci provides yang akan diresolusi) atau ‘value’. Pada Release, setiap entri berada pada sebuah koneksi, sehingga ‘from’ diresolusi terhadap provides milik target dan entri yang membawa ‘value’ ditolak. |
inject_delivery
Satu mekanisme pengiriman, ditulis sebagai array entri. Setiap entri membawa ‘in’ (pengidentifikasi lokal — nama variabel lingkungan, path file, flag argumen, atau kunci khusus mekanisme kustom) ditambah tepat satu dari ‘from’ (kunci provides yang akan diresolusi) atau ‘value’. Pada Release, setiap entri berada pada sebuah koneksi, sehingga ‘from’ diresolusi terhadap provides milik target dan entri yang membawa ‘value’ ditolak.
Jenis: object[]