Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Pustaka skema dan pemetaan bersama: sebuah Component MariaDB

Halaman ini menjelaskan satu gagasan, yaitu menyimpan sebagian besar skema sebuah Component dan pemetaan sebuah Recipe di pustaka yang dipakai bersama oleh beberapa entitas, dan bukan workspace yang dapat dijalankan. MariaDB + Adminer — contoh dua target yang dapat dijalankan menyusun pengaturan penyimpanan databasenya dari pustaka skema; tulis contoh itu ke folder Anda sendiri dengan:

Terminal window
aggrega scaffold --example mariadb-adminer

Kemudian ia mencetak perintah yang dijalankan berikutnya:

Terminal window
cd mariadb-adminer
aggrega pull --release release-compose.yaml
aggrega build --release release-compose.yaml

Entitas di halaman ini adalah katalog milik Anda sendiri, di namespace my-org; bentuk masing-masing adalah bentuk yang diambil oleh sebuah Component MariaDB kelas produksi, Recipe-nya, dan dua pustaka di belakangnya.

Pustaka skema menyimpan bentuk

Sebuah SchemaLibrary mendeklarasikan skema bernama, yang ditulis dalam bentuk ringkas — satu baris per field, dengan tipe, batasan, dan nilai default-nya — yang dikompilasi build ke JSON Schema 2020-12 sebelum nilai apa pun diperiksa terhadapnya. Kutipan:

apiVersion: aggrega.ai/v1beta1
kind: SchemaLibrary
metadata:
name: Datastores
version: 1.0.0
spec:
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 }

Sebuah referensi menyebut pustaka berdasarkan metadata.name-nya — Datastores#/schemas/<entry> — dan tidak pernah berdasarkan tempat pustaka disimpan, juga di dalam pustaka, sehingga referensi yang sama ter-resolve baik pustaka berada di katalog workspace maupun dipublikasikan ke registri. validate: dan validateMessage: menambahkan pemeriksaan milik sebuah field sendiri; when: membuat seluruh objek bersifat kondisional, sehingga batasan pool sekunder hanya berlaku di tempat arsitektur ter-resolve menjadi replication. $ref: lintas dokumen hanya menerima properties, required, dan description di sampingnya, itulah sebabnya pool sekunder ditulis lengkap alih-alih mereferensikan NodePool.

Component mereferensikannya

apiVersion: aggrega.ai/v1beta1
kind: Component
metadata:
name: my-org/datastore/mariadb
version: 1.0.0
labels:
component.aggrega.ai/type: stateful-server
component.aggrega.ai/category: datastore
spec:
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 -}}

Pilar values adalah satu baris $ref:; infra dan provides yang kecil dan khusus Component tetap inline. Asersi memuat aturan kontrak Component yang tidak dapat diungkapkan oleh kata kunci skema mana pun, Recipe mana pun yang merealisasikannya.

Pustaka pemetaan menyimpan terjemahan

Sebuah MappingLibrary menyimpan fragmen templat yang diimpor sebuah Recipe. Satu entri merender values sebuah chart, dan mendeklarasikan templat pembantu dengan define yang dipanggilnya dengan template untuk setiap node pool:

apiVersion: aggrega.ai/v1beta1
kind: MappingLibrary
metadata:
name: BitnamiHelpers
version: 1.0.0
spec:
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 }}

Templat pembantu dideklarasikan di dalam entri yang menggunakannya, karena sebuah Recipe mengimpor satu entri dan sebuah definisi ikut bersama entri yang memuatnya. Fragmen dievaluasi oleh renderer Aggrega, sehingga fragmen menggunakan fungsi Sprig dan optional milik Aggrega untuk kunci yang mungkin tidak ada (lihat sprig-functions.md); include milik Helm bukan salah satunya, dan template menulis output-nya tepat di tempatnya berada.

Recipe mengimpornya

apiVersion: aggrega.ai/v1beta1
kind: Recipe
metadata:
name: mariadb-bitnami
version: 1.0.0
spec:
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 ini kecil: pemetaan berada di pustaka, dan Recipe menyimpan apa yang menjadi miliknya — chart yang dirender-nya dan alamat yang dipublikasikannya. Karena pemetaan menetapkan fullnameOverride chart ke .context.rendered_name, Recipe dapat menghitung nama Service primer alih-alih mengasumsikannya.

Apa yang diberikan pustaka

Jika ditulis sebagai JSON Schema, peta satu baris setiap field menjadi blok bersarang dan setiap objek menambahkan type: object, properties:, dan daftar required:; when: dan validate: tidak memiliki kata kunci JSON Schema sendiri. Bentuk ringkas mencakup semua yang dibutuhkan Component ini, tanpa jalan keluar $jsonschema:. Penghematan bertambah seiring pemakaian bersama: pustaka ditulis sekali, dan pilar values setiap Component berikutnya adalah satu baris $ref:.

Referensi: penulisan bentuk ringkas, $ref: lintas dokumen, blok asersi, SchemaLibrary, dan MappingLibrary.