Bỏ qua để đến nội dung
AggregaAggrega
Chọn ngôn ngữ: Tiếng Việt
Trang này được dịch bằng máy. Đọc bản gốc tiếng Anh.

Thư viện schema và ánh xạ dùng chung: một Component MariaDB

Trang này giải thích một ý tưởng, giữ phần lớn schema của một Component và ánh xạ của một Recipe trong các thư viện mà nhiều thực thể dùng chung, và không phải là một workspace chạy được. MariaDB + Adminer — một ví dụ hai đích chạy được tạo các thiết lập lưu trữ của cơ sở dữ liệu từ một thư viện schema; ghi nó vào một thư mục của riêng bạn bằng:

Terminal window
aggrega scaffold --example mariadb-adminer

Sau đó nó in ra các lệnh cần chạy tiếp theo:

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

Các thực thể trên trang này là một catalog của riêng bạn, trong không gian tên my-org; hình dạng của mỗi thực thể là hình dạng mà một Component MariaDB cấp sản xuất, Recipe của nó và hai thư viện đứng sau chúng có.

Thư viện schema chứa hình dạng

Một SchemaLibrary khai báo các schema được đặt tên, viết ở dạng rút gọn — mỗi trường một dòng, với kiểu, ràng buộc và giá trị mặc định của nó — mà bản build biên dịch sang JSON Schema 2020-12 trước khi kiểm tra bất kỳ giá trị nào theo chúng. Một đoạn trích:

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 }

Một tham chiếu nêu tên thư viện bằng metadata.name của nó — Datastores#/schemas/<entry> — và không bao giờ bằng nơi thư viện được lưu trữ, kể cả bên trong thư viện, nên cùng một tham chiếu được phân giải dù thư viện nằm trong catalog của workspace hay được xuất bản lên một registry. validate: và validateMessage: thêm một phép kiểm tra riêng cho một trường; when: làm cho cả một đối tượng trở thành có điều kiện, nên các ràng buộc của pool phụ chỉ áp dụng ở nơi kiến trúc được phân giải thành replication. Một $ref: liên tài liệu chỉ chấp nhận properties, required và description bên cạnh nó, đó là lý do pool phụ được viết đầy đủ thay vì tham chiếu NodePool.

Component tham chiếu đến nó

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 -}}

Trụ cột values là một dòng $ref:; infra và provides nhỏ, riêng của Component vẫn để inline. Các assertion chứa những quy tắc trong hợp đồng của Component mà không từ khóa schema nào diễn đạt được, bất kể Recipe nào hiện thực hóa nó.

Thư viện ánh xạ chứa phần chuyển đổi

Một MappingLibrary chứa các đoạn template mà một Recipe nhập vào. Một mục render values của một chart, và khai báo bằng define một template trợ giúp mà nó gọi bằng template cho mỗi 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 }}

Template trợ giúp được khai báo bên trong mục sử dụng nó, vì một Recipe nhập một mục và một định nghĩa đi kèm với mục chứa nó. Đoạn này được bộ render của Aggrega đánh giá, nên nó dùng các hàm của Sprig và optional của Aggrega cho một khóa có thể vắng mặt (xem sprig-functions.md); include của Helm không nằm trong số đó, và template ghi đầu ra của nó đúng tại vị trí nó đứng.

Recipe nhập nó

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 nhỏ gọn: ánh xạ nằm trong thư viện, và Recipe giữ những gì thuộc về nó — chart mà nó render và địa chỉ mà nó xuất bản. Vì ánh xạ cố định fullnameOverride của chart thành .context.rendered_name, Recipe có thể tính ra tên Service của nút chính thay vì giả định nó.

Các thư viện mang lại gì

Nếu viết dưới dạng JSON Schema, ánh xạ một dòng của mỗi trường trở thành một khối lồng nhau và mỗi đối tượng thêm type: object, properties: và một danh sách required:; when: và validate: không có từ khóa JSON Schema tương ứng. Dạng rút gọn bao quát mọi thứ mà Component này cần, không cần lối thoát $jsonschema:. Mức tiết kiệm tăng theo việc dùng chung: thư viện được viết một lần, và trụ cột values của mỗi Component tiếp theo chỉ là một dòng $ref:.

Tài liệu tham khảo: soạn thảo dạng rút gọn, $ref: liên tài liệu, khối assertion, SchemaLibrary và MappingLibrary.