Varlık başvurusuna genel bakış
Aggrega’nın yazım sözcük dağarcığı Aggregate, Component, Feature, Recipe, FeatureRecipe, Plugin, Manifest, Release, SchemaLibrary, MappingLibrary, WorkloadLibrary ve ArtifactLibrary türlerinden oluşur; bunlara ek olarak bir Recipe’nin sentezlenmiş girdisine gömülü, platforma ait Workload türü vardır. Her varlık, bir JSON Schema’ya uyan bir YAML belgesidir; bu başvurunun açıkladığı her alan, anahtar sözcük ve varlıklar arası başvuru, bu yazım sözleşmesinin parçasıdır.
Bu bölüm kümesi yazım yüzeyini kapsar: her varlığın hangi alanları kabul ettiği, her alanın yazar için ne anlama geldiği, alanların varlıklar arasında nasıl etkileştiği (bir Recipe’nin uyguladığı Component’i adlandıran implements: alanı, bir Release’in bir Manifest’e manifest: işaretçisi, bir Workload’un Component’in featuresSchema alanında bildirilen yuvalara başvuran containers.<name>.attachments alanı). Her varlığın kavramsal rolü — sınıflandırmanın neden bu biçimde olduğu, hangi alanın hangi varlığa sahip olduğu, Dört Alan’ın yazım kaygılarını nasıl ayırdığı — ../architecture/04-entity-taxonomy.md sayfasında yer alır. Workload türünün üç Recipe girdi türünden biri olarak mimari rolü ../architecture/16-recipe-input-composition.md sayfasında yer alır.
Bu başvurunun düzeni
Yazım sözcük dağarcığını iki yüzey belgeler ve bunlar farklı soruları yanıtlar.
Yukarıda listelenen her türün üretilmiş bir şema başvurusu vardır. Bu sayfalar derleyicinin kendisinin yayımladığı şemalardan üretilir ve schema/README.md tüm kümeyi dizinler: varlık türleri, eklenti aktarım biçimleri ve çalışma alanı dosyaları. “Bu belge neler içerebilir” sorusunu yanıtlamak için şema başvurusuna başvurun: her alan, türü, zorunlu olup olmadığı ve zarfın uyguladığı kısıtlar.
Aşağıdaki sayfalar yazım kılavuzlarıdır. Şemanın öğretemediğini öğretmek için elle yazılmışlardır: bir türün ne işe yaradığı, alanlarının diğer türlerle nasıl etkileştiği, hangi yazım biçiminin hangi duruma uyduğu ve standart kitaplık kataloğunun izlediği uzlaşımlar. “Bunu nasıl yazarım ve neden bu biçimde” sorusunu yanıtlamak için bir yazım kılavuzuna başvurun.
Varlık başına başvuru
- Aggregate — geliştiricinin bildirimsel niyet yapıtı. Bileşenleri,
usesaracılığıyla topolojilerini, ortam başına değişim için parametre sözleşmelerini ve Feature eklerini bildirir. - Component — yeniden kullanılabilir bir bileşen türünü tanımlayan, Platform Mimarı tarafından yazılan katalog varlığı.
valuesveinfraşemalarını (her biri kısa veya tam biçimde bir JSON Schema 2020-12 bildirimi),providesçıktı sözleşmesini,usesSchemagelen kenar sözleşmesini vefeaturesSchemaaracılığıyla kimlik bilgisi yuvalarını bildirir. - Feature — kesişen bir kaygı (izleme yan arabası, veri maskeleme, yönlendirme ilkesi) için Platform Mimarı tarafından yazılan katalog varlığı.
valuesveinfraşemalarını (her biri bir JSON Schema 2020-12 bildirimi),appliesToek seçicilerini ve birlikte çalışabilirlik kısıtlarını bildirir. - Recipe — bir Component’ten belirli bir sağlayıcıya Ops tarafından yazılan çeviri. Üç girdi türünü (
source:+valuesMapping:,workload:,artifacts:— her biri birleşik dosya içe aktarma sözcük dağarcığına göre satır içi içerik veya$import:kabul eder) ve çağıran tarafından ekleme sözleşmesini oluşturan birprovidesbloğunu bir araya getirir. - FeatureRecipe — bir Feature’dan belirli bir sağlayıcıya Ops tarafından yazılan çeviri. Recipe ile aynı üç girdi türü sözleşmesini ve çağıran tarafta değişken yeniden yazımı için inject borusunu araya giren bir
injectMappingkullanır. - Plugin — içerik adresli WebAssembly eklentisi. Uyguladığı tek soket türünü —
provider,linter,pipeline-step,governance,cli,parserveyaimporter—, ABI sürümünü ve bu soket türünün sunduğu yetenekleri bildirir. Sağlayıcı işleyen bir Plugin (pluginType: provider), sunduğu sağlayıcı adlarınıspec.provider.capabilitiesiçinde bildirir ve sağlayıcı soketi meta verilerini —workloadSchemavewellKnownAnnotations— aynıspec.providerbloğunda taşır. - Manifest — proje başına eşleme tablosu. Soyut Component ve Feature türlerini
componentsvefeaturesaltında somut Recipe ve FeatureRecipe URI’lerine bağlar; arama sırasıname> sürümlütype> sürümsüztypeşeklindedir. - Release — ortam başına dağıtım yönlendiricisi. Bir Aggregate’i bir Manifest’e bağlar, bileşenleri fiziksel sınırlara eşler, ortam başına parametre değerleri sağlar ve Ops tarafından yönetilen Features ekler.
Kitaplık varlıkları
Dört kitaplık türü Katman 3’tür: isteğe bağlı yeniden kullanım varlıkları. Bir katalog, aynı içerik varlıkları arasında yinelendiğinde bunlardan birini bildirir; aksi halde bunlar olmadan yayımlanır. Her biri tek bir içerik türü tutar ve bir başvurudaki parça (#/schemas/, #/mappings/, #/workloads/, #/artifacts/) başvurunun hangi kitaplığı adreslediğini belirtir.
- SchemaLibrary — yeniden kullanılabilir JSON Schema 2020-12 tanımları ve isteğe bağlı parametreli yardımcılar; bir Component’in veya Feature’ın şemalarından
$ref: <Library>#/schemas/<name>ile başvurulur. - MappingLibrary — yeniden kullanılabilir Go şablon parçaları; bir Recipe’nin veya FeatureRecipe’nin
valuesMapping:alanına$import: <Library>#/mappings/<name>ile içe aktarılır. - WorkloadLibrary — yeniden kullanılabilir Workload içeriği; bir Recipe’nin veya FeatureRecipe’nin
workload:alanına$import: <Library>#/workloads/<name>ile içe aktarılır. - ArtifactLibrary — yardımcı çıktı dosyalarının yeniden kullanılabilir paketleri; bir Recipe’nin veya FeatureRecipe’nin
artifacts:alanına$import: <Library>#/artifacts/<name>ile içe aktarılır. Yeniden kullanım birimi pakettir: tek bir içe aktarma, paketteki her dosya için bir çıktıya genişler.
Platforma ait türler
- Workload — platforma ait derleyici türü (kullanıcı tarafından yazılan bir katalog varlığı değildir). Bir Recipe’nin
workload:alanına (satır içi veya$import:aracılığıyla) gömülür; sağlayıcının sağlayıcıya özgü manifestlere sentezlediği dağıtım biçimini tanımlar.