Paylaşılan şema ve eşleme kütüphaneleri: bir MariaDB Component'i
Bu sayfa tek bir fikri, yani bir Component’in şemasının ve bir Recipe’nin eşlemesinin büyük kısmını birkaç varlığın paylaştığı kütüphanelerde tutmayı açıklar ve çalıştırılabilir bir çalışma alanı değildir. MariaDB + Adminer — çalıştırılabilir çift hedefli bir örnek, veritabanının depolama ayarlarını bir şema kütüphanesinden oluşturur; onu kendi klasörünüze şu komutla yazın:
aggrega scaffold --example mariadb-adminerArdından sırada çalıştırılacak komutları yazdırır:
cd mariadb-admineraggrega pull --release release-compose.yamlaggrega build --release release-compose.yamlBu sayfadaki varlıklar, my-org ad alanında size ait bir katalogdur; her birinin biçimi, üretim düzeyinde bir MariaDB Component’inin, onun Recipe’sinin ve arkalarındaki iki kütüphanenin aldığı biçimdir.
Şema kütüphanesi biçimi taşır
Bir SchemaLibrary, kompakt biçimde yazılmış adlandırılmış şemalar bildirir — alan başına bir satır, türü, kısıtlamaları ve varsayılanıyla — ve derleme bunları, herhangi bir değer onlara göre denetlenmeden önce JSON Schema 2020-12’ye derler. Bir alıntı:
apiVersion: aggrega.ai/v1beta1kind: SchemaLibrarymetadata: name: Datastores version: 1.0.0spec: schemas: PodResources: requests: cpu: { type: string, pattern: "^[0-9]+(m|\\.[0-9]+)?$", default: "250m" } memory: { type: string, pattern: "^[1-9][0-9]*(Mi|Gi)$", default: "512Mi" } NodePool: replicaCount: { type: integer, min: 1, max: 9, default: 1 } resources: { $ref: "Datastores#/schemas/PodResources" } MariaDBPayload: architecture: { type: string, enum: [standalone, replication], default: standalone } image: tag: { type: string, validate: '{{ ne . "latest" }}', validateMessage: "image.tag must name a version: latest moves with every chart release" } primary: { $ref: "Datastores#/schemas/NodePool", required: true } secondary: when: '{{ eq $.architecture "replication" }}' required: true properties: replicaCount: { type: integer, min: 2, max: 8, default: 2 }Bir başvuru kütüphaneyi metadata.name değeriyle adlandırır — Datastores#/schemas/<entry> — ve kütüphanenin içinde de dahil olmak üzere asla kütüphanenin saklandığı yerle adlandırmaz; bu yüzden kütüphane ister çalışma alanının kataloğunda bulunsun ister bir kayıt defterine yayımlanmış olsun, aynı başvuru çözümlenir. validate: ve validateMessage:, bir alana özgü bir denetim ekler; when: bütün bir nesneyi koşullu kılar, böylece ikincil havuzun kısıtlamaları yalnızca mimarinin replication olarak çözümlendiği yerde geçerli olur. Belgeler arası bir $ref:, yanında yalnızca properties, required ve description kabul eder; ikincil havuzun NodePool şemasına başvurmak yerine açıkça yazılmasının nedeni budur.
Component ona başvurur
apiVersion: aggrega.ai/v1beta1kind: Componentmetadata: name: my-org/datastore/mariadb version: 1.0.0 labels: component.aggrega.ai/type: stateful-server component.aggrega.ai/category: datastorespec: schema: values: $ref: Datastores#/schemas/MariaDBPayload infra: cpu_arch: { type: string, enum: [amd64, arm64], default: amd64 } provides: host: { type: string, format: hostname } port: { type: integer, min: 1024, max: 65535 } featuresSchema: root_credentials: required: true inject: [] replication_credentials: required: false inject: [] assertions: replication-needs-credentials: | {{- if eq .values.architecture "replication" -}} {{- if not (hasKey .features "replication_credentials") -}} {{- fail "architecture=replication requires replication_credentials secret to be supplied" -}} {{- end -}} {{- end -}}values sütunu tek bir $ref: satırıdır; küçük, Component’e özgü infra ve provides satır içinde kalır. Doğrulamalar, onu hangi Recipe gerçekleştirirse gerçekleştirsin, hiçbir şema anahtar sözcüğünün ifade etmediği Component sözleşmesi kurallarını taşır.
Eşleme kütüphanesi çeviriyi taşır
Bir MappingLibrary, bir Recipe’nin içe aktardığı şablon parçalarını taşır. Bir girdi bir chart’ın değerlerini işler ve define ile bir yardımcı bildirir; bu yardımcıyı her düğüm havuzu için template ile çağırır:
apiVersion: aggrega.ai/v1beta1kind: MappingLibrarymetadata: name: BitnamiHelpers version: 1.0.0spec: mappings: MariaDBBitnamiCore: | {{- define "BitnamiNodePool" }} resources: requests: cpu: {{ .pool.resources.requests.cpu | quote }} memory: {{ .pool.resources.requests.memory | quote }} {{- end }} {{- with .values -}} fullnameOverride: {{ $.context.rendered_name | quote }} architecture: {{ .architecture }} primary: name: primary {{- template "BitnamiNodePool" (dict "pool" .primary) }} {{- end }}Yardımcı, onu kullanan girdinin içinde bildirilir, çünkü bir Recipe tek bir girdiyi içe aktarır ve bir tanım, onu içeren girdiyle birlikte taşınır. Parça Aggrega’nın işleyicisi tarafından değerlendirilir, bu yüzden Sprig’in işlevlerini ve bulunmayabilecek bir anahtar için Aggrega’nın optional işlevini kullanır (bkz. sprig-functions.md); Helm’in include işlevi bunlardan biri değildir ve template çıktısını tam olarak bulunduğu yere yazar.
Recipe onu içe aktarır
apiVersion: aggrega.ai/v1beta1kind: Recipemetadata: name: mariadb-bitnami version: 1.0.0spec: capability: helm implements: my-org/datastore/mariadb:^1.0.0 source: kind: helm-oci-chart url: oci://registry-1.docker.io/bitnamicharts/mariadb version: "25.0.8" valuesMapping: $import: BitnamiHelpers#/mappings/MariaDBBitnamiCore provides: host: "{{ .context.rendered_name }}{{ if eq .values.architecture `replication` }}-primary{{ end }}" port: "3306"Recipe küçüktür: eşleme kütüphanede yaşar ve Recipe kendine ait olanı tutar — işlediği chart’ı ve yayımladığı adresi. Eşleme chart’ın fullnameOverride değerini .context.rendered_name olarak sabitlediği için Recipe, birincilin Service adını varsaymak yerine hesaplayabilir.
Kütüphanelerin kazandırdıkları
JSON Schema olarak yazıldığında her alanın tek satırlık eşlemesi iç içe bir bloğa dönüşür ve her nesne type: object, properties: ve bir required: listesi ekler; when: ve validate: için JSON Schema’da kendi anahtar sözcükleri yoktur. Kompakt biçim, $jsonschema: kaçış yolu olmadan bu Component’in ihtiyaç duyduğu her şeyi karşılar. Tasarruf paylaşımla büyür: kütüphane bir kez yazılır ve sonraki her Component’in values sütunu tek bir $ref: satırıdır.
Başvurular: kompakt biçimle yazma, belgeler arası $ref:, doğrulamalar bloğu, SchemaLibrary ve MappingLibrary.