Adlandırma uzlaşımları
Bu bölüm, yazılan Aggrega içeriğine uygulanan adlandırma ve büyük/küçük harf kurallarını ele alır: kullanıcının yazdığı örnek adları için desen, DSL’deki alan adları için büyük/küçük harf disiplini, platformun sizin yerinize kendisinin tanımladığı tanımlayıcılar için kullandığı büyük/küçük harf biçimi ve YAML yazım yüzeyinde kullanılan yorum sözdizimi.
Örnek adları
Kullanıcının yazdığı örnek adları — geliştiricinin bileşenler, özellikler, aggregate’ler, alt sistemler, sınırlar ile uses soketleri ve takma adlar için yazdığı anahtarlar — tek bir kalıpla eşleşir: ^[a-zA-Z0-9_-]+$. Hem kebab-case (pii-filter, my-agent) hem de snake_case (openai_key, db_credentials) geçerlidir; ekipler tercih ettikleri uzlaşımı benimseyebilir.
İzin verilen karakterler: alfasayısal karakterler (a-z, A-Z, 0-9), kısa çizgiler (-) ve alt çizgiler (_). Başka hiçbir karaktere izin verilmez.
Örnekler:
components: web-server: # kebab-case finance_worker: # snake_case
features: pii-filter: # kebab-case audit_logger: # snake_case openai_key: # snake_case — natural for a credential attachment db-password: # kebab-case — also valid| Kalıp | Kapsam | Örnekler |
|---|---|---|
^[a-zA-Z0-9_-]+$ | Kullanıcının yazdığı tüm örnek adları | web-server, openai_key, pii-filter |
Kalıp, çözümleme sırasında JSON Schema patternProperties aracılığıyla uygulanır.
Bir bileşen adının maliyeti ve büyük harflerin bazı hedeflerde neden daha pahalı olduğu
Yukarıdaki kalıp neler yazabileceğinizi söyler. Bir adın maliyeti ise ayrı bir sorudur ve bileşenin dağıtıldığı hedefe göre değişir; bu nedenle bunu, bir derleme bir adı reddettiğinde değil, ad seçmeden önce bilmeniz yararlıdır.
Bir bileşenin adı, ürettiği her kaynağa damgalanan kimlik olur ve her hedef kendi adlarını bu kimlikten türetir: bir chart yükleyicisi bir release adı, bir konteyner orkestratörü servis adları türetir. Alfabesi kalıptan dar olan bir hedef, kabul etmediği bir karakteri taşıyamaz ve Aggrega böyle bir karakteri sessizce benzer bir karaktere dönüştürmez; bir yazarın ayırt edebildiği iki ad, bir kümede tek bir ada dönüşmemelidir. Bu nedenle hedefin kabul etmediği bir karakter bunun yerine bir kaçış dizisi olarak yazılır ve kaçış dizisi, yerini aldığı karakterden daha uzundur.
Pratik sonuç: büyük harf bazı hedeflerde ücretsiz, bazılarında ise pahalıdır.
- Adlarında büyük harfe izin veren bir hedefte — örneğin bir konteyner orkestrasyonu compose dosyasında —
PaymentsAPItam olarak yazdığınız gibi aktarılır ve on bir karakter tutar. - Adları yalnızca küçük harf olan bir hedefte — bir chart yükleyicisinin release adında — her büyük harf kaçışlanır ve yalnızca altı büyük harften oluşan bir ad bile o hedefin kabul ettiği sınırı aşar.
İkinci ve daha keskin bir etki daha vardır: kaçış dizisi kısa çizgiyle başlar. Bu nedenle bir adın küçük harf veya rakamla başlamasını gerektiren bir hedef, ilk karakteri kabul etmediği bir karakter olan adı, geri kalanı ne kadar kısa olursa olsun reddeder; hiçbir kısaltma bunu çözmez.
Yönerge bu iki etkiden çıkar. Kelimeler arasında kısa çizgi kullanarak küçük harfleri ve rakamları tercih edin ve adı küçük harfle başlatın. payments-api, Aggrega’nın sağlayıcı sunduğu her hedefte değişmeden aktarılır. payments_api bir compose dosyasında aktarılır, ancak kaynak adları alt çizgi kabul etmeyen helm hedefinde aktarılmaz: bileşenin adını verdiği Service’ler, iş yükleri ve release payments-zuapi olarak yazılır. PaymentsAPI orada daha da pahalıdır. Böyle bir kaynağın adresini yayımlayan bir Recipe, hedefin kendi yazımını tahmin etmek yerine okur; bkz. templates/rendered-resource-names.md.
Baştaki bir rakamı yazmak geçerlidir ve compose dosyasında hiçbir maliyeti yoktur, ancak helm hedefi bunu reddeder. Bir Kubernetes Service adı harfle başlamalıdır ve bir chart’ın veya sentezlenmiş bir iş yükünün ürettiği Service’ler bileşenin adını taşır; bu nedenle 1cache adlı bir bileşen, kümenin reddedeceği Service’leri oluşturmak yerine bir helm derlemesini durdurur — ret mesajı bileşeni adlandırır ve Service adının harfle başlaması gerektiğini belirtir.
Bunların hiçbiri derleyicinin kendi başına uyguladığı bir kural değildir; derleyici hiçbir hedefin adlandırma kurallarını tutmaz ve hiçbir sınır uydurmaz. Her hedefin sağlayıcısı kendi adlarından sorumludur; bu nedenle bir ad yalnızca bileşenin gerçekten dağıtıldığı hedef onu kullanamayacağını söylediğinde reddedilir ve ret, o hedefin kendi gerekçesini taşır ve yazdığınız spec.components anahtarını gösterir. Bir hedefte sorunsuz olup başka bir hedefte reddedilen bir ad bir tutarsızlık değil, beklenen davranıştır.
Aggrega’nın kendisinin oluşturduğu adlar — örneğin bir sınıra eklenen bir özelliğin kimliği — tam tersi şekilde ele alınır: reddedilmek yerine hedefe sığacak şekilde kısaltılır, çünkü birkaç yerde yazılmış parçalardan bir araya getirilirler ve hiçbir yazar ulaştıkları uzunluğu tek başına göremez. Yalnızca sizin yazdığınız bir ad reddedilir.
Ayrılmış yol ayırıcısı olarak nokta
Nokta karakteri (.), kullanıcının yazdığı tüm örnek adlarında kullanılamaz; ayrılmıştır. Nokta, aggregate’ler arası component başvuruları için derleyicinin ürettiği bir yol ayırıcısı olma yapısal amacına hizmet eder.
Bir kök Aggregate, main-db adlı bir component içeren data-layer adlı bir alt aggregate’i içe aktardığında, derleyici aggregate örnek adını ve component örnek adını bir noktayla birleştirerek düzleştirilmiş mutlak data-layer.main-db kimliğini oluşturur. Bu noktalı yol şu yerlerde görünür:
- Geliştirici
useshedefleri:target: data-layer.public_db— iç içe bir aggregate’ten dışa aktarılmış bir component’e başvurur. - Derlemenin kendi tanılamaları: o component ile ilgili bir durdurma ya da uyarı, onu noktalı yoluyla adlandırır; böylece okuduğunuz ad, belgelerinizde arayabileceğiniz addır.
Ayırıcı bir ada ulaşmaz
Noktalı bir yol belgelerinizin içindeki bir adrestir ve bir dağıtım hedefinin kabul edeceği bir ad değildir. Bir Kubernetes Service adı hiç nokta kabul etmez; daha kötüsü, bir küme adresindeki nokta bir servisi içinde bulunduğu namespace’ten ayıran şeydir; bu nedenle bir tüketiciye host olarak verilen noktalı bir ad, başarısız olmak yerine farklı bir servise çözümlenir.
Bu yüzden ayırıcı, derlemenin bir component’in kimliğinden türettiği her ad ve etiketten kodlanarak çıkarılır ve değiştirilmek yerine kodlanır: data-layer.main-db, data-layer-zdmain-db olur. Onu bir hedefin kabul ettiği bir karakterle değiştirmek, iki farklı component’in aynı ada varmasına izin verirdi — data-layer.main-db ve birinin data-layer-main-db olarak yazdığı bir component — ve iki component’in vardığı bir ad hiçbirini tanımlamaz.
Bunun neye ulaştığı ve neye ulaşmadığı:
- Kimlikten türetilen ad ve etiketlere ulaşır — Aggrega’nın sentezlediği bir kaynaktaki
metadata.name,aggrega.ai/component-idveapp.kubernetes.io/nameetiketleri, bunlarla eşleşen seçiciler, üretilen dosya adları,{{ .context.instance_id }}ve bir provider’ın kendisi için türettiği ad, örneğin bir helm release adı. Bunlar birlikte değişir; bu nedenle bir Recipe’nin bir kaynağı adlandıran anahtardan oluşturduğu adres — hedefin kaynağı kimliğe göre adlandırdığı yerde.context.instance_id, hedefin kendi adını bildirdiği yerde.context.rendered_name— yine derlemenin ürettiği kaynağı adlandırır. - Sizin yazdığınız bir ada ulaşmaz. Ayırıcı içermeyen bir component adı bayt bayt aynı döner; bu nedenle çıktıda belgedekinden farklı yazılan yalnızca içe aktarılan bir Aggregate’in katkıda bulunduğu component’tir.
- Bir yazarın sağladığı bir chart veya parça içindeki adlara ulaşmaz. Bunlar onları yazana aittir ve üçüncü taraf bir chart’tan taşınan bir ad — noktanın geçerli olduğu
<plural>.<group>biçimindeki bir custom-resource adı — tam olarak o chart’ın yazdığı gibi üretilir.
🔴 Bu son noktanın bir Recipe’nin ne yayımlaması gerektiğine dair bir sonucu vardır ve bu sayfadaki en kolay yanlış yapılan şeydir. Sağlanan bir chart’ın kendi şablonları kaynaklarını platformun onlara verdiği kimliğe göre adlandırır — yukarıdaki alfabeyle değil, o platformun kendi alfabesiyle yazılmış bir release adı — ve helm hedefi sentezlediği workload’ları aynı release adına göre adlandırır. Bu nedenle sağladığınız kaynaktan işlenen çıktı ve böyle bir hedef altında sentezlenen bir workload için {{ .context.instance_id }} bu kaynakların taşıdığı ad değildir ve ondan yayımlanan bir adres, iki alfabe farklı olduğunda hiçbir şeyi adlandırmaz. Platformun adını taşıyan anahtar ve hangi provider’ların bir ad bildirdiği templates/rendered-resource-names.md içindedir.
Ayırıcıyı kodlamak karakter harcar ve sınırlı bir adın karakterleri tükenebilir. Ayırıcı tek bir karakterle değil kısa bir kaçış dizisiyle değiştirilir; bu nedenle nitelenmiş bir kimlik, yazıldığında belgelerinizde okunduğundan biraz daha uzundur. Bu yalnızca dönüştüğü adın sınırlı olduğu yerde önemlidir: bir component’i işleyen hedef ne uzunlukta bir etiket değeri kabul edeceğini söyler ve yazılan kimlik bunu aşacaksa, derleme hedefin reddedeceği bir değer üretmek yerine durur. Durdurma, kimliğin kendisinin sığması gereken uzunluğu belirtir — kodlanmadan önceki uzunluk, böylece bu sınır içinde seçilen bir ad ilk seferde çalışır — ve çözüm yazılmış parçaları kısaltmaktır: içe aktaran belgenin alt aggregate’e verdiği ad veya component’in onun içindeki kendi adı.
Ayırıcı, bir adın okunduğundan daha uzun yazılmasının olağan nedenidir, ancak tek neden değildir. Yazılmış bir adın geçerli olarak alabileceği iki biçim de yazıldığı gibi taşınamaz, çünkü bırakılmaları bir kaçış dizisini belirsiz kılar: tireyle biten bir ad ve tiresinin hemen ardından z gelen bir ad. Her biri aynı şekilde, aynı maliyetle kodlanır. Diğer her yazılmış ad bayt bayt aynı döner; bu nedenle harflerden, rakamlardan, alt çizgilerden ve sözcükler arasındaki tirelerden oluşan bir ad bunların hiçbirinden etkilenmez.
Bir bileşenin kendi uses bloğundaki soket adı, ya katalog varlığının usesSchema içindeki bir anahtarla — bildirilmiş bir soketle — eşleşir ya da geliştiricinin kendi geçici soketini adlandırır; bu soket, hiç usesSchema bildirmeyen bir varlıkta bile derlenir. Bildirilmiş bir soketten tek bir düzenleme uzaklıktaki bir ad, her iki yazımı da belirten bir uyarıya yol açar. Bir Release’in kenar başına uses alanı ve bir Feature ekinin karşılık gelen ayarı yalnızca varlığın bildirdiği bir soketi adlandırabilir; başka herhangi bir ad unknown-uses-socket doğrulama hatasıyla başarısız olur.
Alan harf düzeni
DSL, geliştiriciye yönelik YAML’ı (insanlar tarafından yazılır) dahili derleyici sözleşmelerinden (şablonlar ve araçlar tarafından tüketilir) ayırır:
- Geliştiriciye yönelik YAML (camelCase): Aggregate, Release, Component, Feature, Recipe, FeatureRecipe, Manifest ve Plugin şemalarındaki çok sözcüklü alan adları camelCase kullanır. Örnekler:
exportedComponents,syncWave,subDirectory,featuresSchema,usesSchema,valuesMapping,injectMapping,executionScope,appliesTo,appliesToAnyOf,conflictsWith. Kubernetes API uzlaşımlarını izler. - Dahili sözleşmeler (snake_case): IR Graph şemasındaki ve Template Context şemasındaki çok sözcüklü alan adları snake_case kullanır. Recipe yazarlarının karşılaştığı kullanıcıya yönelik örnekler:
instance_id(.context.instance_idiçinde — Recipe’nin kimliği),inject_raw(.inject_rawiçinde;.contextaltındaki bir anahtar değil,.injectile yan yana duran üst düzey bir sütun — değiştirilmemiş enjeksiyon sözleşmesi),attachment_name(bir ek FeatureRecipe’nin bağlamında — ekin doldurduğu yuvayı veya eklendiği adı belirtir). JSON API uzlaşımlarını izler ve Go’nun JSON struct etiketi üretimiyle uyumludur. - Tek sözcüklü alanlar: Bağlamdan bağımsız olarak küçük harf. Örnekler:
values,infra,inject,provides,locals,features,labels,annotations,boundaries,components,subsystems,pipeline,source.
Geliştiriciler yazdıkları YAML’da snake_case ile karşılaşmaz, şablon yazarları da Go şablonlarında camelCase ile karşılaşmaz. Şema eklemeleri bu uzlaşımları izler.
Tek bir ifadede kesişen üç harf düzeni
Recipe yazımı, tek bir ifadede üç harf düzeni uzlaşımının üçünü de olağan biçimde kesiştirir: şema tanımlı DSL alanı camelCase, kullanıcının yazdığı örnek adı kebab-case ya da snake_case, şablon bağlamı başvurusu ise snake_case kullanır. Bu kesişimleri ayrı uzlaşımlar olarak fark eden yazarlar ortaya çıkan YAML’ı rahatça okur; harf düzenlerini tek bir uzlaşım olarak açıklamaya çalışan yazarlar ise sınırlarda zorlanır.
Kanonik çalışılmış örnek: bir Recipe’nin, işlenen Component örneğine şablon bağlamı üzerinden başvuran valuesMapping: şablonu.
# Recipe authored against a Component the developer instantiated as "web-server"# (kebab-case instance name) in their Aggregate.spec: valuesMapping: | # camelCase — schema-defined DSL field name: "{{ .context.instance_id }}" # snake_case — template context # internal contract image: "{{ .values.image }}" # snake_case — template context # internal contractÜç harf düzeni, tek ifade:
valuesMapping— camelCase. Şemanın Recipe’nin eşleme şablonu için tanımladığı DSL alan adı. Camel, çünkü dilin geliştiriciye yönelik YAML’ı Kubernetes API uzlaşımlarını izler.web-server(işlenen component üzerinden dolaylı olarak başvurulur) — kebab-case. Aggregate’teki kullanıcının yazdığı örnek adı; geliştirici tireli biçimi seçmiştir. Aynı şekildeweb_server(snake_case) de olabilirdi; örnek adı desenine göre ikisi de geçerlidir.instance_id,image— snake_case. Şablon bağlamı içindeki alan adları (.context.instance_id,.values.image). Snake, çünkü IR Graph ve şablon bağlamı JSON-API uzlaşımlarını izler ve Go’nun JSON struct etiketi üretimiyle uyumludur.
Üç harf düzeni birbirinin yerine kullanılamaz. {{ .context.instanceId }} (camelCase) yazan bir Recipe yazarı derlemeyi durdurur: .context anahtarlarını bildirir ve instanceId bunlardan biri değildir; bu yüzden başvuru hiçbir şey işlenmeden reddedilir ve tanılama .context’in tanımladığı anahtarları listeler — bkz. errors/fatal-halts.md “Template references a root the render context does not define (Şablon, işleme bağlamının tanımlamadığı bir köke başvuruyor)”. web.server (noktalı) yazan bir geliştirici örnek adı deseninin reddine takılır, çünkü nokta yol ayırıcı olarak ayrılmıştır. Hedeflenen disiplin: okurken ya da yazarken üç uzlaşımı aklınızda tutun; hangi harf düzeninin geçerli olduğunu bilmek için sınırlara (YAML’da ya da şablonda nerede olduğunuza) güvenin.
Platform tarafından tanımlanan tanımlayıcılar
Yukarıdaki her şey yazım yüzeyindeki adları düzenler: sizin seçtiğiniz bir örnek adı, dilin sizin doldurmanız için tanımladığı bir şema alanı, okuduğunuz bir şablon bağlamı anahtarı. İki ek kayıt ise platformun kendisinin tanımladığı ve sizin yalnızca geri okuduğunuz ya da yazdığınız tanımlayıcıları düzenler. Bunlar ayrıdır, çünkü farklı işler görürler ve biçimi iş belirler.
Betimleyici kayıt: tutarlı biçimde kebab-case. Buradaki bir tanımlayıcı adlandırdığı şeyi sözcüklerle söyler; böylece hiçbir şeye bakmadan onu okuyup ona göre davranabilirsiniz. Bir CLI bayrağı, bir yayımlama lint kuralı kimliği, bir tanılama sınıfı kodu ve bir durdurma koşulunun kaydedildiği kod bu kayda aittir.
--no-unsupported-field-warnings # a CLI flag you typecategory-matches-directory # a lint rule id, printed in `aggrega lint` outputunsupported-field # a diagnostic class codeartifact-provenance-skipped # anotherparameter-contract-violation # the code a halting condition is registered underBir tanılama sınıfının bir bastırma bayrağı olduğunda, kod ile bayrak aynı sırada aynı sözcüklerdir — unsupported-field, --no-unsupported-field-warnings ile susturulur — böylece eşleştirdiğiniz sınıf, çeviri gerektirmeden hangi bayrağa başvuracağınızı söyler. Bir sınıf kodu, araçların bir bulguyu ileti metnini ayrıştırmadan tanımak için eşleştirdiği kararlı addır; ileti ifadesi iyileşebilir, kod değişmez.
Kısa kod kaydı: E harfi ve dört rakam. Bir durdurma koşulu ayrıca bir kısa kod da taşır — E0007 — ve bu, kebab-case olmayan tek platform tanımlı tanımlayıcıdır. Bunun nedeni konumdur: her durdurma tanılamasını kategorinin yanında, okumak üzere olduğunuz dosya ve satırdan önce açar.
[DEVELOPER_ERROR E0007] aggregate.yaml at .spec.components.edgeOraya betimleyici bir kod konamaz. Bunların en uzunu, nereye bakacağınızı söyleyen konumdan önce tek başına dar bir terminali doldurur. Bu nedenle baş kısım genişliğe göre seçilmiş bir tanımlayıcı alır ve bu ödünleşim bilinçlidir: dört rakam bir koşul hakkında hiçbir şey söylemez; bu yüzden her kısa kod, adlandırdığı koşulun ve o koşulun oluşturduğu metnin yanında hata gözcüleri başvurusunda yayımlanır. Bir kısa kodu bir raporda alıntılayın, bir aramaya yazın ve orada çözümleyin.
Her iki kayıt da aynı koşulları iki yönden adlandırır ve hiçbiri diğerinin yerini almaz. Bir koşula göre anahtarlanan bir araç yazarken betimleyici kodu eşleştirin; bir kişiyle bir koşul hakkında konuşurken kısa kodu alıntılayın.
Kebab-case’in burada ve örnek adlarında görünmesi bir çakışma değildir. Örnek adı deseni, neyi yazmanıza izin verildiğiyle ilgilidir — orada kebab-case ve snake_case’in ikisi de geçerlidir ve ekipler birini seçer. Bu kayıt ise platformun gerçekten ne yazdığıyla ilgilidir ve orada seçilecek bir şey yoktur: bir lint kuralı kimliğinin yazımını hiçbir zaman siz seçmezsiniz, bileşen adınızın yazımını da platform hiçbir zaman seçmez.
Alan büyük/küçük harf biçimlerini değiştirmez. Yazılan şema alanları camelCase, şablon bağlamı anahtarları snake_case olarak kalır. Bu kayıttaki tanımlayıcıların hiçbiri iki yüzeyden herhangi birinde bir alan değildir — bunlar bir bayrak, bir kural ya da bir bulgu sınıfı için kısa, kararlı adlardır — dolayısıyla bir tanılama kodunun kebab-case olması, bir şema alanının nasıl yazıldığı hakkında hiçbir şey söylemez.
Belge yolu adlandırma soneki disiplini
Dil genelindeki alanların bir alt kümesi belge yolu değerleri taşır: başka bir belgenin içindeki bir konumu gösteren dizeler (işlenmiş bir Workload’un volumes bölümü, bir Component’in featuresSchema girdisi, bir Manifest’in mappings katmanı). Değerler RFC 6901 JSON Pointer sözdizimini izler: hedef belge içindeki yolu tanımlayan, eğik çizgiyle ayrılmış belirteçler.
RFC 6901, Aggrega’daki her belge yolu yüzeyi için yol dilbilgisinin temelidir. Wasm plugin sözleşmesi, yolları RFC 6901 işaretçileri olan RFC 6902 JSON Patch belgelerini tüketir (plugins/plugin-contract.md label-transform rolü JSONPatch çıktısı uyarınca); URI dilbilgisinin biçim dizesi envanteri, RFC 6901’i Go şablon sözdizimi ve Sprig yardımcılarıyla birlikte adlandırır (vocabulary/uri-grammar.md “Format-string inventory” uyarınca); Recipe başına .locals dışa aktarımları, Wasm Injector plugin’lerinin plugin işlem hattında adımlarının with yükü aracılığıyla aldığı sentezlenmiş Workload konumlarını göstermek için RFC 6901’i kullanır. Tek dilbilgisi, birden çok tüketen yüzey.
Adlandırma soneki disiplini, bu yol değerlerinin iki yazım tarafını, yukarıdaki daha geniş Alan büyük/küçük harf kullanımı bölümüyle uyumlu, bilinçli bir sonek ayrımıyla birbirinden ayırır:
- RFC 6901 JSON Pointer taşıyan şema alanları camelCase
*Pathsonekini kullanır. Bu alanlar geliştiriciye dönük YAML şemasının parçasıdır, bu nedenle camelCase uzlaşımını izler. Hiçbir varlık şeması böyle bir alan bildirmez; bir yazarın yazdığı belge yolları aşağıdaki.localsdışa aktarım anahtarlarıdır. - RFC 6901 JSON Pointer taşıyan
.localsdışa aktarım anahtarları snake_case*_pathsonekini kullanır. Bu anahtarlar Recipe’nin iç dışa aktarım yüzeyinin parçasıdır; Recipe’nin kendi sonraki şablonları ve.locals’a başvuranpipeline[].withyükü aracılığıyla bir Wasm plugin işlem hattı tarafından okunurlar. Bu nedenle snake_case uzlaşımını izlerler. Örnekler:volumes_path: sentezlenmiş Workload’un volumes dizisi konumunu açığa çıkaran.locals.volumes_path: "/spec/template/spec/volumes".containers_path: containers dizisi konumunu açığa çıkaran.locals.containers_path: "/spec/template/spec/containers".resource_path: Terraform’a özgü bir kaynak yolunu açığa çıkaran.locals.resource_path: "/resource/aws_s3_bucket/main".root_path: işleyicinin borusunun tükettiği kök yolu açığa çıkaran.locals.root_path: "/data".
İki sonek uzlaşımı, Alan büyük/küçük harf kullanımı bölümünün iki katmanlı uzlaşımını yansıtır: şemada tanımlı alanlar camelCase kullanır; kullanıcının yazdığı veya Recipe’ye özel tanımlayıcılar snake_case (ya da kebab-case) kullanır. *Path / *_path sonek disiplini, değerin yol dilbilgisi niteliğini tanımlayıcı düzeyinde görünür kılar: iki sonekten birini gören okuyucular, değerin kendisini incelemek zorunda kalmadan değerin RFC 6901 sözdizimini izlediğini bilir.
Uygulamalı örnek: bir Recipe’nin *_path dışa aktarımlarını tüketen bir Wasm Injector.
# Recipe (Domain 3) — declares .locals exports the Wasm Injector consumesspec: locals: primary_compute: "worker-container" containers_path: "/spec/template/spec/containers" volumes_path: "/spec/template/spec/volumes"# Credential FeatureRecipe (Domain 3) — attached to the component the Recipe# above realizes. Its templates read `.locals`: an attachment sees the host# Recipe's resolved locals merged with the attachment's own block.spec: pipeline: - id: workload_injector plugin: pipeline-step/k8s-workload-injector:2.0.0 function: inject_secret with: | target_container: "{{ .locals.primary_compute }}" containers_path: "{{ .locals.containers_path }}" volumes_path: "{{ .locals.volumes_path }}"*_path anahtarları Recipe’ye özel dışa aktarımlardır; containers_path / volumes_path değerleri RFC 6901 JSON Pointer dizeleridir. Injector plugin’i, JSONPatch çıktısını işlenmiş Workload’un AST’sine göre konumlandırmak için bu dizeleri tüketir. Ek, bunlara kendi .locals sütunu üzerinden ulaşır; .context.uses[].locals diye bir alan yoktur, bu nedenle bir tüketici hedefinin locals değerlerini bir uses kenarı boyunca okuyamaz; bir kenardan geçen, hedefin provides değeridir.
Daha geniş biçim dizesi envanteri için (Go şablon sözdizimi, Sprig işlevleri, SemVer regex ve etiket seçici dilbilgisiyle birlikte JSON Pointer) vocabulary/uri-grammar.md “Format-string inventory” bölümüne bakın. RFC 6901 işaretçileriyle adreslenen RFC 6902 yamalarını tüketen Wasm plugin sözleşmesi yüzeyi için plugins/plugin-contract.md belgesine bakın.
Yorum sözdizimi
Yorum karakterleri, çevreleyen dile bağlıdır:
- YAML bağlamı (her Aggrega varlığı için varsayılan yazım yüzeyi):
#kullanın - Go şablon bağlamı (Recipe
valuesMapping:blok skalerlerinin, FeatureRecipeinjectMapping:blok skalerlerinin, MappingLibrary eşleme girdilerinin ve onaylama bloğuassertions:gövdelerinin içinde): şablon motorunun tanıdığı ve işleme zamanında ayıkladığı şablon yorumları için{{/* ... */}}, şablon gövdesinin dışındaki YAML düzeyindeki yorumlar için ise#kullanın.
schema:, usesSchema:, featuresSchema: ve parameters: altındaki kısa biçimli şemalar baştan sona YAML’dir; alan başına description: ek açıklaması, satır içi alan belgelendirmesi için belgelenmiş yüzeydir (port: { type: integer, description: "TCP listen port" }).