Aggrega Catalog (Feature) şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/feature-v1beta1.schema.json
Bileşenlere dinamik olarak bağlanan modüler bir operasyonel özellik.
Feature varlıklarının yazımına ilişkin açıklayıcı rehberlik için Feature 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 “Feature” | evet | Sabit: "Feature" |
metadata | object | evet | |
spec | object | evet | Bir katalog Feature’ı için doğrulama, hedefleme ve birlikte çalışabilirlik sözleşmesi: şema aracılığıyla yazılan serbest biçimli sütunlar (values, infra, provides), sabit biçimli sütunlar (usesSchema bağımlılık soketleri, featuresSchema ekleme yuvaları), bileşen hedefleme (appliesTo ve appliesToAnyOf) ve birlikte çalışabilirlik denetimleri. |
Ek özelliklere izin verilmez.
feature.metadata
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | En az 1 karakter uzunluğunda. |
version | string | evet | Özelliğin 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 okurun onu seçmek ve doğru kullanmak için ihtiyaç duyduklarını ekleyin: onu dağıtan Release’ten ne beklediğini ve davranışında şaşırtıcı olan 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. |
labels | object | hayır | Feature için ördek tiplemesi etiketleri. ‘secret’ değerini taşıyan ayrılmış ‘feature.aggrega.ai/kind’ etiketi, bunu yazar ve onu gösteren araçlar için bir kimlik bilgisi Feature’ı olarak işaretler. Bir kimlik bilgisi Feature’ı ile sıradan bir Feature aynı şekilde, aynı ekleme yüzeyi altında eklenir; bir eklemenin ne ürettiğine etiket değil, Manifest’in onun türünü eşlediği FeatureRecipe karar verir. |
annotations | string eşlemi | hayır | Platform Mimarı tarafından Alan 2’de yazılan, değiştirilemez, özelliğe içkin nitelikler. .context.annotations.catalog kovasına doğru aşağı aktarılır. |
Ek özelliklere izin verilmez.
feature.metadata.maintainers[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | |
email | string | hayır | |
url | string | hayır |
Ek özelliklere izin verilmez.
feature.metadata.labels
Feature için ördek tiplemesi etiketleri. ‘secret’ değerini taşıyan ayrılmış ‘feature.aggrega.ai/kind’ etiketi, bunu yazar ve onu gösteren araçlar için bir kimlik bilgisi Feature’ı olarak işaretler. Bir kimlik bilgisi Feature’ı ile sıradan bir Feature aynı şekilde, aynı ekleme yüzeyi altında eklenir; bir eklemenin ne ürettiğine etiket değil, Manifest’in onun türünü eşlediği FeatureRecipe karar verir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
feature.aggrega.ai/kind | string (enum) | hayır | Feature türü etiketi. ‘secret’ değeri bunu bir kimlik bilgisi Feature’ı olarak işaretler. İzin verilen değerler: "secret" |
feature.spec
Bir katalog Feature’ı için doğrulama, hedefleme ve birlikte çalışabilirlik sözleşmesi: şema aracılığıyla yazılan serbest biçimli sütunlar (values, infra, provides), sabit biçimli sütunlar (usesSchema bağımlılık soketleri, featuresSchema ekleme yuvaları), bileşen hedefleme (appliesTo ve appliesToAnyOf) ve birlikte çalışabilirlik denetimleri.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
extends | string | hayır | Bu Feature’ın kalıtım aldığı temel Feature’a başvuru. Temeli, Feature’ın yayımlandığı kayıt koordinatıyla değil metadata.name değeriyle adlandırır ve her katalog başvurusunun aldığı üç sürüm biçimini alır: mevcut en yüksek sürüm için yalın (core/queue), tam (core/queue:1.0.0) veya şapka aralığı (core/queue:^1.0.0). Kalıtılan şey metadata’dan fazlasıdır: temelin metadata.labels ve metadata.annotations alanları, appliesTo ve appliesToAnyOf seçicileri, interoperability bloğu, usesSchema ve featuresSchema alanlarının tümü aşağıya doğru birleşir ve schema üzerindeki JSON Schema 2020-12 bildirimleri otomatik olarak birleştirilir. Ortak bir anahtarda alt öğenin kendi değeri geçerli olur ve kimlik alanları hiçbir zaman kalıtılmaz. |
featuresSchema | object eşlemi | hayır | Bildirimsel ekleme yuvası tanımları: bu Feature’ın başka bir Feature’ın eklenmesini beklediği adlandırılmış bağlama noktaları. Bir yuva, onu hangi dolgunun bağlayabileceğini (selector) ve dolgunun malzemesinin nasıl iletilebileceğini (inject) kısıtlar; dolgunun values ve infra sözleşmesi dolgunun kendi Feature’ına aittir. Bir yuva bildirmek ekleme bloğunu asla kapatmaz — bir yazar, hiçbir yuvanın bildirmediği bir ad altında Feature ekleyebilir. Yuva bir bağımlılık soketi değil, bir bağlama noktasıdır: ayrı topoloji yüzeyini usesSchema bildirir. |
appliesTo | string | hayır | Components ile eşleşen, Kubernetes tarzı etiket seçici dizesi. Virgülle ayrılmış gereksinimlerin tümü sağlanmalıdır (AND). Desteklenen biçimler: key=value, key!=value, key in (v1, v2), key notin (v1, v2), yalın key (etiket mevcut), !key (etiket yok). Örnek: “tier in (critical, production), !legacy”. Boş veya bulunmayan bir seçici hiçbir kısıt bildirmez. Seçici, bu Feature’ın her eklemesi değerlendirildiğinde bu biçimlere göre okunur ve bunların dışındaki bir gereksinim, onu adlandırarak derlemeyi durdurur: boş bir gereksinim (baştaki, sondaki veya çift virgül) ya da boşluk veya = ! ( ) karakterlerinden herhangi birini ya da virgülü taşıyan bir anahtar — bu nedenle “!tier=frontend” reddedilir ve bir değer tier!=frontend ile dışlanır. Değer, taşıdığı karakterler ne olursa olsun, işlecinden sonraki metindir. Bu alandaki desen, herhangi bir ekleme değerlendirilmeden önce yalnızca birkaç hatalı biçimi reddeder. Desen: ^(?:[^()]*[()][\s\S]*|[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?(?:,[ \t]*(?:![ \t]*[^,]*[^ \t,][^,]*|[^ \t,!][^,]*)?)*)$. |
appliesToAnyOf | string veya string[] eşlemesi | hayır | Seçicilerin listesi; öğelerden HERHANGİ biri eşleşirse Feature uygulanır (OR mantığı). Her öğe ya bir etiket seçici dizesidir (appliesTo ile aynı dilbilgisi; dize içindeki gereksinimler AND ile birleşir) ya da her çiftin eşleşmesi gereken düz bir anahtar-değer eşlemesidir (yalnızca eşitlik). |
interoperability | object | hayır | Gelişmiş operasyonel güvenlik ve birlikte çalışabilirlik denetimleri. |
usesSchema | object eşlemi | hayır | Bu varlığın bildirdiği, soket adıyla anahtarlanan bağımlılık soketleri; bir soket üzerinden kurulan her bağlantı o soketin bildirimine — seçicisine ve izin verdiği inject mekanizmalarına — göre denetlenir. Anahtarlar: bir veya daha fazla harf, rakam, alt çizgi ya da kısa çizgi. Noktaya izin verilmez. Desen: ^[a-zA-Z0-9_-]+$. |
schema | object | hayır | Serbest biçimli sütunları kapsayan JSON Schema 2020-12 içeriği: values (Geliştiricinin alanı — Geliştiricinin Aggregate içindeki her Feature eklemesi için yapılandırdığı uygulama biçimli parametreler); infra (Operatörün alanı — Release tarafından sağlanan fiziksel boyutlandırma ayarları) ve provides (bu Feature’ın topoloji kanalı aracılığıyla tüketicilere sunduğu aşağı akış bağlam anahtarları). İçerik biçimine göre yönlendirme ile üç yazım kipini kabul eder: (1) satır içi içerik (kompakt biçim, JSON Schema YAML veya karışık içerik taşıyan bir YAML eşlemesi); (2) {$import: |
assertions | string eşlemi | hayır | Derleme zamanında alanlar arası doğrulama. Her girdi adlandırılmış bir onaylamadır: anahtar, hata iletilerinde gösterilen kararlı bir kural tanımlayıcısıdır; değer, {{ fail "message" }} durdurma semantiğine sahip bir Go şablon dizesidir. Varlık başına birden çok adlandırılmış onaylama, örnek başına yazarın bildirdiği sırayla değerlendirilir; başarısız olan ilk onaylama derlemeyi durdurur. Feature onaylamaları çözümleme ve statik analizden sonra, işlemeden önce değerlendirilir ve sözleşmenin mimari değişmezlerini ifade eder. Şablon bağlamı: .values / .infra / .uses / .features / .metadata. Değerlendirici missingkey=error kullanır: tanımsız anahtarlara başvurular no-such-key tanılamasıyla durur. Yalın başvuru herhangi bir yedek çalışmadan önce durduğundan, düz bir default bu yüzeyde isteğe bağlı alan yedeği sağlamaz — başvuruyu hasKey ile koşula bağlayın veya varlık denetimini doğrudan yapan optional yardımcısını kullanın. Anahtarı index ile okumak da bunu sağlamaz: index, eşlemenin içermediği bir anahtarda, anahtarı adlandırarak durur. |
Ek özelliklere izin verilmez.
feature.spec.interoperability
Gelişmiş operasyonel güvenlik ve birlikte çalışabilirlik denetimleri.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
conflictsWith | string[] | hayır | Bu Feature’ın bir bileşene birlikte ulaşamayacağı Features’ın adları; her biri, bir eklemenin türünün bir Feature’ı adlandırdığı şekilde yazılır. Bir bileşen bu Feature’ı ve burada adı geçen bir Feature’ı birlikte taşır hale geldiğinde derleme, işlemeden önce durur — her biri bileşenin üzerinde, onu barındıran bir alt sistem veya sınır üzerinde, bir Release bileşen girdisinde ya da açıklama güdümlü genişletmeyle eklenmiş olsun. Tek bir bildirim yeterlidir: durdurma için diğer Feature’ın bunu listelemesi gerekmez. Adlar sürüm çıkarılarak karşılaştırılır; bu nedenle bir girdi, adlandırdığı Feature’ın her sürümüyle eşleşir. Ortak bileşeni olmayan kardeş sınırlara eklenmiş iki Features hiçbir zaman karşılaşmaz ve durdurmaya yol açmaz. |
Ek özelliklere izin verilmez.