İşlenmiş bir kaynağı adlandırma
Bir Recipe çoğu zaman kendi çıktısının ürettiği bir şeyi adlandırmak zorundadır: provides: aracılığıyla yayımlanacak bir ana makine adı, bir valuesMapping: içindeki bir başvuru, bir artifacts: gövdesine yazılan bir tanımlayıcı.
Bunun için kullanılabilecek adları iki şablon bağlamı anahtarı taşır ve bu anahtarlar farklı sorulara yanıt verir.
Yanlış olanı okumak reddedilen değil, sessizce yanlış olan bir çıktı üretir (hiçbir şeyin üretmediği bir kaynağı adlandıran bir adres); bu nedenle bu sayfa hangi anahtarın hangi soruya yanıt verdiğini açıklar.
Sayfa ayrıca iki anahtarın dayandığı ayrımı da açıklar: bir hedef ile bir başvuru aynı şey değildir ve bir hedef hiçbir zaman bir dağıtım platformunun çözümleyeceği bir ad değildir.
Hedef bir bileşeni adlandırır; referans ise işlenmiş bir kaynağı adlandırır
Hedef, bir yazım kimliğidir. Bir geliştiricinin bir kenarın hangi bileşeni gösterdiğini belirtmek için yazdığı değerdir — bir uses bloğundaki target: my_db — ve derlemenin o bileşeni bulmak, tanılamalarda onu raporlamak ve olgularını anahtarlamak için kullandığı kimliktir. Her sağlayıcı altında aynı okunur, çünkü herhangi bir platformla değil, sizin belgelerinizle ilgili bir olgudur.
Referans, işlenmiş bir yapıtın başka bir yapıtı göstermesini sağlayan şeydir. Tek bir sağlayıcının kendi sözcük dağarcığıyla yazılır: helm altında küme içi bir adres, compose altında bir servis adı, terraform altında bir enterpolasyon, cloudformation altında içe aktarılmış bir değer. Referans her sağlayıcı altında farklıdır, çünkü her platform referansları kendi yöntemiyle çözümler.
🔴 Hedef asla işlenmiş çıktıya yazılmaz. Her sağlayıcı kendi adlarını türetir; bu nedenle bir platforma ad olarak verilen yazılmış bir kimlik, iki yazım farklı olduğunda yanlıştır — ve bunlar tam olarak hedefin kendi alfabesinin kabul etmediği karakterlerde farklılaşır. Böyle bir karakter içermeyen bir kimlik değişmeden kalır; hatayı yapmayı kolaylaştıran da budur: hata, biri bir bileşeni alt çizgi ya da büyük harfle adlandırana kadar çalışır.
Bu nedenle tüketicinin ihtiyaç duyduğu referansı üretici yayımlar, çünkü kendi sağlayıcısının sözcük dağarcığını bilen, üreticinin Recipe’idir — tüketici tamamen farklı bir sağlayıcı bağlayabilir ve işleme yapmadığı bir platform için referans yazamaz. Tüketici sıradan, yayımlanmış bir dize okur.
Uygulamalı çift
Üreticinin Recipe’i adresi yayımlar; tüketici bunu kenarın takma adı üzerinden geri okur.
# The PRODUCER's Recipe — a helm Recipe sourcing a chart the author supplied.# It publishes an in-cluster address built from the name that chart's own# templates render their resources against.spec: capability: helm source: ./charts/postgres provides: host: "{{ .context.rendered_name }}.svc.cluster.local" port: "5432"# The CONSUMER's Aggregate — it names the producer by its TARGET, which is an# authoring identity and stays in the documents. The uses block is keyed by the# socket the catalog entity declares, then by the alias you choose for the edge.spec: components: api: type: core/compute/api-server uses: databases: primary: target: my_db inject: env: - in: DB_HOST from: host - in: DB_PORT from: port# The CONSUMER's Recipe — it reads the published REFERENCE, never the target.# The context keys an edge by its alias, so the socket does not reappear here.spec: capability: helm valuesMapping: | { "db_host": "{{ .context.uses.primary.provides.host }}" }helm altında yazar tarafından sağlanan bir chart için, my_db adlı bir bileşen kaynaklarını my-zudb release adı altında işler. Böylece üreticinin chart’ı metadata.name değeri my-zudb olan bir Service üretir, yayımlanan host değeri my-zudb.svc.cluster.local olur ve tüketici, değeri .context.uses.primary.provides.host üzerinden okusa da enjekte edilmiş DB_HOST olarak alsa da var olan bir Service’e bağlanır.
Orada {{ .context.uses.primary.target }} yazmak bunun yerine my_db.svc.cluster.local yayımlar. Bu değer yanlış görünmez: geliştiricinin yazdığı kimliktir, tam da yazdığı gibi yazılmıştır. Yalnızca hiçbir Service’i adlandırmaz ve derlemede bunu belirten hiçbir şey yoktur.
Bir çift olarak iki anahtar
Anahtarlardan hiçbiri tek başına anlaşılır değildir, çünkü her biri diğerinin ne olmadığıyla tanımlanır.
| Anahtar | Neyi adlandırır |
|---|---|
{{ .context.instance_id }} | Düğümün kimliği ve bu düğüm için oluşturulan, hiçbir sağlayıcının ad türetmediği kaynakların adı: artifacts: bloğunuzdan yerleştirilen bir yapıt kümesi ve compose’un yaptığı gibi onu kimliğe göre adlandıran bir sağlayıcının workload: bloğunuzdan sentezlediği bir iş yükü. Her zaman bulunur. |
{{ .context.rendered_name }} | Bağlı sağlayıcının bu düğüm için oluşturduğu kaynaklara türettiği ad: sizin sağladığınız kaynak için, sağladığınız kendi şablonlarınızın kaynaklarını oluşturduğu ad, örneğin bir chart’ın okuduğu release adı; sağlayıcının sentezlediği bir workload: için ise, helm’in yaptığı gibi bu kaynakları kimliğe göre değil kendi bir adına göre adlandırdığı durumda onlara verdiği ad. Yalnızca o sağlayıcı bir ad türettiğinde bulunur. Bir Feature ekinin kendi şablonlarında, ana bileşenin adıdır; aşağıya bakın. |
Bu ayrım, adın nerede kullanılabilir olması gerektiğinden kaynaklanır. Sizin sağladığınız bir chart’ın veya modülün şablonları vardır ve bu şablonlar kaynaklarını platformun onlara verdiği kimliğe göre adlandırır; bu nedenle ad, o platformun kullanacağı ad olmalı ve o platformun kendi alfabesiyle yazılmalıdır. Sentezlenmiş bir iş yükünün sizin şablonlarınız yoktur, ancak kaynaklarının yine de platformun kabul ettiği adları taşıması gerekir: adları, yazılmış bir adın taşıyabileceği her şeyi kabul eden bir sağlayıcı onları kimliğe göre adlandırır; adları bunu kabul etmeyen bir sağlayıcı ise türettiği ada göre adlandırır ve ardından bu adı burada bildirir; böylece onu hiçbir zaman tahmin etmeniz gerekmez.
Hem sağlanmış bir kaynak hem de bir workload: bildiren bir düğüm, iki tür çıktıyı aynı anda üretir ve üçüncü bir anahtara ihtiyaç duymaz. helm altında ikisi de tek release adına göre adlandırılır, bu yüzden rendered_name her ikisine de hizmet eder: chart’ın kendi kaynakları, şablonları onu nasıl oluşturursa oluştursun bu adı taşır ve sentezlenen her Service <rendered_name>-<service key> olur. Sentezlenmiş bir iş yükünü kimliğe göre adlandıran bir sağlayıcı altında, o iş yükünün kaynaklarını instance_id ile, sağlanmış çıktınınkileri ise sağlayıcının onun için bildirdiği adla adlandırın.
İkisinin farklı olabilmesinin nedeni alfabelerdir. Yazılmış bir bileşen adı alt çizgi veya büyük harf taşıyabilir; bir chart’ın release adı taşıyamaz ve türetme, böyle bir karakteri benzer bir karaktere indirgemek yerine (bu, ayırt edebildiğiniz iki bileşenin bir kümede tek bir ada varmasına yol açardı) onu açıkça yazar. O sağlayıcının kendi alfabesi ve uzunluk sınırı için ../providers/helm.md “How the release name is derived” bölümüne bakın.
Hangi sağlayıcılar bir ad bildirir ve diğerleri neden bildirmez
helm bir ad bildirir: release adı. Kaynak olarak verilen bir chart bunu .Release.Name olarak okur ve kaynaklarını genellikle bu ada göre adlandırır; sağlayıcı da bir component için sentezlediği her kaynağı bu ada göre adlandırır: denetleyiciyi doğrudan release adıyla, her Service’i ise <release name>-<service key> olarak. Bu nedenle iki çıktı türünden biri için yayımlanan bir adres rendered_name üzerinden oluşturulur. Yalnızca bir yapıt kümesi yerleştiren bir düğüm için hiçbir ad bildirmez: o kümedeki adlar, yazarının yazdığı adlardır.
# A synthesized helm Recipe publishing the address of the Service its workload# declares under the key `default`.spec: capability: helm workload: | apiVersion: aggrega.ai/v1beta1 kind: Workload containers: main: image: "valkey/valkey:8" ports: redis: 6379 services: default: type: ClusterIP ports: redis: 6379 provides: host: "{{ .context.rendered_name }}-default" port: "6379"cache adlı bir component cache-default yayımlar, my_cache adlı bir component ise
my-zucache-default yayımlar; her iki durumda da bu, derlemenin ürettiği Service’in adıdır.
Diğer dördü hiçbir ad bildirmez ve nedenleri aynı değildir. Hiçbiri destek bekleyen bir sağlayıcı değildir: her durumda ya bildirilecek türetilmiş bir ad yoktur ya da istediğiniz ada zaten başka bir yoldan erişilebilir.
-
cloudformationvecompose: adları siz yazdınız ya da kimlik addır. Bir cloudformation Recipe’i kaynaklarının mantıksal kimliklerini kendisi yazar ve sağlayıcı bunları tam yazıldığı gibi okur; sizin sağladığınız bir compose dosyası kendi servislerini adlandırır ve sağlayıcı bu dosyayı içindeki hiçbir şeyi yeniden adlandırmadan birleştirir ve etiketler.compose’un sentezlediği bir workload, düğümün kimliğine göre adlandırılır; bir compose dosyası bu kimliği yazıldığı gibi kabul eder, bu yüzden{{ .context.instance_id }}o addır. Bildirilecek bir türetme yoktur ve adlar kendi belgelerinizde yer alan adlardır. Bu ad, workload’un ana servisinin, yani bir eşin ulaştığı servisin adıdır; taşıdığı bir sidecar veya init servisi, Bir sidecar veya init servisinin nasıl adlandırıldığı bölümünde açıklandığı gibi, aynı kimlikten ve container’ın adından--ile birleştirilerek adlandırılır. -
terraform: ad, dosyaların nereye yerleştirildiğinin bir işlevidir. Bir katkıda bulunanınmodulebloğu, yapılandırmasının yazıldığı çıktı dizinine göre adlandırılır; bu dizin bir düğüm işlenirken değil, sınırın dosyaları bir araya getirilirken belirlenir. Bir Recipe’in şablonlarının çalıştığı noktada bu konum henüz yoktur. -
helm-chart: türettiği ad, yerleştirilen chart’ın kendi adresidir ve bu, o chart’ın şablonlarının işlendiği addan farklı bir şeydir. Bu sağlayıcı, vendor olarak eklediğiniz bir chart’ınnamealanını onu katkı olarak sağlayanın kodlanmış kimliğine ayarlar; bu aynı zamanda şemsiye chart’ın o alt chart’ı bağladığı takma ad ve değerlerinin kapsamlandığı anahtardır. Bir component için bu kimlik{{ .context.instance_id }}’nin taşıdığı değerdir; dolayısıyla yerleştirilen chart’ın adına, ne olduğunu söyleyen anahtar altında zaten erişilebilir. Vendor olarak eklenen chart’ın kendi şablonlarının işlendiği ad release adıdır; bunu bu sağlayıcı türetmez, kurulum anında şemsiye chart’ın release’i sağlar; bu yüzden burada bu anahtarın bildireceği böyle bir ad yoktur. Bkz.../providers/helm-chart.md“The chart name the umbrella owns”.
Ad bildirilmeyen yerde anahtarın okunması
Sağlayıcısı böyle bir ad bildirmeyen bir düğümde {{ .context.rendered_name }} okunması derlemeyi
durdurur ve tanılama, bunun yerine hangi anahtarın yazılacağını söyler. Boş bir değer işlenmez: bir
segmenti eksik olan bir adres, dağıtılan yanlış bir yapıttır ve bu, duran bir derlemeden daha kötüdür.
Durdurmanın sunduğu çözüm, başvuruyu nereye yazdığınıza değil düğüme bağlıdır:
- Kendisi için ad bildirmeyen bir sağlayıcı altında, kendine ait hiçbir kaynak sağlamayan bir düğümün
kaynakları kimliğine göre adlandırılır; bu nedenle durdurma
{{ .context.instance_id }}anahtarını önerir — doğru bir değer vardır ve tanılama bunu söyler. - Kendisi için ad türetmeyen bir sağlayıcı altında kaynak sağlayan bir düğümün yerine geçecek bir değeri yoktur. Durdurma bir öneri sunmak yerine bunu söyler, çünkü sizi orada kimliğe yönlendirmek, düğümünüzün taşımadığı kaynakları adlandırmak olurdu.
Bu reddetme provides: alanını ve bir Recipe’nin satır içi yazdığı diğer tüm şablonları kapsar — onun
valuesMapping: alanı, workload: gövdesi, her artifacts: girdisi ve her ardışık düzen adımının with: ve
when: alanları.
🔴 Her iki içe aktarma biçimi de bunun dışındadır. $import: aracılığıyla sağlanan bir valuesMapping:,
workload: veya artifacts: girdisi — içe aktarma ister yerel bir dosyayı ister bir kütüphane girdisini adlandırsın —
işleme onu çözümleyene kadar Recipe’nizde hiçbir metin taşımaz; bu nedenle böyle bir gövdenin içindeki bu
anahtara yapılan başvuru denetlenmez. Gövde, içe aktaran düğümün sağlayıcısı bir ad bildiriyorsa o adı işler,
bildirmiyorsa durdurma yerine boş bir değer işler. Bu yüzden içe aktarılan bir gövde, anahtarı yalnızca onu içe aktaran
her Recipe ad bildiren bir sağlayıcıya bağlandığında okur — örneğin bir chart sağlayan helm Recipes için yazılmış
ve açıklamasında bunu belirten bir kütüphane girdisi. Sağlayıcısı ad bildirmeyebilecek içe aktarıcılar için yazılmış bir
gövde ise adı bunun yerine içe aktaran Recipe’nin ayarladığı bir değer aracılığıyla alır.
Bir Recipe’nin locals: girdileri anahtarı hiç okumaz. Bir yerel değer, bağlamını Recipe’nin
source: şablonuyla paylaşır ve düğümün kaynak sağlayıp sağlamadığı adın bağlı olduğu etkenlerden biridir;
bu nedenle ad orada sunulmaz. Bu yüzden bir yerel değerdeki {{ .context.rendered_name }} başvurusu, sağlayıcı
ne bildirirse bildirsin, işleme bağlamının tanımlamadığı bir başvuruya ait tanılamayla (E0060) derlemeyi durdurur;
bu tanılama .context.instance_id anahtarını .context öğesinin orada sunduğu tek anahtar olarak listeler.
Anahtarı, ona ihtiyaç duyan provides: girdisinde veya satır içi şablonda okuyun.
Bir Feature ekinin kendi şablonlarında
Bir Feature ekinin FeatureRecipe’inin yazdığı şablonlarda — locals:, source:, provides:,
injectMapping:, valuesMapping:, workload:, her artifacts: girdisi ve her işlem hattı adımının
with: ve when: alanları — {{ .context.rendered_name }} ana bileşenin adıdır: ana bileşenin kendi sağlayıcısının, ana bileşen için işlediği kaynaklar için bildirdiği ad; bu, ana bileşenin kendi Recipe’inin okuduğu değerdir. Bu anahtar, söz konusu şablonlarda ana bileşenin kimliği olan {{ .context.instance_id }} ile eşleşir; ekin kendisi ise .attachment_name değeridir. Bir bileşenin bağlantılarından birine yazılan ek, tüketen bileşenin adını okur, çünkü o bileşen ekin ana bileşenidir.
Bir ekin kendi kaynak adları bu anahtardan oluşturulur. Bir Secret’ı, bir rotayı ya da bir politikayı eklendiği bileşenin adıyla adlandıran bir FeatureRecipe, platformun kabul ettiği bir ada ihtiyaç duyar; ana bileşenin yazıldığı haliyle kimliği ise alt çizgi ya da büyük harf içerdiği her yerde böyle bir ad değildir.
helm altında my_db adlı bir bileşen my-zudb bildirir; dolayısıyla root adlı bir ek için
{{ .context.rendered_name }}-{{ .attachment_name }} olarak adlandırılan bir Secret
my-zudb-root olarak işlenir; {{ .context.instance_id }} ise bir kümenin reddettiği my_db-root değerini verirdi.
Ek hangi sağlayıcı üzerinden işlenirse işlensin değer ana bileşenin değeri olarak kalır.
Bu anahtar, ana bileşenin sağlayıcısının bir ad bildirdiği her yerde bulunur — helm altında, Recipe’i bir chart sağlayan ya da bir workload: bildiren ana bileşen — ve ad bildirmediği yerde bulunmaz: yalnızca bir artefakt kümesi yerleştiren ana bileşen ve başka herhangi bir sağlayıcıdaki ana bileşen. Böyle bir ana bileşenin ekinde anahtarı okumak, işleme bağlamının tanımlamadığı bir başvuruya ilişkin tanılamayla (E0060) derlemeyi durdurur; bu tanılama .context anahtarının orada tanımladığı anahtarları listeler. {{ .context.instance_id }} bunlar arasındadır ve böyle bir ana bileşende ana bileşenin kendi kaynakları onun adıyla adlandırılır; bu nedenle ad bildirmeyebilecek ana bileşenler için yazılan bir FeatureRecipe bunun yerine kimliği okur.
Ret, bir FeatureRecipe’in satır içinde yazdığı şablonları, injectMapping: dışında kapsar. Bir
injectMapping: ile FeatureRecipe’in $import: üzerinden sağladığı bir valuesMapping:, workload: ya da artifacts: girdisi denetlenmez: ad bildirmeyen bir ana bileşende oradaki bir başvuru, durdurmak yerine boş bir değer işler.
Bir ek, yazarının sağladığı bir chart’ı teslim ettiğinde, o chart’ın şablonları bilerek ana bileşenin release adına göre işlenir: adı bunun yerine ekten türetmek, chart yazarının bildirdiği ve belki de çoktan dağıttığı kaynakları yeniden adlandırırdı. Tek bir ana bileşendeki iki eki birbirinden ayıran değer .attachment_name değeridir — bkz. ../providers/helm.md
“How the release name is derived”.
Bir bağlantının eklentisinden türetilen adlar
Bir bağlantının taşıdığı eklenti, tüketen bileşenin bir eklentisidir ve <alias>.<slot> olarak adlandırılır: gpt takma adı altında yazılan bağlantının credential yuvası için gpt.credential (bkz. Aggregate’in bağlantı girdisi). Bu birleşik ad, FeatureRecipe’in karşısında işlendiği .attachment_name değeridir ve noktayı taşır.
Bundan iki tür ad ortaya çıkar ve bunlar noktayı farklı biçimde ele alır.
FeatureRecipe’in oluşturduğu bir ad, şablonunun ne yazıyorsa onu korur. Standart kütüphanedeki kimlik bilgisi gerçekleştirmeleri kaynaklarını {{ .context.rendered_name }}-{{ .attachment_name | replace "_" "-" }} olarak adlandırır; dolayısıyla router adlı bir bileşenin gpt bağlantısındaki kimlik bilgisi, nokta dahil router-gpt.credential adlı bir kaynak olarak işlenir ve bu geçerli bir Kubernetes nesne adıdır. Bu türden bir adda nokta, tam olarak şablon onu koruduğunda korunur.
Derlemenin eklentinin kimliğinden türettiği bir ad, noktayı açıkça yazar. Kimlik etiketleri ve üretilen dosya, ana bileşenden ve eklenti adından, bir kimlikten türetilen her adın geçtiği aynı kodlama yoluyla oluşturulur ve bu kodlama noktayı zd olarak, büyük harfi ise kod noktasının kaçış dizisi olarak yazar; çünkü kimlik bir etiket olduğu kadar bir kaynak adı olarak da kullanılır ve bir Service adı ikisini de kabul etmez: gptPro takma adı altında yazılmış bir bağlantı cfr--router--gpt-zx000050ro-zdcredential olur. Yukarıdaki kaynak aggrega.ai/component-id: cfr--router--gpt-zdcredential ile etiketlenir (app.kubernetes.io/name de aynı şekilde) ve helm sağlayıcısı altında router--gpt-zdcredential--router-secret-router-gpt-credential.yaml olarak üretilir. Noktanın neden değiştirilmek yerine açıkça yazıldığını öğrenmek için Adlandırma uzlaşımları içindeki “The separator does not reach a name” bölümüne bakın.
İlgili
- Şablon bağlamı sözleşmesi — bu anahtarların içinde yer aldığı bağlamın tam yapısı.
- Şablon genişletme matrisi — her şablon konumunun hangi sütunları okuduğu.
- Topoloji üçlüsü:
provides,inject,uses— yayımlanan bir değerin bir kenarı geçerek tüketiciye nasıl ulaştığı. - Adlandırma uzlaşımları — bir bileşen adı için neler yazabileceğiniz ve daha dar bir alfabede bir adın neye mal olduğu.
errors/fatal-halts.md— bu sayfanın açıkladığı durma, üretilen iletisiyle birlikte.