Aggrega bağımlılık kilit dosyası (Manifest) şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/manifest-v1beta1.schema.json
Soyut bileşen ve Feature türlerini türe göre somut Recipe ve FeatureRecipe uygulamalarına eşleyen, ada göre örnek başına geçersiz kılmaya olanak tanıyan tek ve genel bir kilit dosyası.
Manifest varlıklarının yazımına ilişkin açıklamalı rehberlik için Manifest yazım başvurusuna bakın; bu sayfa, o başvurunun anlattığı 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 “Manifest” | evet | Sabit: "Manifest" |
metadata | object | evet | |
defs | string[] | hayır | Derleyici için düz bir O(1) sözlüğü korurken Manifest’i DRY tutmak amacıyla standart YAML çapaları (& ve *) için isteğe bağlı blok. |
spec | object | evet | Manifest’in eşleme bildirimleri ve isteğe bağlı temel kalıtımı: mappings, soyut bileşen ve özellik türlerini somut Recipe ve FeatureRecipe uygulamalarına bağlar; extends, eşlemeleri temel bir Manifest’ten devralır. |
Ek özelliklere izin verilmez.
manifest.metadata
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | En az 1 karakter uzunluğunda. |
version | string | evet | manifest kilit dosyasının katı Semantic Versioning sürümü (ö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: onu kullanan Release’ten 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.
manifest.metadata.maintainers[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | |
email | string | hayır | |
url | string | hayır |
Ek özelliklere izin verilmez.
manifest.spec
Manifest’in eşleme bildirimleri ve isteğe bağlı temel kalıtımı: mappings, soyut bileşen ve özellik türlerini somut Recipe ve FeatureRecipe uygulamalarına bağlar; extends, eşlemeleri temel bir Manifest’ten devralır.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
extends | string | hayır | Eşlemelerin devralınacağı temel Manifest’in URI’si. Aynı anahtar için alt öğenin eşlemesi temeldekinin yerini alır. |
mappings | object | evet | Soyut arayüzleri somut uygulamalara eşler. Eşlemeleri ‘components’ ve ‘features’ üst düzey anahtarları altında bildirin; her biri bileşen türü / özellik türü URI’lerini doğrudan Recipe / FeatureRecipe URI’lerine eşler. Bu iki anahtar yüzeyin tamamıdır; burada başka bir anahtar kabul edilmez. Eşleme, Manifest katmanında yetenekten bağımsızdır — yetenek belirlenmesi, Aggrega Release’i derlerken çözümlenen her Recipe’in spec.capability alanından gelir. Anahtarlar: "components", "features" değerlerinden biri. |
Ek özelliklere izin verilmez.
manifest.spec.mappings
Soyut arayüzleri somut uygulamalara eşler. Eşlemeleri ‘components’ ve ‘features’ üst düzey anahtarları altında bildirin; her biri bileşen türü / özellik türü URI’lerini doğrudan Recipe / FeatureRecipe URI’lerine eşler. Bu iki anahtar yüzeyin tamamıdır; burada başka bir anahtar kabul edilmez. Eşleme, Manifest katmanında yetenekten bağımsızdır — yetenek belirlenmesi, Aggrega Release’i derlerken çözümlenen her Recipe’in spec.capability alanından gelir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
components | mapping_tier | hayır | Component-type’tan Recipe URI’sine eşleme. Bir Recipe URI’si en fazla iki bölüm taşır — isteğe bağlı baştaki bir capability, ardından recipe adı — ve buna ek olarak isteğe bağlı bir sürüm; üçüncü bölümü olan bir başvuru hiçbir recipe ile eşleşmez. Sürüm biçimleri: tam (‘postgres-bitnami:1.2.0’), aralık (‘postgres-bitnami:^1.2.0’) veya sürümsüz (‘postgres-bitnami’); çözümleyici, çözümlenen sürümü ilk çözümlemede kilit dosyasına sabitler. Bir başvuru ayrıca capability ile nitelendirilebilir (‘terraform/mariadb-rds:1.0.0’; ilk ’/’ işaretinden önceki bölüm recipe’nin spec.capability değerini adlandırır) — birden fazla recipe aynı adı taşıdığında bu gereklidir; belirsiz, yalın bir başvuru sessizce birini seçmek yerine çözümlemeyi açıkça durdurur. |
features | mapping_tier | hayır | Özellik türünden FeatureRecipe URI’sine eşleme. Hem operasyonel Features’ı hem de kimlik bilgisi Features’ını (feature.aggrega.ai/kind: secret etiketli) kapsar. |
Anahtarlar: "components", "features" değerlerinden biri.
Ek özelliklere izin verilmez.
Tanımlar
mapping_tier
İki katmanlı çözümleme: ‘type’ katalog türüne göre eşler (DRY toplu), ‘name’ örnek adına göre eşler (ayrıntılı geçersiz kılma). İkisi de isteğe bağlıdır ancak en az biri bulunmalıdır. Çözümleme sırasında name, type’a üstün gelir. Sürümlü type anahtarları sürümsüzlere üstün gelir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
type | string eşlemi | hayır | Katalog türü URI’lerini Recipe URI’lerine eşler. Tam eşleşme için sürümlü anahtarları (‘core/api-server:1.0.0’), ana sürümle uyumlu eşleşme için aralık anahtarlarını (‘core/api-server:^1.0.0’) veya herhangi bir sürümle eşleşme için sürümsüz anahtarları (‘core/api-server’) destekler. |
name | string eşlemi | hayır | Belirli örnek adlarını Recipe URI’lerine eşler. Türe dayalı eşlemeye göre önceliklidir. |
annotations | object eşlemi | hayır | Ek açıklama güdümlü Feature kısayolları. Ek açıklama anahtarlarını bir Feature URI’sine ve noktalı yol alt anahtarından Feature sütununa (values veya infra) giden, sütunlara göre gruplanmış bir yönlendirme tablosuna eşler. Doğrulama, hedef Feature’ın spec.schema. |
Ek özelliklere izin verilmez.