Aggrega Release şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/release-v1beta1.schema.json
Release varlıklarının yazımına ilişkin açıklayıcı rehberlik için Release yazım başvurusuna bakın; bu sayfa, o başvurunun tanımladığı yapısal şemayı belgeler.
Üst düzey tür: object
Özellikler
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
apiVersion | const “aggrega.ai/v1beta1” | evet | Sabit: "aggrega.ai/v1beta1" |
kind | const “Release” | evet | Sabit: "Release" |
metadata | object | evet | |
spec | object | evet | Release’in bağladığı ve yönlendirdiği şeyler: dağıttığı Aggregate ve Manifest (ya da bir extends tabanı), ortama özgü parametre karşılaması ve bileşenlerinin yönlendirildiği sınırlar. |
Ek özelliklere izin verilmez.
release.metadata
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | En az 1 karakter uzunluğunda. |
environment | string | evet | |
version | string | evet | Sürümün katı Anlamsal Sürümlemesi (ör. 1.0.0). Desen: ^(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 | hayır | Bu varlığın ne olduğu ve ne işe yaradığı; onu kullanıp kullanmamaya karar veren biri için yazılır. Şeyi adlandıran bir cümleyle başlayın, ardından okuyucunun onu seçmek ve doğru kullanmak için bilmesi gerekenleri ekleyin: dağıtıldığı platformdan ne beklediğini ve davranışında şaşırtıcı olabilecek her şeyi. Olağan uzunluk kısa bir paragraftır. |
maintainers | object[] | hayır | Bu varlığın sahibi olan bakımcıların listesi. |
license | string | hayır | Bu varlığın tanımladığı yazılımın lisansı için MIT veya AGPL-3.0 gibi bir SPDX tanımlayıcısı. Bu dosyanın koşullarını değil, o yazılımın koşullarını kaydeder. |
repository | string | hayır | Kaynak dosyaların bulunduğu Git deposunun URL’si. |
home | string | hayır | Bu varlığın ana sayfasının, wiki’sinin veya belgelerinin URL’si. |
keywords | string[] | hayır | Kullanıcı arayüzünde keşfedilebilirlik için tanımlayıcı anahtar sözcüklerin listesi. |
Ek özelliklere izin verilmez.
release.metadata.maintainers[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | |
email | string | hayır | |
url | string | hayır |
Ek özelliklere izin verilmez.
release.spec
Release’in bağladığı ve yönlendirdiği şeyler: dağıttığı Aggregate ve Manifest (ya da bir extends tabanı), ortama özgü parametre karşılaması ve bileşenlerinin yönlendirildiği sınırlar.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
aggregate | string | hayır | Bu sürümün dağıttığı Aggregate’e (Developer Intent) başvuru. Yalın bir belirteç kimliğe göre çözümlenir: başvurulan Aggregate’in metadata.name değeri önce Release’in kendi dizininde, ardından katalogda aranır. ’./’ ya da ’../’ ile başlayan bir değer, Release’e göre çözümlenen açık bir yerel dosyadır (ör. bir alt dizindeki sürüm varyantları arasında tek bir Aggregate’i paylaşmak için ’../shared/app.yaml’). |
manifest | string | hayır | Bu sürümün dağıtımda dayandığı soyut arayüzleri çözümleyen Manifest’e başvuru. Yalın bir belirteç kimliğe göre çözümlenir: başvurulan Manifest’in metadata.name değeri Release’in kendi dizininde aranır. ’./’ ya da ’../’ ile başlayan bir değer, Release’e göre çözümlenen açık bir yerel dosyadır. Bir Manifest dağıtım tarafındadır ve katalogda dizinlenmez; bu nedenle yalnızca Release dizininden ya da açık bir yoldan çözümlenir. |
extends | string | hayır | Bu Release’in yazım yüzeyini devraldığı temel bir Release’e başvuru: altındaki bileşen başına infra ve Feature eklentileriyle birlikte sınır ağacı, parametreleri, açıklamaları ve Manifest işaretçisi. Değer, bu Release’in yanındaki bir dosyaya giden, ’./’ ya da ’../’ ile başlayan bir yoldur; yalın bir ad da bir kayıt koordinatı da reddedilir, çünkü bir Release dağıtım tarafındadır ve katalogda dizinlenmez. Devralınanlar anahtar anahtar değiştirilebilir; bu, bütün olarak değiştirilen ilk bölünemez değere (bir skaler, bir liste, bir şablon) kadar iner; null olarak yazılan bir anahtar devralınanı kaldırır. Hiçbir metadata alanı aktarılmaz; bu nedenle bir alt öğe kendi adını, sürümünü ve ortamını taşır. ‘extends’ ile birlikte ‘aggregate’ bildirmek bu şema tarafından reddedilir; bu nedenle bir alt öğe, tabanıyla aynı Developer Intent’i dağıtır; ‘manifest’ isteğe bağlı kalır ve bağımlılık kilit dosyasını değiştirmek için geçersiz kılınabilir. |
parameters | object | hayır | İçerik biçimine göre dağıtım yoluyla iki yazım kipi sunan, ortama özgü değişken karşılama sözleşmesi. Kip 1 (satır içi): yapılandırılmış iç içe parametre değerlerini doğrudan taşıyan bir YAML eşlemi. Kip 2 (dosya içe aktarma): parametre değerlerini sağlayan tek bir yerel dosyayı gösteren, tam olarak tek anahtarlı bir YAML eşlemi: $import: ./relative/path.yaml. Bu noktada yalnızca tek kaynak kullanılır; çok dosyalı katmanlama Release extends: zincirlerinin işidir (üst Release temel parametreleri sağlar; alt öğe genişletir ve geçersiz kılar). |
boundaries | boundary eşlemi | hayır | Aggregate’in bileşenlerinin yönlendirildiği kök mantıksal kutular. Anahtarlar: bir ya da daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
components | boundary_component eşlemi | hayır | Adlandırılmış sınırları olmayan, tek kapsamlı bir Release için bileşen başına operatör altyapısını taşıyan üst düzey bileşen örnekleri. boundaries ile karşılıklı olarak dışlayıcıdır: düz bir Release için components, çok hedefli yönlendirme için boundaries bildirin; ikisini birden asla bildirmeyin. components kullanıldığında derleyici, bunları içeren bir default sınırı sentezler ve yapıtlarını düz olarak dist/ dizinine yazar. Anahtarlar: bir ya da daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
Ek özelliklere izin verilmez.
Tanımlar
boundary_component
Bir sınıra yönlendirilen, isteğe bağlı fiziksel boyutlandırma ve özellik eklemeleri içeren bir bileşen örneği.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
description | string | hayır | Bu bileşenin Release’in bu sınırındaki rolünü açıklayan isteğe bağlı belgeler. |
subDirectory | string | hayır | Üst boundary’nin dizinine eklenen, Component düzeyinde alt yol geçersiz kılması. Hem boundary’de hem bileşende atlanırsa veya boşsa varsayılan olarak ’{{ .capability }}’ kullanılır; buraya yazılan boş bir dize atlanmış sayılır. Alt dizin oluşturmayı devre dışı bırakmak için ’.’ değerine veya boş bir dizeye değerlendirilen bir şablona ayarlayın. |
annotations | string, object veya null eşlemi | hayır | Bu bileşen için boundary düzeyindeki ek açıklamaları geçersiz kılan, Component’e özgü Operator ek açıklamaları. Boundary ek açıklamalarının üzerine derinlemesine birleştirilir (anahtar çakışmasında bileşen kazanır; yapılandırılmış değerler, yapılandırılmış üst değerlerle alt anahtar bazında birleştirilir). Değerler dize, yapılandırılmış nesne veya null’dır. Bileşen başına provider’ın iyi bilinen ek açıklamalarını geçersiz kılmak için kullanılır (ör. helm provider’ında aggrega.ai/namespace). Üst boundary’den devralınan bir anahtarda açıkça null yazılması, devralınan bağlamayı bu bileşenden kaldırır (ek açıklama güdümlü Feature’dan vazgeçme); kardeş bileşenler devralınan bağlamayı korur. |
infra | object | hayır | Yalnızca bu bileşene özgü fiziksel boyutlandırma (örn. kopyalar, disk IOPS). |
features | object eşlemi | hayır | Bu bileşene Release aracılığıyla eklenen Features. Aggregate’te de bildirilen özellikler için yalnızca infra sağlanır (değerler Aggregate’ten gelir). Yalnızca Release’te bulunan özellikler (operatör tarafından enjekte edilen) için type zorunludur. Anahtarlar özellik örneği adlarıdır ve özelliğin tam tür URI’sini taşıyabilir (nokta ve eğik çizgiye izin verilir). Release, özellikler için değer SAĞLAMAMALIDIR — bu geliştiricinin alanıdır. Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi, nokta, eğik çizgi veya kısa çizgi. Desen: ^[a-zA-Z0-9_./-]+$. |
uses | release_uses_block | hayır | Operatörün kenar yüzeyi. Mimarın bildirdiği soketler içinde Release, bildirilmiş ancak bağlanmamış bir soketi mevcut bir bileşene (target) bağlayabilir ve/veya kenar bazında infra sağlayabilir. Değer yoktur (Release values: yasağı geçerlidir) ve hesaplama oluşturulmaz; geliştiricinin bildirdiği bir kenarın hedefini değiştirmek derlemede durdurulur. |
Ek özelliklere izin verilmez.
release_uses_block
Release tarafından yazılan, kenar bazında uses yüzeyi; önce sokete, sonra takma ada göre anahtarlanır (Aggregate uses topolojisinin biçimini yansıtır). Her bağlantı, herhangi bir birleşimde target (bildirilmiş ancak bağlanmamış bir sokete, mevcut bir bileşeni gösteren bir kenar oluşturmak için), infra (Release çözümlendiğinde soketin infraSchema’sına göre doğrulanan, kenar bazında operatör yapılandırması) ve features (soketin bildirdiği yuvaları dolduran eklemeler) ayarlayabilir. values yasaktır (Release values: yasağı); geliştiricinin bildirdiği bir kenarın hedefini değiştirmek derlemede açıkça bildirilen bir korumaya takılır.
Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi ya da kısa çizgi. Nokta kullanılamaz. Desen: ^[a-zA-Z0-9_-]+$.
Değerler map of object türündedir.
Başka hiçbir anahtara izin verilmez.
release_connection_attachment
Bir Release bağlantı girdisinin taşıdığı tek bir ekleme: bağlantının soketinin bildirdiği bir yuvayı dolduran Feature ve operatörün onun için belirlediği boyutlandırma.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
type | string | hayır | Feature’ın URI’si. Yalnızca Release’in yaptığı bir ekleme için zorunludur. Her ikisi de bildiriyorsa Aggregate’in türüyle eşleşmelidir. |
description | string | hayır | Operatörün bu özelliği bağlantıya neden eklediğini açıklayan isteğe bağlı belgeler. |
infra | object | hayır | Bu ekleme için, Feature’ın şema bildirimiyle doğrulanan operasyonel boyutlandırma. |
Ek özelliklere izin verilmez.
aggregate_routing
İç içe bir Aggregate alt modülünün iç bileşenlerini bu sınıra yönlendirir. Özyinelemeli bileşim için sınırın bileşen/aggregate yapısını yansıtır.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
components | boundary_component eşlemi | hayır | İç içe aggregate içinde bu boundary’ye yönlendirilecek Component örnekleri. Anahtarlar, her bileşenin o alt modül içinde taşıdığı yerel addır — bir boundary’nin kendi components eşlemesinin ‘data.main-db’ olarak adreslediği bileşen için ‘main-db’ — çünkü orada sahip olduğu tek ad budur. Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi veya kısa çizgi. Nokta kullanılamaz. Desen: ^[a-zA-Z0-9_-]+$. |
aggregates | map of aggregate_routing | hayır | Bu alt aggregate içindeki daha fazla iç içe aggregate (derin iç içe modül bileşimi için). Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
Ek özelliklere izin verilmez.
boundary
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
description | string | hayır | Bu sınırın amacını ve fiziksel hedefini açıklayan isteğe bağlı belgeler (örn. ‘Primary production EKS cluster in us-east-1, PCI-DSS compliant’). |
directory | string | hayır | GitOps yapıt üretimi için fiziksel çıktı yolu. Go şablon değişkenlerini destekler ({{ .capability }}, {{ .boundary_name }}, {{ .parameters.X }}). Nihai yapıt yolunu üretmek için subDirectory ile yol birleştirmesi yapılır. |
subDirectory | string | hayır | directory’ye eklenen sınır düzeyinde alt yol. Hem sınırda hem bileşende atlanırsa veya boşsa, CI/CD otomatik bölümleme için varsayılan değer ’{{ .capability }}’ olur; buraya yazılan boş bir string atlanmış sayılır. Devre dışı bırakmak için ’.’ değerine veya boş bir string’e değerlendirilen bir şablona ayarlayın. |
syncWave | integer | hayır | İsteğe bağlı, sınır başına dağıtım dalgası (işaretli tamsayı, varsayılan 0). Bu sınırdaki her bileşen, sınırın dalgasını kendi düğümüne devralır. Negatif değerlere izin verilir (diğer her şeyden önce çalışır); büyük değerler küçük olanlardan sonra çalışır. K8s ve Helm’de dağıtımı sıralayan dalgadır: dalga bir argocd.argoproj.io/sync-wave ek açıklamasına dönüşür ve chart’ın zaten Helm hook olarak işaretlediği bir kaynakta ayrıca o hook’un helm.sh/hook-weight değerine dönüşür. compose’da dalga hem bir servis etiketi olarak kaydedilir hem de işlendiği dosyanın servislerini aralarındaki depends_on aracılığıyla sıralar; dolayısıyla o tek dosyadaki her servise ulaşır ve dışındaki hiçbir şeye ulaşmaz. cloudformation’da dalga, sınırın birleştirildiği yığının sağlanmasını sıralar: bir dalgadaki her kaynağın, kendinden önceki dalganın kaynaklarına bağımlı olduğu bildirilir; bu da kaynakların oluşturulma sırasını ve tersine silinme sırasını belirler. Bu yalnızca oluşturma ve silme sırasıdır: bir yığın şablonu, bir kaynağın hazır olması diye bir kavramı ifade etmez, dolayısıyla hiçbir şey bir kaynağın hizmet verebilir hâle gelmesini beklemez. terraform’da dalga, sınırın birleştirildiği kök yapılandırmanın module bloklarını sıralar: bir dalgadaki her modülün, kendinden önceki dalganın modüllerine bağımlı olduğu bildirilir; bu da motorun eylemlerini gerçekleştirme sırasını belirler. Bu yalnızca eylem sırasıdır (bir yapılandırma, bir kaynağın hazır olması diye bir kavramı ifade etmez, dolayısıyla hiçbir şey bir kaynağın hizmet verebilir hâle gelmesini beklemez) ve değer ayrıca düğümün derleme kökeniyle birlikte kaydedilir. Derleyici aynı değeri sınırdaki her düğüme o düğümün sync_wave değeri olarak taşır; hedef başına davranış orada düğüm tarafından yeniden açıklanır. İç içe sınırlar örtük olarak devralmaz; her biri kendi dalgasını bildirir. |
annotations | string, object veya null eşlemi | hayır | .context.annotations.release kovasına doğru aşağı kademelenen, sınır genelindeki Operator ek açıklamaları. Değerler string, yapılandırılmış nesne veya null’dır. Yapılandırılmış bir değer, yapılandırılmış üst öğelerle derinlemesine birleşen (alt anahtar başına, alt öğe kazanır) ve ek açıklama güdümlü Feature genişletmesinden geçen alt anahtar başına yapılandırma taşır; render bağlamında yalnızca skaler değerler görünür. Bir üst sınırdan devralınan bir anahtarda açıkça belirtilen null, devralınan bağlamayı bu sınırın etkin ek açıklama kümesinden kaldırır (ek açıklama güdümlü Feature devre dışı bırakma); daha derindeki bir geçersiz kılma bağlamayı yeniden eklemedikçe bu, bu sınıra yönlendirilen her bileşene yayılır. |
features | object eşlemi | hayır | İç içe tüm bileşenlere uygulanan sınır genelindeki özellikler (örn. varsayılan güvenlik ağı). Bir özelliğin uses bloğu sınırdaki her bileşene yansır; böylece paylaşılan bir bağımlılık her bileşende tekrarlanmak yerine sınırda bir kez bildirilir. Anahtarlar özellik örneği adlarıdır ve tam özellik türü URI’sini taşıyabilir (noktalara ve eğik çizgilere izin verilir). Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi, nokta, eğik çizgi veya kısa çizgi. Desen: ^[a-zA-Z0-9_./-]+$. |
boundaries | boundary eşlemi | hayır | İç içe mantıksal sınırlar (örn. bir küme içindeki ad alanları). Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
components | boundary_component eşlemi | hayır | Aggregate’ten hangi bileşenlerin bu sınıra yerleştirileceği. Anahtarlar bileşen örneği adlarıdır; bir alt aggregate’in bileşeni, nitelikli noktalı yoluyla adreslenir (örn. ‘data.main-db’: aggregate örneği adı, bir nokta, bileşen adı). Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi, nokta veya kısa çizgi. Desen: ^[a-zA-Z0-9_.-]+$. |
aggregates | map of aggregate_routing | hayır | İç içe Aggregate alt modülü bileşenlerini bu sınıra yönlendirir. Anahtarlar, Aggregate’in spec.aggregates eşlemesiyle eşleşen aggregate örneği adlarıdır. Sınırlar tanımlanmışsa tüm aggregate örnekleri tam olarak bir sınıra yerleştirilmelidir. Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi veya kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
Ek özelliklere izin verilmez.
uses_block
Yapısal topoloji - geliştiriciye ait. Mantıksal ağ kenarlarını ve bağımlılıkları bildirir.
Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi ya da kısa çizgi. Nokta kullanılamaz. Desen: ^[a-zA-Z0-9_-]+$.
Değerler string[] or map of object türündedir.
Başka hiçbir anahtara izin verilmez.
inject_block
Bir bağlantı üzerinde bağımsız enjeksiyon yönlendirmesi. Yerel değişkenleri hedefin provides anahtarlarına eşler. Her teslim mekanizması (env, file, arg veya custom) {in, from} girdilerinden oluşan bir dizi olarak yazılır — provides başvuruları için açık ‘from’ kullanılır. Özel bir mekanizma all dışında herhangi bir ad alabilir: bir şablon tüm mekanizmaları .context.inject.all altında tek bir görünümde birleştirilmiş olarak okur; bu nedenle bu adı taşıyan bir mekanizma bu görünüm tarafından gizlenirdi ve böyle bir ad vermek derlemeyi durdurur.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
env | inject_delivery | hayır | Girdilerden oluşan bir dizi olarak yazılan tek bir teslim mekanizması. Her girdi bir ‘in’ (yerel tanımlayıcı — ortam değişkeni adı, dosya yolu, argüman bayrağı ya da özel mekanizmaya özgü bir anahtar) ile birlikte ‘from’ (çözümlenecek bir provides anahtarı) ya da ‘value’ değerlerinden tam olarak birini taşır. Bir Release üzerinde her girdi bir bağlantı üzerinde bulunur; bu nedenle ‘from’ hedefin provides değerlerine göre çözümlenir ve ‘value’ taşıyan bir girdi reddedilir. |
file | inject_delivery | hayır | Girdilerden oluşan bir dizi olarak yazılan tek bir teslim mekanizması. Her girdi bir ‘in’ (yerel tanımlayıcı — ortam değişkeni adı, dosya yolu, argüman bayrağı ya da özel mekanizmaya özgü bir anahtar) ile birlikte ‘from’ (çözümlenecek bir provides anahtarı) ya da ‘value’ değerlerinden tam olarak birini taşır. Bir Release üzerinde her girdi bir bağlantı üzerinde bulunur; bu nedenle ‘from’ hedefin provides değerlerine göre çözümlenir ve ‘value’ taşıyan bir girdi reddedilir. |
arg | inject_delivery | hayır | Girdilerden oluşan bir dizi olarak yazılan tek bir teslim mekanizması. Her girdi bir ‘in’ (yerel tanımlayıcı — ortam değişkeni adı, dosya yolu, argüman bayrağı ya da özel mekanizmaya özgü bir anahtar) ile birlikte ‘from’ (çözümlenecek bir provides anahtarı) ya da ‘value’ değerlerinden tam olarak birini taşır. Bir Release üzerinde her girdi bir bağlantı üzerinde bulunur; bu nedenle ‘from’ hedefin provides değerlerine göre çözümlenir ve ‘value’ taşıyan bir girdi reddedilir. |
inject_delivery
Girdilerden oluşan bir dizi olarak yazılan tek bir teslim mekanizması. Her girdi bir ‘in’ (yerel tanımlayıcı — ortam değişkeni adı, dosya yolu, argüman bayrağı ya da özel mekanizmaya özgü bir anahtar) ile birlikte ‘from’ (çözümlenecek bir provides anahtarı) ya da ‘value’ değerlerinden tam olarak birini taşır. Bir Release üzerinde her girdi bir bağlantı üzerinde bulunur; bu nedenle ‘from’ hedefin provides değerlerine göre çözümlenir ve ‘value’ taşıyan bir girdi reddedilir.
Tür: object[]