İçeriğe geç
AggregaAggrega
Dil seçin: Türkçe
Bu sayfa makine çevirisiyle çevrilmiştir. İngilizce orijinalini okuyun.

Helm-Chart Provider

helm-chart sağlayıcısı, her derleme yolu için paketlenmiş bir Helm şemsiye chart’ı üretir. helm sağlayıcısı doğrudan GitOps tüketimi için düz Kubernetes YAML’ı üretirken, helm-chart bir chart iskeleti üretir — bir şemsiye Chart.yaml + values.yaml ile katkıda bulunan her düğüm için bir alt chart — ve bu iskelet, aşağı akıştaki araçlar tarafından helm install ile kurulabilir ya da ortama özgü ek özelleştirmeler için projeye dahil edilebilir. Sağlayıcı, derlemeyi (path, provider) başına yapar: bir helm-chart Recipe’ine bağlı her düğüm, sınırın değerlendirilmiş directory: değerinin bileşene özgü subDirectory: ile birleştirildiği konumdaki şemsiyeye katkıda bulunur. Aynı yola değerlendirilen iki sınır, her katkıda bulunanı bir alt chart bağımlılığı olarak listeleyen tek bir birleştirilmiş şemsiye chart’ta birleşir.

Kaynak chart’tan kopyalanan bir alt chart’ın şablonları, yazarlarının yazdığını taşır: sınırın syncWave: <integer> değeri, bir hook üzerindeki helm.sh/hook-weight ve Aggrega köken etiketleri onlara yalnızca chart’ın bunları yazdığı yerde ulaşır. İşlediği her kaynağa argocd.argoproj.io/sync-wave: "<N>", helm.sh/hook-weight: "<N>" ve köken etiketlerini damgalayan, helm provider’ıdır. Bu provider’ın bir alt chart’a eklediği, $import: ile yüklenmiş bir artifact, köken etiketlerini ve argocd.argoproj.io/sync-wave ek açıklamasını taşır, helm.sh/hook-weight taşımaz (aşağıdaki “artifacts: ekleme kuralı” bölümüne bakın). ArgoCD sync-wave ek açıklamasını, Helm ise bir hook’un ağırlığını okur.

Bu sayfa, helm-chart sağlayıcısının yazım başvurusudur. helm ile helm-chart ayrımı için Durum sayfasının Providers bölümüne; sağlayıcılar arası girdi birleştirme modeli için architecture/16-recipe-input-composition.md sayfasına bakın.

Desteklenen girdi türleri

helm-chart provider’ı iki girdi türünü kabul eder:

  • Kaynaklı mod. source: <chart-path> içeren bir Recipe, diskteki bir Helm chart dizinini gösterir. Chart, şemsiye yapının içine bir alt chart olarak kopyalanır; chart’ın kendi name değeri dışında olduğu gibi kopyalanır — bkz. “Şemsiyenin sahip olduğu chart adı”; düğüm düzeyinde herhangi bir işleme ya da şablonlama yapılmaz. Aggrega’nın rolü şablon değerlendirmesi değil, birleştirmedir (sınırın düğümleri genelinde şemsiye derlemesi).
  • $import: ile yüklenen artifacts: modu. Girdi başına $import: olarak yazılmış artifacts: girdileri içeren bir Recipe, helm-chart provider’ının kaynak chart kopyalandıktan sonra alt chart’ın templates/ dizinine eklediği ek şablon dosyaları bildirir. Her dosya, [[ ]] sınırlayıcıları kullanılarak Aggrega’nın şablon bağlamına göre önceden şablonlanır (aşağıdaki “artifacts: ekleme kuralı” bölümüne bakın); böylece aynı dosyadaki tüm {{ }} Helm şablonlamaları, sonraki helm install işlemesine kadar korunur.

helm-chart’ı hedefleyen ve workload: bildiren bir Recipe, işlenmeden önce, herhangi bir provider’ın bildirmediği bir girdi türü için verdiği retle reddedilir — bu ret, bu provider’ın desteklediği türü adlandırır ve yazarı sentezleyen bir provider’a yönlendirir:

provider does not support the node’s input kind (node “api”). provider “helm-chart” does not support synthesized recipes (this provider supports: sourced); declare one of the supported input kinds, or target a provider that supports synthesized (provider düğümün girdi türünü desteklemiyor (düğüm “api”). “helm-chart” provider’ı sentezlenmiş recipe’leri desteklemiyor (bu provider şunu destekler: sourced); desteklenen girdi türlerinden birini bildirin ya da sentezlemeyi destekleyen bir provider’ı hedefleyin)

Bu ayrım bilinçlidir: workload sentezi (soyut bir Workload’ı Kubernetes kaynaklarına çevirmek) yalnızca helm provider’ının işidir. helm-chart’ın rolü, yazarın önceden ürettiği chart’lar için şemsiye + alt chart birleştirmesidir.

helm-chart’ı hedefleyen bir Recipe ayrıca satır içi içerikli artifacts: girdileri de bildirebilir (değeri, $import: ile yüklenen bir başvuru yerine dosya gövdesini Recipe içinde satır içi taşıyan bir blok skaler olan girdiler). Satır içi içerikli bir girdi, alt chart kökünde yazıldığı anahtar altında yerleştirilir — templates/ öneki ve köken ekleme yoktur. Bir chart’ın kendi şablonları böyle serbest bir dosyayı Helm’in .Files.Get / .Files.Glob işlevleriyle okur (standart dosyalardan ConfigMap kalıbı); bu nedenle chart kökündeki bir dosya hata değil, meşru ve birinci sınıf bir biçimdir.

Her iki biçim de yerleştirmeden önce [[ ]] Aggrega sınırlayıcılarıyla değerlendirilir; bu nedenle her iki biçimin gövdesi de Recipe’nin sütun bağlamını okuyabilir; her iki gövdedeki {{ }} olduğu gibi bırakılır ve sonraki helm install sırasında bir Helm yönergesine dönüşür. Biçimler arasındaki fark, dosyanın nereye yerleştiği ve kökenin dosyaya birleştirilip birleştirilmediğidir:

  • $import: ile yüklenen bir girdi bir şablon dosyasıdır: değerlendirmeden sonra (aşağıdaki “artifacts: ekleme kuralı” bölümüne bakın) köken birleştirilmiş olarak alt chart’ın templates/ dizinine eklenir; böylece Helm onu chart’ın kendi şablonlarıyla birlikte bir manifest olarak işler.
  • Satır içi içerikli bir girdi serbest bir veri dosyasıdır: değerlendirmeden sonra chart köküne, değerlendirmenin ürettiği hâliyle değişmeden ve birleştirilmiş köken taşımadan, .Files tabanlı kullanım için yerleşir.

artifacts: ekleme kuralı

Bir helm-chart Recipe’i artifacts: girdilerini girdi başına $import: ile bildirdiğinde, her $import: değeri Recipe’in kendi dizinine göre (diskte Recipe YAML’ını içeren dizin) çözümlenen bir şablon dosyasının yoludur. Sağlayıcı:

  1. Her dosyanın içeriğini okur.
  2. İçeriği, Recipe’in şablon bağlamına (Recipe’in valuesMapping: alanının değerlendirildiği bağlamın aynısı) karşı [[ ]] Aggrega ayraçlarıyla önceden şablonlar. Dosya içeriğindeki {{ }} olduğu gibi bırakılır; bunlar helm install zamanında Helm şablon yönergelerine dönüşür.
  3. Her dosyayı umbrella’nın derleme yolu altında charts/<instance-id>/templates/<authored-key> konumuna yazar; bir paketin dosyaları bu anahtarın altına yerleştirilir. Dosyanın adını, girdinin altında yazıldığı anahtar belirler; $import: yolu dosyanın içeriğini seçer ve ada hiçbir katkıda bulunmaz, bu nedenle o yolun içindeki dizin yapısı çıktıya hiçbir zaman ulaşmaz.

[[ ]] / {{ }} çift ayraç disiplini, yükü taşıyan ayrıntıdır. Tipik bir $import: ile yüklenen artifact dosyası, Aggrega zamanı enterpolasyonunu (ör. [[ .values.image ]]) Helm zamanı enterpolasyonuyla (ör. {{ .Release.Namespace }}) karıştırabilir. Her ayraç çifti kendi aşamasında devreye girer: Aggrega [[ ]] ayraçlarını dosya yerine yerleşmeden önce derleme zamanında çözümler; Helm {{ }} ayraçlarını umbrella teslim edildikten sonra kurulum zamanında çözümler.

Kaynak chart’ın şablonları ile $import: ile yüklenen artifact eklemeleri arasındaki dosya adı çakışmaları CATALOG_ERROR hatası verir; tanılama, templates/cm.yaml gibi çakışan çıktı yolunu ve onu üreten iki girdi türünü adlandırır. Yazarlar çakışmayı artifact’ın anahtarını ya da chart’ın kendi şablonunu yeniden adlandırarak giderir.

source: anahtar kümesi

helm-chart sağlayıcısının source: alanı bir chart adlandırır ve source: alanının aldığı iki biçimi de kabul eder; bunlar tam olarak helm sağlayıcısının source: anahtar kümesi bölümünün açıkladığı gibi okunur: bir yalın dosya sistemi yolu dizesi ve konumu url: alanında taşıyan bir yapılandırılmış nesne. url: bir dosya sistemi yolu adlandırdığında hiçbir şey indirilmez ve chart diskten okunur; bir aktarım şeması taşıdığında — örneğin kind: helm-oci-chart ile birlikte oci://… — aggrega pull chart’ı indirir ve sabitler, derleme de onu önbellekten umbrella’ya bir alt chart olarak, diskten okunan bir chart ile aynı koşullarda kopyalar.

spec:
capability: helm-chart
source: ./charts/api-server # filesystem path to a chart directory
valuesMapping: |
image: "{{ .values.image }}"
replicaCount: {{ optional .infra `replicas` 2 }}

Kaynak yolundaki chart, kökünde geçerli bir Chart.yaml içermelidir; bu dosya yoksa kopyalama çalışmadan önce açık bir hata verilir. Chart’ın dizin düzeni kopyalanırken korunur — templates/, values.yaml, Chart.yaml ve diğer tüm dosyalar birleştirmeden sonra alt chart dizininde bulunur. Her dosya, yorumlara, anahtar sırasına ve tırnaklamaya kadar sizin yazdığınız baytlarla gelir; tek istisna, chart’ın kendi Chart.yaml dosyasındaki ve umbrella’nın belirlediği name alanıdır — bkz. “Umbrella’nın sahip olduğu chart adı”.

Bir chart adlandırmamanın iki yolu da reddedilir ve bu iki ret farklı yerlerden gelir; bunu bilmek önemlidir, çünkü yeteneği değiştirirseniz bunlardan yalnızca biri değişir. Mevcut olan ama hiçbir şey bildirmeyen bir source:, herhangi bir sağlayıcı çalışmadan önce derleyici tarafından reddedilir; bu nedenle sonuç, Recipe hangi yeteneği adlandırırsa adlandırsın aynıdır; tanılama, kaynaksız mod için alanı atlamanızı ya da boş olmayan bir yol adlandırmanızı söyler. source: alanını tamamen atlamak geçerli bir yazımdır — bir Recipe kaynaksız modu böyle ister — ve burada reddedilmesinin nedeni helm-chart’ın yalnızca kaynaklı girdi türünü bildirmesidir; bu yüzden derleyici bu birleşimi, bir yetenekten bildirmediği bir girdi türü istendiğinde verdiği iletinin aynısıyla reddeder. helm-chart’a ait olan şey bildirimdir, kendine özgü bir ret değildir: bir workload: bloğundan üretilen Kubernetes kaynakları için bunun yerine helm yeteneğini kullanın.

omits: bildiren bir Recipe reddedilir. omits: anahtarı, bir kaynağın oluşturduğu belgeleri derlemenin dışında bırakır; bu sağlayıcı ise derleme zamanında hiçbir belge oluşturmaz: chart’ı umbrella’ya kopyalar ve chart’ın şablonları umbrella kurulduğunda oluşturulur. Hiçbir şey oluşturulmadığından dışarıda bırakılacak bir şey de yoktur; bu yüzden bu sağlayıcı anahtarı desteklediğini bildirmez ve onu bildiren bir Recipe ya da FeatureRecipe, herhangi bir şey kopyalanmadan önce reddedilir — bkz. The provider does not support omits (Sağlayıcı omits desteklemiyor). Recipe’nin yanında tuttuğunuz bir chart için, oradaki .aggregaignore dosyasına eklenen bir satır, Recipe bir sonraki sabitlenişinden itibaren chart’ın bir dosyasını bunun yerine dışarıda bırakır; çıktısından bir belgenin çıkarılması gereken indirilmiş bir chart için ise onu anahtarı destekleyen helm sağlayıcısıyla oluşturun.

Yol anahtarlı birleştirme — şemsiye yapısı

Provider, her derleme yolu için iki aşamada çalışır:

  1. Katkıda bulunan başına kopyalama. Provider, bir helm-chart Recipe’ine bağlı her düğüm için kaynak chart’ın tüm dizin ağacını bir alt chart yuvasına kopyalar. Dosyalar, katkıda bulunan başına çıktı eşlemine düz olarak yerleşir; birleştirici, katkıda bulunanlarının altında yer aldığı alt dizin olarak charts adını verir ve düzenleyici, şemsiyeyi birleştirirken her katkıda bulunana orada kendine ait bir dizin verir — bir bileşen için charts/<instance_id>/. Bir Feature eki de bir katkıda bulunandır — ister bir chart’ı bünyesine alsın ister manifest’leri helm provider’ı üzerinden işlesin — ve bileşenin dizininin içinde değil yanında bir dizin alır; bkz. “Bir ekin chart’ı nereye yerleşir”.
  2. (path, provider) başına şemsiye birleştirme. Yol için düğüm başına tüm kopyalamalar tamamlandığında, birleştirici derleme yolunun köküne bir şemsiye Chart.yaml + values.yaml yazar. Şemsiye, katkıda bulunan her düğüm için bir bağımlılık bildirir ve düğüm başına değerleri instance-id anahtarlı alt blokların altına yönlendirir. Derleme yolu birden fazla sınırdan katkıda bulunan aldığında (directory: değerini paylaşan sınırlar), her katkıda bulunan aynı şemsiyede bir bağımlılık olarak yer alır.

Şemsiye Chart.yaml şu yapıdadır:

apiVersion: v2
name: <effective-chart-name> # see "Chart-name resolution" below
version: 0.1.0
description: Aggrega umbrella chart for boundary "<assembly-path>"
dependencies:
- name: <encoded-instance-id> # the name the placed sub-chart carries
version: <user-chart-version> # from the source chart's Chart.yaml
alias: <encoded-instance-id> # see "How a name is derived" below
repository: file://charts/<instance_id> # the sub-chart's own directory

Chart adının çözümlenmesi

Şemsiyenin chart name değeri, sınır açıklaması kademesi üzerinden çözümlenir. Katkıda bulunan her sınırın etkin aggrega.ai/chart-name açıklaması (sınır ağacında yukarı doğru ilerlenerek kademeyle çözümlenen değer) şemsiye adını belirler; çözümlenen değer, chart adı konumu için diğer tüm kimlikler gibi kodlanır, dolayısıyla yalnızca aşağıdaki kuralın koruduğu harfleri, rakamları, alt çizgileri ve kısa çizgileri taşıyan bir değer chart’a olduğu gibi ulaşır. Derleme yolu birden fazla sınırdan katkıda bulunan aldığında, her katkıda bulunanın etkin aggrega.ai/chart-name değeri aynı değere çözümlenMELİDİR; uyuşmazlıklar, çakışan değerleri ve katkıda bulunan sınırları adlandıran bir tanılamayla derlemeyi durdurur.

Kademe, DRY gerilimini doğal biçimde çözer: aggrega.ai/chart-name değerini üst sınırda bir kez bildirin, alt sınırlar bunu kademe yoluyla devralır; ortak bir üst sınırı olmayan kardeş sınırlar eşleşen değerleri açıkça bildirmelidir. Kademelerinin hiçbir yerinde aggrega.ai/chart-name bildirilmemiş sınırlar, aggregate adına ve derleme yoluna — şemsiyenin dist/ altındaki çıktı dizini, örneğin boundaries/data/helm-chart — geri döner; bunların her biri aşağıda açıklandığı gibi kodlanır ve birleştirilir.

Her bağımlılık girdisinin name değeri, yerleştirilen alt chart’ın taşıdığı addır — bileşen örneğinin kendi kodlanmış kimliği, alias ile aynı değer — nedenleri için bkz. “Şemsiyenin sahip olduğu chart adı”. version değeri ise yine kaynak chart’ın kendi Chart.yaml dosyasındaki sürümdür. Alias, alt chart’ın değerlerini values.yaml.<alias>.* altında kapsamlandırır; bu, Helm’in şemsiye değerleri uzlaşımıyla eşleşir ve böylece şemsiye kurulduğunda örnek başına değerler doğru biçimde aktarılır.

Bir bileşenin alt chart dizini instance_id’yi tam olarak yazıldığı gibi korur; bu nedenle charts/<instance_id>/, dosyalarının yerleştiği ve bağımlılığın repository değerinin işaret ettiği yerdir. Böylece aynı kaynak chart’ın iki örneği dosya sisteminde çakışma olmadan bir arada bulunur ve her biri kendi alias’ı altında kendi değer bloğunu korur.

Bağımlılığın name ve repository değerleri farklı dizelerdir ve bu tasarım gereğidir. name, o konumdaki chart’ın BİLDİRDİĞİ addır, çünkü Helm bir bağımlılığı alt chart’a, alt chart’ın kendi bildirdiği adla bağlar; repository ise o chart’ın bulunduğu yerdir. Bir bileşen için ikisi tesadüfen aynı okunur, çünkü ikisi de aynı instance id’den türetilir. Bir Feature eki için farklıdırlar — bildirilen ad ekin birleştirilmiş kimliğini taşırken dizin, birleştirilmiş iki koordinatını taşır — dolayısıyla birini diğeri olarak okumak, orada olmayan bir şeyi adlandırır.

Bir ekin chart’ı nereye yerleşir

Bir chart’ı bünyesine alan bir Feature eki, eklendiği bileşenin yanında, charts/ altında bir düzeyde kendine ait bir dizin alır:

charts/
├── api/ # the component's own chart
├── api--guardrail/ # a Feature attached to `api` under `guardrail`
└── api--audit/ # a second Feature attached to the same component

Bir bileşene değil bir sınıra eklenen Feature’ın adlandırılacak bir barındırıcı bileşeni yoktur; bu nedenle dizini yalnızca örnek adıdır: charts/aux/.

Neden içinde değil de yanında. Helm, alt chart’ı charts/* konumunda bulur — özyinelemeli bir tarama değil, tek bir düzey. Bundan daha derine yerleştirilen bir chart hiçbir şeyin alt chart’ı değildir; başka bir alt chart’ın dizini içindeki veridir ve yalnızca .Files üzerinden erişilebilir. Dolayısıyla bileşenin kendi chart dizininin içine yerleştirilen bir chart çıktıya kopyalanır, derlemenin başarılı olmasını sağlar ve dağıttığınız şeye kaynaklarından hiçbirini katmaz — bunu bildiren hiçbir şey olmadan. Her katkıda bulunanı kendi üst düzey dizinine yerleştirmek, ekin kaynaklarının işlenmesini sağlayan şeydir.

Şemsiye, eki de bağımlılıklarından biri olarak bildirir. İki yarı da gereklidir: charts/ altında bulunan ve dependencies: içinde yer almayan bir chart bir lint hatasıdır; dependencies: içinde bildirilen ve eşleşen bir alt chart’ı bulunmayan bir chart ise şemsiyenin yüklenmeyi reddetmesine yol açar.

İki koordinat art arda eklenmez, birleştirilir. Bir dizin adı, barındırıcıdan ve örnekten, aşağıda açıklanan aynı kaçış kuralıyla oluşturulur; bu kural, koordinatlar -- üzerinde birleştirilmeden önce her birine uygulanır. Bunları doğrudan -- ile yan yana koymak belirsiz olurdu: a--b adlı bir barındırıcı ile c örneği ve a barındırıcısı ile b--c örneği aynı dizine ulaşırdı. Her koordinatı önce kodlamak onları ayrı tutar; dolayısıyla bir koordinat içinde yazılmış --, -zh- olarak görünür.

Dizin adının kabul ettikleri. Büyük ve küçük ASCII harfleri, rakamlar, nokta ve alt çizgi yazdığınız gibi geçer; dolayısıyla API--aux ve web.api--aux beklediğiniz gibi okunur. Yazdığınız bir kısa çizgi, ardından gelen karakter bunlardan biri olduğu her yerde korunur; dolayısıyla web-api--aux değişmez; çift kısa çizgi ise kaçışlanır, çünkü bu çift birleştirme işaretidir. Diğer her şey, bir chart adıyla aynı kuralla kaçışlanır. Küme bu sınırda çizilmiştir, çünkü bu dizin adları hem diskteki yollardır hem de bir bağımlılığın file:// işaretçisinin çözümlendiği konumdur ve bir dosya adında sorun çıkarmayan bir karakter bir URL’yi kesebilir veya yeniden çözümlenmesine yol açabilir.

Değerler dizini değil, bildirilen adı izler. Bir alt chart’ın değerleri, o chart’ın bildirdiği adın altında kapsamlandırılır; dolayısıyla yukarıdaki chart’ın değerleri dizini olarak değil, api--guardrail ekinin bildirilen adı — cfr-zh-api-zh-guardrail — olarak adreslenir.

Bu anahtarı hiçbir zaman kendiniz yazmazsınız. Değerleri ek üzerinde yazarsınız ve şemsiyenin values.yaml dosyası, blok yerleştirilen chart’ın adreslendiği adreste hazır olacak şekilde sizin için oluşturulur. Bir bileşene eklenen Feature için bu, ek üzerinde bildirdiğiniz ve FeatureRecipe’in kendi valuesMapping: alanının okuduğu values: değeridir; bir sınıra eklenen Feature için ise orada bildirdiğiniz infra: değeridir, çünkü sınıra eklenen bir Feature’ın bileşen değerleri ayağı yoktur. Hangisi olursa olsun, valuesMapping: alanının çözümlendiği eşlem, şemsiyede ekin kendi bloğu olur:

# the umbrella's values.yaml, composed for you
api: # the component's own chart
replicaCount: 3
cfr-zh-api-zh-guardrail: # the chart the Feature attached under `guardrail` brought
auditEndpoint: "https://audit.internal"

Bu değerlerin tek yolu budur. Bir Feature’ın getirdiği chart, dosyaları yazarının yazdığı gibi gelir — “Şemsiyenin sahip olduğu chart adı” bölümünde açıklanan tek manifest alanı dışında — bu nedenle değerlerinizi o chart’a hiçbir şey yazmaz ve bunları sağlayan şemsiyenin bloğudur. Bloğu hiç gelmemiş bir chart bozuk bir chart değildir: kendi values.yaml dosyasının getirdiği varsayılanları işler ve başarı bildirir; bu nedenle yazım sırasında farkı görmek istiyorsanız bir varsayılana fark edeceğiniz bir değer verin.

FeatureRecipe’i helm provider’ı üzerinden işlenen bir ek

Bu hedefteki bir bileşene eklenmiş, helm yeteneğine sahip bir FeatureRecipe, bir chart yerine tamamlanmış Kubernetes manifest’leri getirir. Bunlar, helm provider’ının işlediği haliyle ekin kendi dizinine yerleşir ve provider bu dizine, onu Helm’in kurduğu bir chart yapan iki şeyi verir: ekin kendi adını 0.1.0 sürümüyle bildiren minimal bir Chart.yaml ve işlenmiş her YAML dosyasını adıyla Helm’in .Files.Get işlevi üzerinden üreten tek bir şablon, templates/rendered.yaml:

charts/api--guardrail/
├── Chart.yaml # apiVersion: v2, name: cfr-zh-api-zh-guardrail, version: 0.1.0
├── guardrail-config.yaml # the manifest the helm provider rendered
└── templates/
└── rendered.yaml # {{ .Files.Get "guardrail-config.yaml" }}

Bildirilen ad, aynı ekin bünyesine aldığı bir chart’ın bildireceği addır; bu nedenle şemsiyenin bağımlılık girdisi ve değerler bloğu tam olarak yukarıda anlatıldığı gibi adreslenir. .Files.Get, bir dosyanın baytlarını ikinci kez değerlendirmeden olduğu gibi döndürür; böylece değişmez şablon parantezleri taşıyan bir manifest — bir uyarı kuralının {{ $labels.instance }} ifadesi, bir panonun sorgusu — bunlar bozulmadan kurulur. Değerleri, helm provider’ı manifest’leri işlerken bu manifest’lere çözümlenmiştir; bu yüzden şemsiyenin values.yaml dosyasının o ad altında taşıdığı blok hiçbir şey tarafından okunmaz.

Şemsiyenin sahip olduğu chart adı

Aggrega’nın bünyesine aldığınız bir chart içinde değiştirdiği tek şey, o chart’ın kendi name alanıdır. Yerleştirilen chart’ın Chart.yaml dosyasında name, o chart’a katkıda bulunan şeyin kodlanmış kimliğine ayarlanır.

Bir bileşen için bu, bileşen örneğinin kendi kimliğidir — bağımlılığın alias değeriyle aynı değer — ve şemsiyenin bağımlılık girdisi de bu değeri adlandırır; böylece iki taraf her zaman uyuşur.

Bir Feature ekinin getirdiği chart başlı başına bir katkıda bulunandır ve eklendiği bileşenin kimliğini tekrarlamak yerine kendi kimliğini bildirir. Bu kimlik, yazdığınız iki şeyden oluşturulur — eki barındıran bileşen ve Feature’ın altında eklendiği ad — ve önünde, onu bir bileşenin değil bir ekin kimliği olarak işaretleyen kısa bir başlangıç bulunur; oluşturulan değer daha sonra, diğer tüm kimlikler gibi, aşağıdaki türetme yoluyla chart adı konumu için yazılır.

Dolayısıyla chart’ı bünyesine alan bir Feature’ı api adlı bir bileşene guardrail adı altında eklemek, cfr-zh-api-zh-guardrail bildiren bir chart yerleştirir; o bileşenin kendi chart’ı ise yine api bildirir. İkisi ayrı katkıda bulunanlardır ve ikisi de barındırıcınınkini bildirmek yerine her biri kendine ait bir ad bildirir.

Chart’taki başka hiçbir şeye dokunulmaz. Diğer her dosya yazdığınız gibi bayt bayt gelir ve Chart.yaml içinde diğer her alan, her yorum, anahtar sırası ve tırnaklama tam olarak yazıldığı gibidir. Manifest’in başka bir yerinde iç içe bulunan ve tesadüfen yine name olarak adlandırılan bir anahtara — örneğin bir bakımcının adına — dokunulmaz.

Şemsiyenin bu alana neden ihtiyaç duyduğu. Bir chart’ın name değeri, Helm’in bir şemsiyenin bağımlılığını bağladığı şeydir. Bunu chart’ı yazan kişi yazar; upstream’den edinilen bir chart için bu kişi onu dağıtan kişi değildir — dolayısıyla tek bir derleme yolundaki iki bileşen, manifest’leri aynı adı bildiren chart’ları son derece makul biçimde bünyesine alabilir. Her iki alt chart da bu ortak adı koruyacak olsaydı, şemsiyenin her iki bağımlılığı da Helm’in ikisinden önce yüklediğine çözümlenirdi: bir bileşenin chart’ı iki kez işlenir, diğerininki hiç işlenmezdi; her bileşenin değerleri yine de geldiğinden çıktı eksiksiz görünür ama yanlış olurdu. Yerleştirilen adı bileşen örneğinden türetmek ortak adı tamamen ortadan kaldırır; bu yüzden hiçbir şeyin reddedilmesi gerekmez — başka çaresi olmayan iki durum da dahil: adın yapısı gereği ortak olduğu aynı chart’ı iki bileşen altında bünyesine almak ve adını değiştiremeyeceğiniz sizin yazmadığınız bir chart’ı bünyesine almak.

Gözlemleyebileceğiniz tek şey. Kendi chart’ının adını okuyan bir şablon — {{ .Chart.Name }} ve yaygın {{ .Chart.Name }}-{{ .Release.Name }} kaynak adlandırma kalıbı gibi ondan türetilen her şey — kaynak chart’ın Chart.yaml dosyasında yazılan adı değil, kodlanmış örnek kimliğini okur. Böyle bir şablon alan ayarlanmadan önce de bunu okuyordu, çünkü Helm bir alt chart’ı üst chart’ının onu bağladığı alias altında bildirir; alanı ayarlamak, diskteki dosyayı işlemenin zaten ürettiği şeyle uyumlu hâle getirir. Dolayısıyla aşağıdaki örnek için api-east alt chart’ındaki bir şablon api-east okur.

Bir kaynak adının chart’ın yazılmış adını taşıması gerekiyorsa, bu adı chart’ın values.yaml dosyasına koyun ve oradan okuyun — bir değer sizindir ve Aggrega ona dokunmaz.

Bir ad nasıl türetilir

Bir Helm chart adı ve bir Helm bağımlılık alias’ı, bir aggregate adının, bir sınır yolunun veya bir instance_id’nin taşıyabileceğinden daha dar bir karakter kümesini kabul eder. Türetme, hedefin kabul etmediği bir karakterin yerine başka bir şey koymak yerine onu açıkça yazar; böylece yalnızca noktalama bakımından farklı olan iki kimlik her zaman iki ayrı ada ulaşır — ve bir alias altında yazılan bir değer yalnızca o alias’ın adlandırdığı alt chart’a ulaşabilir.

  • Bir harf, bir rakam ve bir alt çizgi tam olarak yazıldığı gibi aktarılır.
  • Bir kısa çizgi, ardından gelen karakter doğrudan aktarıldığı ve küçük harf z olmadığı her yerde yazıldığı gibi korunur. Ardından küçük harf z gelen bir kısa çizgi bir kaçış başlatır; bu nedenle o konumda yazılmış bir kısa çizginin kendisi açıkça yazılır — api-zone, api-zhzone olur; herhangi bir adın tahmin yürütmeden geri okunabilmesini sağlayan budur.
  • Diğer her karakter -z ve ardından onu adlandıran bir harf olarak yazılır: nokta için d, yol ayırıcı için s, yukarıdaki kuralın korumadığı kısa çizgi için h. Diğer her şey x ve karakterin altı basamaklı onaltılık kod noktası olarak, hiçbir karakter başlatmayan bir bayt ise b ve kendi iki basamaklı değeri olarak yazılır — böylece geçerli metin olmayan bir ad bile birleştirilip kaybolmak yerine ayırt edilebilir biçimde yazılır.
  • Boş bir değer -ze olarak yazılır; bunu boş olmayan hiçbir değer üretemez.
  • İki kimliğin tek bir chart adı oluşturduğu yerde — bir derleme yolunu niteleyen bir aggregate adı — bunlar -- ile birleştirilir. Tek bir kodlanmış kimlik bu çifti hiçbir zaman içermez; bu nedenle birleştirilmiş ad hangi kimliğin hangisi olduğunu belirsizlik olmadan söyler.

Dolayısıyla data.main-db instance_id’si data-zdmain-db alias’ını verir; boundaries/data/helm-chart derleme yoluyla birlikte fullstack-app aggregate’i ise fullstack-app--boundaries-zsdata-zshelm-chart chart adını verir. Aynı girdi her zaman aynı adı üretir.

Şemsiye values.yaml alias ile anahtarlanır:

api-server: # sub-chart alias = encoded instance_id
image: "registry/api-server:v2"
replicaCount: 3
billing-svc:
image: "registry/billing:v1"
replicaCount: 2

Bir alt chart’ın valuesMapping: alanı kendi şablon bağlamına göre değerlendirildiğinde, ortaya çıkan değerler eşlemi bu alias anahtarlı alt bloğu otomatik olarak doldurur. Bu yalnızca bileşenler için değil, şemsiyeye katkıda bulunan herkes için geçerlidir: bir chart’ı bünyesine alan bir Feature eki başlı başına bir katkıda bulunandır; bu nedenle FeatureRecipe’inin valuesMapping: alanı, yerleştirilen chart’ının bildirdiği adla anahtarlanan kendine ait bir bloğu doldurur. Bkz. “Bir ekin chart’ı nereye yerleşir”.

valuesMapping: alanının null olarak ayarladığı bir anahtar, bloğuna null olarak yazılır. Helm 4 ile kurulduğunda, şemsiyenin kendi values.yaml dosyasındaki bir null, alt chart’ın o anahtar için varsayılanını yalnızca kurulum o alt chart için de değer sağladığında kaldırır; onun için hiç değer sağlamayan bir kurulum null değerini düşürür ve alt chart’ın varsayılanı geçerli kalır. helm install komutuna verilen değerlerdeki bir null ise varsayılanı her durumda kaldırır.

Provider’a özgü tuhaflıklar

  • Alt chart’ın Chart.yaml dosyası zorunludur. Kopyalama işlemi, kaynak yolun kökünde bir Chart.yaml bulunmasını zorunlu kılar. Dosya yoksa derleme, umbrella adımı çalışmadan önce durur.
  • Yerleştirilen chart’ın name alanı umbrella’ya aittir. Bu alan, chart’a katkıda bulunan öğenin kodlanmış kimliğine ayarlanır: bir component örneğinin kendi kimliği ya da bir Feature eklemesinin getirdiği chart için o eklemenin kendi kimliği. Aggrega’nın vendor edilmiş bir chart içinde değiştirdiği tek şey budur. Bkz. “Umbrella’nın sahip olduğu chart adı”.
  • Kaynak chart bir sürüm ve bir ad bildirmelidir. Bağımlılık girdisinin sürümü, kaynak chart’ın kendi Chart.yaml dosyasında bildirdiği sürümdür; bu nedenle sürüm bildirmeyen bir chart’a sürüm atanmaz, derleme durur. Alt chart’ın taşımadığı bir sürüme sabitlenmiş bir bağımlılık, umbrella’nın örnek başına değerlerinin ona ulaşmasını engellerdi. Chart.yaml dosyası ad bildirmeyen, birden fazla YAML belgesi içeren ya da ayrıştırılamayan bir chart da aynı nedenle derlemeyi durdurur: umbrella okuyamadığı bir alt chart’ı oluşturamaz.
  • Kodlanmış takma adlar ve chart adları. Helm chart adının ya da bağımlılık takma adının kabul etmediği bir karakter içeren instance_id, aggregate adı veya sınır yolu, yukarıdaki “Bir ad nasıl türetilir” bölümüne göre işlenmiş umbrella’da kodlanmış olarak görünür. Yalnızca harflerden, rakamlardan, alt çizgilerden ve türetmenin koruduğu kısa çizgilerden oluşan bir kimlik, tam olarak yazıldığı gibi görünür.
  • file:// depo işaretçisi. Umbrella’nın bağımlılık girdileri, alt chart’ın kendi dizinini adlandıran bir file:// depo işaretçisi kullanır: bir component için file://charts/<instance_id>, bir Feature’ın getirdiği chart için ise eklemenin kendi dizini. Bu, ağaç içi alt chart’lar için yerel dosya sistemi uzlaşımıdır ve helm dependency build komutunun umbrella’yı harici kayıt defteri çağrıları olmadan çözümlemesini sağlar. İşaretçi bir konumu adlandırır, hiçbir zaman chart’ın bildirilen adını adlandırmaz; bir ekleme için ikisi farklıdır ve var olmayan bir dizini adlandıran işaretçiyi reddeden adım helm dependency build adımıdır.
  • helm-chart düzeyinde şablon işleme yoktur. Provider, Helm SDK’nın işleme hattını çağırmaz; kopyalar ve birleştirir. Önceden işlenmiş düz manifest’lere ihtiyaç duyan yazarlar bunun yerine helm provider’ının kaynaklı modunu kullanmalıdır.

Çalışılmış örnek

Her düğümü aynı kaynak chart’ı gösteren bir helm-chart Recipe’ine bağlı, iki düğümlü bir sınır:

# Recipe — used by both `api-east` and `api-west` instances
apiVersion: aggrega.ai/v1beta1
kind: Recipe
metadata:
name: api-server-helmchart
version: 1.0.0
spec:
capability: helm-chart
implements: core/api-server
source: ./charts/api-server
valuesMapping: |
image: "{{ .values.image }}"
replicaCount: {{ optional .infra `replicas` 2 }}

Birleştirmeden sonra sınırın değerlendirilmiş derleme yolu (subDirectory: varsayılan olarak {{ .capability }} olduğundan varsayılan değeri dist/<boundary-directory>/<capability>/) şunları içerir:

dist/<boundary-directory>/helm-chart/
├── Chart.yaml # umbrella; lists api-east and api-west as dependencies
├── values.yaml # alias-keyed: api-east + api-west values blocks
└── charts/
├── api-east/ # ./charts/api-server, name: api-east
│ ├── Chart.yaml
│ ├── values.yaml
│ └── templates/
│ └── deployment.yaml
└── api-west/ # ./charts/api-server, name: api-west
├── Chart.yaml
├── values.yaml
└── templates/
└── deployment.yaml

Her iki alt chart da tek kaynak chart’ın kopyalarıdır ve her biri kendi örneğinin adını kendi Chart.yaml dosyasında taşır; tek bir chart’ın tek bir umbrella içinde iki kez vendor edilebilmesini sağlayan budur. Her iki kopyadaki diğer her şey kaynakla aynıdır.

Bu yerleşime karşı çalıştırılan bir helm install <release-name> dist/<boundary-directory>/helm-chart, her iki örneği tek bir Helm sürümü olarak kurar; umbrella’nın alias anahtarlı değerleri her alt chart’ın şablonlarını yönlendirir.

Çapraz başvurular