MySQL — một Aggregate, hai đích triển khai
Ví dụ tinh gọn này biên dịch một cơ sở dữ liệu MySQL duy nhất từ các Aggregate do Developer viết sang hai đích:
- Kubernetes qua cơ chế tổng hợp Workload của provider helm (một StatefulSet
được render trực tiếp trên image
mysqlchính thức, không dùng chart bên ngoài), và - Docker Compose cho phát triển cục bộ.
Cùng một ý định của developer điều khiển mỗi đích triển khai. Chỉ có lớp Recipe do Manifest chọn là thay đổi theo từng đích.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate-helm-synth.yaml | Ý định của developer cho biến thể cơ bản trên Kubernetes: một component db có kiểu core/datastore/mysql, các giá trị của nó, và chỉ thông tin xác thực bắt buộc root_password. |
aggregate-helm-synth-auth.yaml | Ý định của developer cho biến thể đầy đủ trên Kubernetes: cả hai slot thông tin xác thực root_password và user_password. |
manifest-helm-synth.yaml | Ánh xạ kiểu MySQL tới Recipe helm được tổng hợp (helm/mysql) và mỗi thông tin xác thực tới FeatureRecipe của nó (env-secret, k8s-secret-from-parameter). |
release-helm-synth.yaml | Bản ghi của operator cho biến thể cơ bản trên Kubernetes, với kích thước vận hành (engine_version, storage). |
release-helm-synth-auth.yaml | Bản ghi của operator cho biến thể đầy đủ trên Kubernetes. |
aggregate.yaml | Ý định của developer cho đích Compose cục bộ: cùng component db với cả hai slot thông tin xác thực được cung cấp dưới dạng thông tin xác thực inject-value. |
manifest-compose.yaml | Ánh xạ kiểu MySQL tới Recipe Compose (mysql) và thông tin xác thực tới dotenv-secret. |
release-compose.yaml | Bản ghi của operator cho đích Compose cục bộ, bao gồm một mục infra.overrides riêng cho provider để cố định chính xác image container. |
Ví dụ này minh họa điều gì
- Một bề mặt soạn thảo, nhiều đích triển khai. Một Aggregate là nguồn sự thật về việc stack là gì. Mỗi Manifest cho biết hiện thực hóa nó như thế nào.
- Tổng hợp Workload trên Kubernetes (ưu tiên). Recipe
helm/mysqlkhai báo mộtWorkloadkhông phụ thuộc vào capability vớiform: stateful; provider helm tổng hợp một StatefulSet, một ClusterIP Service, một Headless Service (định danh mạng ổn định của StatefulSet), và một volumeClaimTemplate cho thư mục dữ liệu. Môi trường của container mangMYSQL_DATABASE,MYSQL_USER,MYSQL_ROOT_PASSWORDvàMYSQL_PASSWORD. Bộ ký tự và collation được áp dụng dưới dạng đối số dòng lệnh của servermysqld(--character-set-server,--collation-server), vì imagemysqlchính thức nhận chúng dưới dạng cờ server thay vì biến môi trường. - Tổng hợp Workload trên Compose. Recipe Compose khai báo một
Workloadkhông phụ thuộc vào capability; provider compose tổng hợp một servicedocker-compose.yamlvới image MySQL, môi trường của nó, một volume dữ liệu có tên và một health check. - Một lối thoát cho operator. Release Compose đặt
infra.overrides.image, trụ cột mở dành cho các thông tin riêng của provider mà schema của chính Component không đặt tên, và service được render chạy đúng tham chiếu image đó. Xem Provider-specific overrides (Ghi đè riêng cho provider). - Mô hình thông tin xác thực hai slot. Mật khẩu là các phần đính kèm trên trụ cột
features:của component, mỗi mật khẩu là một Feature gắn nhãnfeature.aggrega.ai/kind: secret, được tách khỏivaluescủa ứng dụng.featuresSchemacủa Component khai báo một slot Black-Boxroot_passwordvà một slot trong suốtuser_password.
Cung cấp thông tin xác thực trên Kubernetes
root_password là một slot Black-Box (inject: []): Recipe kiểm soát
việc cung cấp. Thông tin xác thực inject-value được đính kèm đặt giá trị lên inject pipe
của component, và Recipe đọc nó dưới dạng
.context.inject.env.MYSQL_ROOT_PASSWORD, xuất ra một biến env container thông thường. Không
có Kubernetes Secret nào được sinh ra cho nó.
user_password là một slot trong suốt (inject: [env, file]). Biến thể đầy đủ
đính kèm một thông tin xác thực có thể tham chiếu, thông tin này hiện thực hóa một Kubernetes
Secret và công bố định danh của nó; Recipe tham chiếu slot thông qua
containers.attachments, mà bộ tổng hợp render thành một env secretKeyRef.
Secret được sinh ra và tham chiếu của container chỉ cùng một tài nguyên vì
cả hai đều đọc .features.user_password.provides.name. Để user_password
không được đính kèm (biến thể cơ bản) cũng hợp lệ: Recipe quay về một giá trị mặc định
cho phát triển viết trực tiếp (MYSQL_PASSWORD: apppass) và không Secret nào được sinh ra, nên một
bản triển khai tối thiểu vẫn render và chạy được.
Tạo ví dụ
Bạn có thể build ví dụ này bằng các lệnh bên dưới, hoặc để trợ lý AI của bạn build giúp bạn.
Ghi ví dụ vào một thư mục mới đặt theo tên của nó:
aggrega scaffold --example mysql-standaloneSau đó nó in ra các lệnh cần chạy tiếp theo. Lệnh đầu tiên chuyển vào thư mục mới:
cd mysql-standaloneBuild
Workspace này không có .aggrega-config.yaml, nên các thực thể thư viện chuẩn được phân giải từ registry hub, hub.aggrega.ai, và không cần cờ catalog; --auto-pull ghi trong lúc build lockfile mà một bản clone mới còn thiếu:
# Kubernetes — synthesized helm StatefulSet (base: root credential only)aggrega build --release release-helm-synth.yaml --auto-pull
# Kubernetes — synthesized helm StatefulSet (full: both credential slots)aggrega build --release release-helm-synth-auth.yaml --auto-pull
# Local development (Docker Compose)aggrega build --release release-compose.yaml --auto-pullCác artifact được render nằm trong dist/.
Với trợ lý AI
Một trợ lý AI được thiết lập với các công cụ của Aggrega cũng có thể làm như vậy: hãy dán prompt này vào trợ lý.
Chỉ sử dụng các công cụ của Aggrega và không tự tạo thư mục nào. Nếu thư mục không gian làm việc chưa chứa thư mục `mysql-standalone`, hãy gọi công cụ `scaffold` một lần với `example` được đặt thành `mysql-standalone` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `mysql-standalone` mới. Sau đó gọi công cụ `build` một lần cho mỗi Release, theo thứ tự này — `release-helm-synth.yaml`, `release-helm-synth-auth.yaml` và `release-compose.yaml` — mỗi lần với `workspace_root` được đặt thành `mysql-standalone`, `release` được đặt thành tệp đó, `auto_pull` được đặt thành true và `write` được đặt thành true. Hãy cho tôi biết mỗi bản build đã ghi những tệp nào; chúng nằm trong `mysql-standalone/dist/`.Định cỡ của người vận hành
Các release Kubernetes đáp ứng trụ cột kích thước vận hành theo từng môi trường:
tag image container lấy từ infra.engine_version (mysql:8.4), còn
request và storage class của volumeClaimTemplate lấy từ infra.storage.
Aggregate của developer không bao giờ mang các trường này.
Ghi đè dành riêng cho từng Provider
Các trụ cột kích thước là các trường có tên: Component khai báo engine_version và
storage, nên operator khi đặt một trong hai là đang điền vào một trường mà Component
đã dự liệu. infra.overrides là trụ cột cho những gì một Component không thể
dự liệu — nó được khai báo là một object chấp nhận bất kỳ cấu trúc lồng nhau nào, và
mỗi Recipe ghi lại những khóa mà nó đọc.
release-compose.yaml sử dụng nó. Recipe Compose đọc một khóa, image, và
khi khóa này được đặt, container chạy đúng tham chiếu đó thay vì tham chiếu mà
Recipe tạo từ engine_version:
infra: engine_version: "8.4" overrides: image: "registry.internal.example/library/mysql:8.4"Service được render mang nguyên văn giá trị ghi đè:
services: db: image: registry.internal.example/library/mysql:8.4 [… omitted: the service's environment, labels, volume, network and health check]Đây là cách để dùng một bản build được mirror qua registry hoặc cố định theo digest của cùng
phiên bản server — một thông tin triển khai thuộc về môi trường đích, không
thuộc về hợp đồng của Component. Vì tập khóa là theo từng Recipe chứ không phải
theo từng Component, Recipe là nơi cần xem để biết khóa nào áp dụng: Recipe
Compose ở đây đọc image, và một Recipe không đọc khóa nào sẽ nói rõ điều đó.