Aggrega altyapı tabanı (Recipe) şeması
Üretilmiş başvuru. Elle düzenlemeyin; yayımlanmış JSON Schema’dan yeniden üretin.
Şema kimliği: https://aggrega.ai/schemas/recipe-v1beta1.schema.json
Dev niyetini belirli bir altyapı sağlayıcısına bağlayan, Ops tarafından yazılan işaretçi ve eşleme katmanı. Fiziksel bir sağlayıcı ve katalog bileşeniyle kesin olarak 1:1 ilişkilidir.
Recipe varlıklarının yazımına ilişkin açıklayıcı rehberlik için Recipe 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 “Recipe” | evet | Sabit: "Recipe" |
metadata | object | evet | |
spec | object | evet | Bir Recipe için provider bağlaması, kaynak, değer eşlemesi ve işlem hattı. Toplama yoluyla birleştirilen üç girdi türünü destekler: kaynaklı (source ve üzerine valuesMapping katmanı), sentezlenmiş (workload) ve artifacts (adlandırılmış çıktı dosyaları). Bunlardan ayrı olarak bir Recipe, ‘boundary’ altında, içinde render edildiği sınırın paylaşılan çıktısına dosya ekleyebilir. |
Ek özelliklere izin verilmez.
recipe.metadata
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | En az 1 karakter uzunluğunda. |
version | string | evet | Uygulama recipe’sinin katı Anlamsal Sürümlemesi (ör. 2.1.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. |
Ek özelliklere izin verilmez.
recipe.metadata.maintainers[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
name | string | evet | |
email | string | hayır | |
url | string | hayır |
Ek özelliklere izin verilmez.
recipe.spec
Bir Recipe için provider bağlaması, kaynak, değer eşlemesi ve işlem hattı. Toplama yoluyla birleştirilen üç girdi türünü destekler: kaynaklı (source ve üzerine valuesMapping katmanı), sentezlenmiş (workload) ve artifacts (adlandırılmış çıktı dosyaları). Bunlardan ayrı olarak bir Recipe, ‘boundary’ altında, içinde render edildiği sınırın paylaşılan çıktısına dosya ekleyebilir.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
capability | string | evet | Bu recipe’nin bağlandığı açık provider yeteneği (ör. ‘helm’, ‘terraform’, ‘compose’), yani onu render eden provider türü. ‘implements’ ile aynı üç biçimde isteğe bağlı bir sürüm sabitlemesi kabul eder: sürümsüz (‘helm’), tam (‘helm:1.0.0’) veya ana sürümle uyumlu aralık (‘helm:^1.0.0’). Yalın ad provider türünü seçer; sabitleme varsa, o yeteneğe hizmet eden provider-rendering plugin’inin hangi sürümünün bu recipe’yi render edeceğini seçer: sabitleme yoksa mevcut en yüksek sürüm, tam sabitlemede tam sürüm, şapka işaretinde aralıktaki en yüksek sürüm. Hizmet veren hiçbir plugin sürümünün karşılamadığı bir sabitleme, derlemeyi açıkça durdurur. Provider seçiminden sonraki her şey (çıktı gruplama, yol bölümleri, işlem hattı uyumluluğu ve codec seçimi) yalın yeteneğe göre belirlenir; bu nedenle aynı yeteneğin farklı plugin sürümlerini sabitleyen iki recipe tek bir derlemede bir arada bulunabilir. |
implements | string | evet | Bu recipe’nin hangi katalog component türünü uygulayabileceğini bildirir (tam sürüm ‘core/api-server:1.0.0’, ana sürümle uyumlu aralık ‘core/api-server:^1.0.0’ veya sürümsüz ‘core/api-server’). Derleyici bunu Manifest eşlemelerini doğrulamak ve tanılamalarda ve düzenleyici tamamlamasında aday önermek için kullanır; bir derlemeyi asla çözümlemez. aggrega lint de bunu okuyarak, bir Recipe’nin yayımlanan anahtarlarının karşılaştırıldığı, bildirilmiş provides sözleşmesine sahip Component’i bulur. Manifest eşlemesi, kullanıcının Release’in kilit dosyasında sabitlenen açık uygulama tercihidir. |
source | string veya object | hayır | Altyapı kodunun konumu. Bir URI dizesi ya da provider tarafından tanımlanan anahtarları Recipe’nin şablonlarına ‘.source.*’ olarak sunulan açık, yapılandırılmış bir nesne kabul eder. |
locals | string eşlemi | hayır | Özel Ops Durumu. Bu Recipe’nin şablonlarında ‘.locals.*’ olarak kullanılabilen dahili hesaplama sonuçları. Her girdinin kendisi bir Go şablonudur ve kendi içinde bütün, düğüme özgü bir bağlama göre değerlendirilir: ‘.context.instance_id’, ‘.values’, ‘.infra’ ve bu bloğun o ana kadar çözümlenmiş girdileri. Girdiler yazıldıkları sırayla çözümlenir ve bir girdi KENDİSİNDEN ÖNCE tanımlanmış bir kardeşini OKUYABİLİR; bu durumda kardeşin şablon metnini değil çözümlenmiş değerini alır. Bir girdinin başka bir girdiyi okuduğu her yerde yazım sırası sözleşmenin parçasıdır: bir tanımı okuyucusunun altına taşımak derlemeyi bozar ve bir başvurunun çözümlenmesi için blok asla yeniden sıralanmaz. Bu bloğun DAHA SONRA tanımladığı bir girdiye yapılan ‘.locals. |
provides | string, number veya boolean eşlemesi | hayır | Genel Geliştirici API’si. Sonraki Caller inject çözümlemesi için kullanılabilen sözleşmeye bağlı çıktı değişkenleri. Derleyici provides şablonlarını kendi içinde bütün bir bağlama göre, kendi aralarında herhangi bir sırayla değerlendirir; hiçbir provides girdisi bir diğerini okumaz. Düğümün locals’ı, provides’ından önce locals ön bölümünde çözümlenir; bu nedenle bir provides şablonu ‘.locals’ı okuyabilir ve çözümlenmiş değerleri alır; locals bloğunun bildirmediği bir anahtarı adlandırmak durdurur. Çağıranlar inject anahtarlarını inject hidrasyonu sırasında bu değerlere göre çözümler. Değerler skalerdir; boru hattı onları olduğu gibi taşır ve enjeksiyon sınırında deterministik olarak dizeye dönüştürür. |
valuesMapping | string veya object | hayır | İçerik biçimine göre dağıtım yoluyla üç yazım kipine sahip değer eşleme içeriği. Kip 1 (satır içi): Aggrega bağlamından (.values, .features, .infra) provider’ın beklediği değer biçimini üreten bir Go şablonu dize skaleri (genellikle blok skaler YAML |). Kip 2 (dosya içe aktarma): yerel bir Go şablonu dosyasını gösteren, tam olarak tek anahtarlı bir YAML eşlemesi, $import: ./relative/path.tmpl. Kip 3 (kütüphane içe aktarma): bir MappingLibrary girdisine yalın ad kimliğiyle başvuran, tam olarak tek anahtarlı bir YAML eşlemesi, $import: <Library>#/mappings/<entry> (sürüm Release başına kilit dosyası tarafından sağlanır; başvuruda kayıt defteri sunucusu yer almaz). Nesne biçiminde $import, ^oci:// ile eşleşmemelidir; eşleşen bir değer reddedilir. |
workload | string veya object | hayır | İçerik biçimine göre ayrım yapan üç yazım kipine sahip Workload YAML üreticisi. Kip 1 (satır içi): çıktısı ‘aggrega.ai/v1beta1 Workload’ olarak ayrıştırılan bir Go şablonu dize skaleri. Kip 2 (dosya içe aktarma): tam olarak tek anahtarlı bir YAML eşlemesi, $import: ./relative/path.yaml; yerel bir Go şablonu dosyasını gösterir. Kip 3 (kütüphane içe aktarma): tam olarak tek anahtarlı bir YAML eşlemesi, $import: <Library>#/workloads/<entry>; bir WorkloadLibrary girdisine yalın ad kimliğiyle başvurur (sürüm, Release başına kilit dosyasından gelir; başvuruda hiçbir kayıt defteri ana makinesi yer almaz). Hedef Provider workload sentezini desteklemelidir; standart kütüphane kataloğu bu tür sağlayıcılarda belgelenmiş sözleşme olarak workloadSchema bildirir. Sentez yapamayan bir sağlayıcıya bağlanan workload: içeren bir Recipe, işleme zamanında açıkça durur. Nesne biçiminde $import, ^oci:// ile eşleşmemelidir; eşleşen bir değer reddedilir. |
artifacts | string veya object eşlemi | hayır | Girdi adından artifact içeriği yazımına eşleme. Her girdinin değeri, içerik biçimine göre ayrım yapan üç kipten birini taşır. Kip 1 (satır içi): çıktısı artifact gövdesi olan bir Go şablonu dize skaleri. Kip 2 (dosya içe aktarma): tam olarak tek anahtarlı bir YAML eşlemesi, $import: ./relative/path.yaml; yerel bir Go şablonu dosyasını gösterir. Kip 3 (kütüphane içe aktarma): tam olarak tek anahtarlı bir YAML eşlemesi, $import: <Library>#/artifacts/<entry>; bir ArtifactLibrary paketine yalın ad kimliğiyle başvurur (sürüm, Release başına kilit dosyasından gelir; başvuruda hiçbir kayıt defteri ana makinesi yer almaz). Bir paket, dosya başına bir çıktıya genişler; her biri girdinin anahtarı altında <key>/<filename> olarak iç içe yerleşir. Anahtar, girdinin çıktısını adlandırır: kip 1 veya kip 2 girdisinin anahtarı, yazıldığı gibi kullanılan çıktı dosya adıdır ve kip 2 girdisinin içe aktardığı dosya çıktıyı adlandırmadan içeriği sağlar; bu nedenle aynı adı taşıyan farklı dosyaları içe aktaran iki girdi, iki ayrı çıktıdır. Artifact girdileri, paket dosyaları, kaynak çıktısı ve workload sentezi arasındaki çakışmalar, düğüm işlendiğinde derlemeyi durdurur. artifacts bloğu bir Recipe ve bir FeatureRecipe üzerinde aynı biçimde yazılır — aynı üç kip, aynı anahtardan çıktıya kuralı ve aynı çakışma davranışı —; bu açıklamanın o kısmının her iki türde de aynı olmasının nedeni budur; birisi için yazılmış bir örnek diğerine değiştirilmeden aktarılır. Nesne biçiminde $import, ^oci:// ile eşleşmemelidir; eşleşen bir değer reddedilir. Anahtarlar: Anahtar girdinin çıktısını adlandırdığından tek bir dosya adıyla sınırlıdır: bir harf veya rakamla başlar ve harf, rakam, nokta, kısa çizgi veya alt çizgiyle devam eder. İlk karakterden sonraki noktalar, artifact anahtarlarının taşıdığı uzantıları korur (main.tf, template.yaml, serviceaccount.yaml). Bir /, bir anahtarın bir dosya yerine bir yolu adlandırmasına yol açar; baştaki bir . ise çıktı dizininin dışındaki bir konumu adlandıran .. değerine izin verir — ilk karakter sınıfı ikisini de reddeder. Kütüphane içe aktarmada anahtar, paket dosyalarının altına yerleştiği dizini adlandırır; bu nedenle aynı sınır geçerlidir. Desen: ^[A-Za-z0-9][A-Za-z0-9._-]*$. |
omits | object[] | hayır | Bu Recipe’in kaynağının işlediklerinden neyin dışarıda bırakılacağı — olduğu gibi alınan ve Release’in yayımlamaması gereken bir şey işleyen bir kaynak için: getirilen bir chart’ın işlediği bir belge, örneğin chart’ın her işlemede yeniden ürettiği bir anahtarı tutan bir Secret; getirilen bir compose dosyasının paketlediği bir service, volume veya config; ya da getirilen bir CloudFormation şablonunun bildirdiği bir kaynak. Çoğu Recipe’in buna hiç ihtiyacı olmaz. Her girdi, kaynağın işlediği bir birimi türü, adı ve girdi belirtiyorsa ad alanı ile geldiği subchart ile adlandırır; her biri kaynağı işleyen sağlayıcının sözcük dağarcığındadır — bir chart için kendi kind ve metadata.name değerleriyle bir belge; bir compose dosyası için services:, volumes: veya configs: altındaki anahtarıyla bir service, bir volume veya bir config; bir CloudFormation şablonu için Type değeri ve mantıksal kimliğiyle bir kaynak. O sağlayıcı, bir girdinin eşleştiği her birimi dışarıda bırakır; bir girdinin neyle eşleştiği ve sağlayıcının bir girdi nedeniyle neyi reddettiği, o sağlayıcının kendi belgelenmiş sözleşmesidir. Hiçbir şeyi dışarıda bırakamayan bir sağlayıcı, bu anahtarı bildiren bir Recipe’i herhangi bir şey işlenmeden önce reddeder. Yalnızca source: öğesinin işledikleri filtrelenir — bir workload: veya bir artifacts: girdisi asla filtrelenmez —; bu nedenle anahtar source gerektirir. Her değer bir şablondur ve valuesMapping öğesinin değerlendirildiği bağlama karşı değerlendirilir. Bir girdinin when değeri önce değerlendirilir ve when değeri yanlış sayılan bir değer üreten girdi atılır. Etkin kalan her girdi bir şeyi dışarıda bırakmalıdır: kaynağın işlediği hiçbir şeyle eşleşmeyen etkin bir girdi, girdiyi adlandırarak derlemeyi durdurur. Kaynak yine de tamamen işlenir — bir chart’ın her şablonu yine çalışır, dolayısıyla başarısız olan bir şablon derlemeyi yine başarısız kılar — ve yalnızca çıktısı dışarıda bırakılır. En az 1 girdi. |
boundary | object | hayır | Bu Recipe’in kendi component’inin çıktısına değil, içinde işlendiği sınırın paylaşılan çıktısına kattıkları. Çoğu Recipe’in buna hiç ihtiyacı olmaz: hedefin tüm sınır için bir kez okuduğu bir dosya içindir — örneğin Terraform’un yalnızca bir sınırın kök yapılandırmasında kabul ettiği ve hiçbir zaman tek bir component’in modülü içinde kabul etmediği bir Terraform provider yapılandırması. Bir sağlayıcı bu tür dosyaları yalnızca sözleşmesi boundaryArtifacts bildirdiğinde kabul eder; bildirmeyen bir sağlayıcı için bu bloğu bildiren bir Recipe, herhangi bir şey işlenmeden önce reddedilir. Bir FeatureRecipe böyle bir blok taşımaz. |
outputLabels | string eşlemi | hayır | Recipe yazarının bildirdiği ve bu recipe’in işlenmiş çıktısının ürettiği her nesneye basılan etiketler; her sağlayıcının etiket yüzeyine sağlayıcı tarafından çevrilir (helm sentezi, kaynak işleme ve artifact’ler için Kubernetes metadata.labels; Compose service etiketleri; Terraform .tf.json artifact gövdelerinde kaynak başına etiketler). Sabit köken etiketleriyle aynı yoldan ilerlerler, ancak derleyiciye değil yazara aittirler. aggrega.ai/ ve app.kubernetes.io/ ad alanları platforma özgü köken bilgisi için ayrılmıştır ve yükleme sırasında reddedilir. Hedef sağlayıcı için geçerli bir etiket olmayan bir anahtar veya değer, recipe yazarının sorumluluğundadır; çekirdek, ayrılmış ad alanı kuralının ötesinde etiket karakter kümesini denetlemez. |
outputComponentLabels | string[] | hayır | Bu recipe’nin işlenmiş çıktısına yükselttiği Component kimlik etiketi anahtarları. Her girdi bir etiket anahtarını adlandırır; değer, bu recipe’nin işlediği bileşen örneğinin etiketlerinden alınır, böylece damgalanan etiket burada yinelenen bir değeri değil, o bileşenin bildirilmiş değerini taşır. Yükseltilen etiketler, bunun yerine yerinde yazılmış sabit anahtar-değer çiftleri taşıyan outputLabels ile aynı etiket yüzeyine ulaşır. Her iki blokta bildirilen bir anahtar yükleme sırasında reddedilir; böylece damgalanan her anahtarın tek bir kaynağı olur. aggrega.ai/ ve app.kubernetes.io/ ad alanları platforma özgü köken bilgisi için ayrılmıştır ve yükleme sırasında reddedilir; component.aggrega.ai/hosting gibi kapsamlı bir anahtar bu ayrılmış köklerin dışında kalır ve yükseltilebilir. |
pipeline | object[] | hayır | İşlemeden sonra işlenmiş belge kümesi üzerinde çalıştırılan sıralı Wasm işlem hattı adımları listesi; her adım RFC 6902 yamaları ve yan etkiler döndürür. |
assertions | string eşlemi | hayır | Derleme zamanında alanlar arası doğrulama. Her girdi adlandırılmış bir doğrulamadır: anahtar, hata mesajlarında gösterilen kararlı bir kural tanımlayıcısıdır; değer, {{ fail "message" }} durdurma semantiğine sahip bir Go şablon dizesidir. Bir varlık için birden çok adlandırılmış doğrulama, her örnek için yazarın bildirdiği sırayla değerlendirilir; başarısız olan ilk doğrulama derlemeyi durdurur. Recipe doğrulamaları recipe bağlamasından ve provides değerlendirildikten sonra, işlemeden önce değerlendirilir ve Recipe’in kaynak olarak aldığı belirli chart’ın ya da modülün uygulama değişmezlerini ifade eder. Şablon bağlamı: .values / .infra / .uses / .features / .metadata ile birlikte .provides / .locals / .recipe. Değerlendirici missingkey=error kullanır: tanımsız anahtarlara yapılan başvurular no-such-key tanılamasıyla durur. Yalın başvuru herhangi bir yedek değer çalışamadan durduğu için, düz bir default bu yüzeyde isteğe bağlı alan için yedek değer sağlamaz — başvuruyu hasKey ile koşula bağlayın ya da varlık denetimini doğrudan yapan optional yardımcısını kullanın. Anahtarı index ile okumak da yedek değer sağlamaz: index, haritanın içermediği bir harita anahtarında anahtarı adlandırarak durur. |
Ek özelliklere izin verilmez.
recipe.spec.omits[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
kind | string | evet | Dışarıda bırakılacak birimin türü, kaynağı işleyen sağlayıcının sözcük dağarcığıyla: bir chart için, işlenen bir belgenin kendi kind değeri, örneğin Secret; bir compose dosyası için service, volume veya config; bir CloudFormation şablonu için bir kaynağın Type değeri, örneğin AWS::S3::Bucket. Kaynağın işlediği bir türü adlandırır ve yapılandırılmış bir source: alanının taşıdığı kind: ile ilgisi yoktur. Bir şablondur. |
name | string | evet | Dışarıda bırakılacak birimin adı, kaynağı işleyen sağlayıcının sözcük dağarcığıyla: bir chart için, işlenen bir belgenin kendi metadata.name değeri; bir compose dosyası için, birimin services:, volumes: veya configs: altındaki anahtarı; bir CloudFormation şablonu için, kaynağın mantıksal kimliği, yani Resources altındaki anahtarı. Bir şablondur. |
namespace | string | hayır | Girdinin yalnızca belirli bir ad alanındaki bir birimle eşleşmesi gerektiğinde, dışarıda bırakılacak birimin bulunduğu ad alanı; bir chart’ın işlenen belgelerinde olduğu gibi, çıktısında ad alanları bulunan bir sağlayıcı için geçerlidir. Yoksa veya boş dizgeye işlenirse girdi, ad alanı ne olursa olsun, kendi türünde ve adındaki bir birimle eşleşir. Bir compose dosyasında ve bir CloudFormation şablonunda ad alanı yoktur; bunların sağlayıcıları ad alanı belirten bir girdiyi reddeder. Bir şablondur. |
subchart | string | hayır | Çıkarılacak birimin geldiği alt chart; girdinin yalnızca tek bir alt chart’ın işlediği kopyayla eşleşmesi gerektiğinde kullanılır — bir chart’ın alt chart’larından oluşması gibi, iç içe kaynaklardan oluşturulan bir kaynak için. Bir chart için alt chart’ın kendi adı ya da üst chart’ın bağımlılığının ona verdiği takma ad; iç içe bir alt chart’ın adları en dıştakinden başlayarak / ile birleştirilir: operator veya operator/webhooks. Girdi bu durumda o alt chart’ın kendi templates/ veya crds/ dizininden işlenen bir belgeyle eşleşir; ne chart’ın kendisinin işlediği bir belgeyle ne de onun içine yerleştirilmiş bir alt chart’ın işlediği bir belgeyle eşleşir. Belirtilmediğinde veya boş string olarak işlendiğinde girdi, nereden gelirse gelsin kendi türü ve adındaki bir birimle eşleşir. O adda hiçbir alt chart işlemeyen bir chart, girdiyi adlandırarak derlemeyi durdurur. Bir compose dosyasının ve bir CloudFormation şablonunun alt chart’ı yoktur ve sağlayıcıları alt chart adlandıran bir girdiyi reddeder. Bir şablon. |
when | string | hayır | Girdinin diğer alanlarından önce değerlendirilen satır içi Go şablonu. Yanlış sayılan bir değere işlendiğinde girdi düşürülür: diğer alanları değerlendirilmez, onun nedeniyle hiçbir şey dışarıda bırakılmaz ve eşleşmesi gerekmez. Boş veya bulunmayan bir when girdiyi korur. Doğruluk, boolean benzeri şablon çıktısı için standart uzlaşımı izler: true/True/TRUE dizgeleri, sıfırdan farklı her sayı ve boş olmayan diğer her dizge doğrudur; false/False/FALSE, boş dizge ve sıfır ise yanlıştır. İşlenemeyen bir when derlemeyi durdurur. |
Ek özelliklere izin verilmez.
recipe.spec.boundary
Bu Recipe’in kendi component’inin çıktısına değil, içinde işlendiği sınırın paylaşılan çıktısına kattıkları. Çoğu Recipe’in buna hiç ihtiyacı olmaz: hedefin tüm sınır için bir kez okuduğu bir dosya içindir — örneğin Terraform’un yalnızca bir sınırın kök yapılandırmasında kabul ettiği ve hiçbir zaman tek bir component’in modülü içinde kabul etmediği bir Terraform provider yapılandırması. Bir sağlayıcı bu tür dosyaları yalnızca sözleşmesi boundaryArtifacts bildirdiğinde kabul eder; bildirmeyen bir sağlayıcı için bu bloğu bildiren bir Recipe, herhangi bir şey işlenmeden önce reddedilir. Bir FeatureRecipe böyle bir blok taşımaz.
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
artifacts | string veya object eşlemi | evet | Dosya adından dosya içeriği yazımına bir harita; tam olarak bu Recipe’in kendi artifacts alanı gibi biçimlenir: aynı üç kip — satır içi bir Go şablon dizesi, yerel bir Go şablon dosyasının $import: ile içe aktarılması ya da dosyaları girdinin anahtarı altında <key>/<filename> olarak iç içe yerleşen bir ArtifactLibrary paketinin $import: ile içe aktarılması —, aynı anahtardan dosya adına kuralı ve aynı şablon bağlamı; böylece bir girdi .values, .infra, .locals ve diğerlerini tam olarak bir artifacts girdisinin yaptığı gibi okuyabilir. Farklı olan, her dosyanın nereye yazıldığıdır: bu bileşenin kendi dizinine değil, sınırın birleştirilmiş çıktısını tutan dizine, sağlayıcının kendi birleştirmesinin oraya yazdığı dosyaların yanına bir kez yazılır. Her girdi, bu Recipe’in sınır içinde işlediği her bileşen için değerlendirilir ve bu değerlendirmelerin ürettiği dosyalar ada göre birleştirilir: birkaç bileşen ya da birkaç Recipe tarafından aynı baytlara değerlendirilen bir ad tek bir dosyadır; farklı baytlara değerlendirilen bir ad ise dosyayı ve her katkıda bulunanı adlandırarak derlemeyi durdurur; sağlayıcının kendi birleştirmesinin zaten yazdığı bir ad da aynı sonucu doğurur. Böyle bir dosyaya onu hangi bileşenin yazdığını belirten hiçbir şey eklenmez, çünkü dosya onu bildiren her bileşene aittir. Şablonu boş çıktı üreten bir girdi dosya yazmaz. Girdiler sağlayıcıya verilmez; sağlayıcı sınırın çıktısının geri kalanını bunları okumadan yazar. Nesne biçiminde $import değeri ^oci:// ile eşleşmemelidir; eşleşen bir değer reddedilir. Anahtarlar: Anahtar dosyayı adlandırır, bu nedenle bir artifacts anahtarının uyduğu kurala göre tek bir dosya adıyla sınırlıdır: bir harf ya da rakamla başlar ve harfler, rakamlar, noktalar, kısa çizgiler ya da alt çizgilerle devam eder. Bir / tek bir anahtarın bir dosya yerine bir yolu adlandırmasına yol açar, baştaki bir . ise sınırın çıktı dizini dışındaki bir konumu adlandıran .. değerine izin verir — ilk karakter sınıfı ikisini de reddeder. Kütüphaneden içe aktarmada anahtar, paketin dosyalarının altına yerleştiği dizini adlandırır; bu nedenle aynı sınır geçerlidir. Desen: ^[A-Za-z0-9][A-Za-z0-9._-]*$. En az 1 girdi. |
Ek özelliklere izin verilmez.
recipe.spec.pipeline[]
| Özellik | Tür | Zorunlu | Açıklama |
|---|---|---|---|
id | string | evet | Bu adım için programatik bir tanımlayıcı; bu işlem hattının adımları arasında benzersizdir: iki adımında aynı kimliği bildiren bir belge okunduğunda reddedilir. Aynı işlem hattının sonraki bir adımı bu adımın çıktılarını .steps.<id>.outputs olarak okur. Desen: ^[a-zA-Z0-9_]+$. |
plugin | string | evet | Bu adımın çalıştırdığı Plugin varlığına başvuru; her zaman eklentinin kendi soket türüyle kapsamlandırılır: isteğe bağlı bir sürümle birlikte <pluginType>/<name>, örneğin parser/yaml veya parser/yaml:1.0.0. Kapsam, birkaç biçimden biri değil, zorunludur: kapsamsız bir name:version reddedilir, çünkü iki soket aynı adda bir eklenti barındırabilir ve varlığı çözümlenebilir kılan kapsamdır. Derleme, varlığı içerik adresli .wasm yapıtına çözümler — yapıtın konumu eklentinin kimliğinden ve yapılandırılmış kayıt defterinden bulunur, özeti kilit dosyasında sabitlenir — ve baytları yükler. Çıplak bir .wasm veya yapıt başvurusu burada kabul edilmez. |
function | string | evet | Çağrılacak dışa aktarılmış Wasm işlevi. |
with | string | hayır | Bu eklentinin açık girdi şemasını tam olarak karşılayan bir JSON/YAML eşlemine değerlendirilen satır içi Go şablonu. |
optional | boolean | hayır | true olduğunda, bu adımın bir hatası (bir konuk tuzağı, kümede bulunmayan bir belgeyi hedefleyen bir yama, hatalı biçimlendirilmiş bir yama veya durdurma önem düzeyinde bir tanılama) belirgin bir uyarıya indirgenir: adım öncesi belge kümesi geri yüklenir, bu adımın çıktısı atılır ve işlem hattı devam eder. false olduğunda veya bulunmadığında, herhangi bir adım hatası adım öncesi belge kümesi geri yüklendikten sonra derlemeyi durdurur. |
when | string | hayır | İşlem hattında ilerlenirken değerlendirilen satır içi Go şablonu. Yanlış sayılan bir değere işlendiğinde adım atlanır ve doğrudan geçiş olur: belge kümesi bir sonraki adıma değişmeden akar; hiçbir yama, yan etki veya adım kaydı eklenmez. Boş veya bulunmayan bir when adımı her zaman çalıştırır. Doğruluk, boolean benzeri şablon çıktısı için standart uzlaşımı izler: true/True/TRUE dizgeleri, sıfırdan farklı her sayı ve boş olmayan diğer her dizge doğrudur; false/False/FALSE, boş dizge ve sıfır ise yanlıştır. when ve optional birbirinden bağımsızdır: bir adım ikisini birden bildirebilir. |
Ek özelliklere izin verilmez.