Redis — một Aggregate, hai đích, xác thực tùy chọn
Ví dụ gọn nhẹ này biên dịch một bộ nhớ đệm trong bộ nhớ Redis duy nhất (giao thức truyền Redis) từ một Aggregate do Developer soạn thành hai cách hiện thực:
- Docker Compose cho phát triển cục bộ, và
- Recipe helm được tổng hợp chạy image
redischính thức từ upstream trực tiếp trên Kubernetes (không dùng chart bên ngoài).
Recipe helm được tổng hợp là đường đi cho Kubernetes: nó chỉ phụ thuộc vào một tag image chính thức thay vì một chart của bên thứ ba, và tập tài nguyên được render của nó đúng bằng những gì workload khai báo.
Cùng một aggregate.yaml điều khiển cả hai. Chỉ lớp Recipe được Manifest chọn
thay đổi theo từng hiện thực. Một Aggregate thứ hai, aggregate-auth.yaml,
cho thấy cùng bộ nhớ đệm đó với một thông tin xác thực mật khẩu tùy chọn được gắn cho
đường đi Compose; aggregate-helm-synth-auth.yaml gắn một
thông tin xác thực có thể tham chiếu cho đường đi helm được tổng hợp.
Các Recipes Redis của catalog mà ví dụ này ánh xạ, compose/redis và helm/redis, khai báo giấy phép AGPL-3.0. Ví dụ valkey-cache triển khai Valkey, vốn dùng cùng giao thức truyền; Recipe helm/valkey của nó khai báo BSD-3-Clause.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate.yaml | Ý định của Developer: một component cache có kiểu core/datastore/redis, không có thông tin xác thực — bộ nhớ đệm chạy mà không cần xác thực. |
aggregate-auth.yaml | Cùng bộ nhớ đệm đó với một thông tin xác thực mật khẩu được gắn vào slot password tùy chọn của component (đường đi Compose). |
aggregate-helm-synth-auth.yaml | Cùng bộ nhớ đệm đó với một thông tin xác thực có thể tham chiếu được gắn cho con đường helm được tổng hợp — giá trị được hiện thực hóa thành một Secret Kubernetes mà Deployment tham chiếu. |
manifest-compose.yaml | Ánh xạ kiểu Redis tới Recipe Compose (compose/redis) và thông tin xác thực tới dotenv-secret. |
manifest-helm-synth.yaml | Ánh xạ kiểu Redis tới Recipe helm được tổng hợp (helm/redis) và thông tin xác thực tới k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Các bản ghi của Operator cho hai hiện thực, không có xác thực. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Các bản ghi của Operator bật xác thực. |
Ví dụ này minh họa điều gì
- Một bề mặt soạn thảo, nhiều đích. Một Aggregate duy nhất là nguồn chân lý cho việc stack là gì. Mỗi Manifest cho biết cách hiện thực nó.
- Một datastore đóng vai trò bộ nhớ đệm. Ở đây Redis được dùng làm bộ nhớ đệm trong bộ nhớ và
không lưu trữ bền vững gì cả, nên component được định kiểu là một
serverthông thường thay vì mộtstateful-server. Trên Kubernetes, Recipe được tổng hợp render một Deployment, không phải StatefulSet, và không yêu cầu volume bền vững nào; trên Compose, service không khai báo volume dữ liệu nào. - Tổng hợp Workload (Kubernetes). Recipe helm được tổng hợp khai báo một
Workload — một Deployment cùng một Service ClusterIP chạy image
redischính thức — mà provider helm dịch thành các manifest Kubernetes mà không cần chart bên ngoài. Tập tài nguyên được render đúng bằng những gì Workload khai báo. Vì cả một Recipe Compose lẫn một Recipe helm được tổng hợp đều mang tênredis, các Manifests tham chiếu chúng theo phạm vi provider làcompose/redisvàhelm/redis. - Xác thực tùy chọn qua một slot thông tin xác thực. Component khai báo một slot
passwordtùy chọn trongfeaturesSchemacủa nó. Khi không có thông tin xác thực nào được gắn (Aggregate cơ sở), Recipe render bộ nhớ đệm với xác thực bị tắt — giống hệt từng byte với một Recipe không có slot. Khi một thông tin xác thực được gắn, cả hai đích đều khởi động Redis với--requirepass, nên máy chủ yêu cầu mật khẩu: trên Compose (aggregate-auth.yaml) giá trị được truyền cho máy chủ dưới dạng đối số đó; trên đường đi Kubernetes được tổng hợp (aggregate-helm-synth-auth.yaml) nó được hiện thực thành một Secret mà Deployment tham chiếu.
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 redis-cacheSau đó 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 redis-cacheBuild
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:
# Local development (Docker Compose), no authenticationaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), no authenticationaggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabledaggrega build --release release-compose-auth.yaml --auto-pullaggrega build --release release-helm-synth-auth.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ỉ 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 Workspace chưa có thư mục `redis-cache`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `redis-cache` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `redis-cache` mới. Sau đó gọi công cụ `build` một lần cho mỗi Release, theo thứ tự này — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml` và `release-helm-synth-auth.yaml` — mỗi lần với `workspace_root` đặt thành `redis-cache`, `release` đặt thành tệp đó, `auto_pull` đặt thành true và `write` đặt thành true. Cho tôi biết mỗi bản dựng đã ghi những tệp nào; chúng nằm trong `redis-cache/dist/`.Ghi chú về việc cung cấp thông tin xác thực
Trên đường đi Compose, thông tin xác thực là một secret kiểu inject-value (aggregate-auth.yaml): giá trị của nó được truyền trên đường ống môi trường của component dưới biến mà values.key của nó nêu tên, REDIS_PASSWORD, và Recipe chuyển nó cho máy chủ dưới dạng --requirepass. Image redis chính thức không đọc biến mật khẩu nào, nên giá trị được truyền dưới dạng đối số và hiện ra trong lệnh của service. Một đính kèm có giá trị đến Recipe dưới một biến mà Recipe không đọc sẽ dừng bản build, nêu tên slot, thay vì để bộ nhớ đệm mở.
Đường đi helm được tổng hợp dùng một thông tin xác thực có thể tham chiếu
(aggregate-helm-synth-auth.yaml): giá trị được hiện thực thành một Secret Kubernetes,
Deployment tham chiếu nó qua một env secretKeyRef, và Redis được
khởi động với --requirepass đọc biến môi trường đó. Do đó mật khẩu dạng văn bản thuần
không bao giờ xuất hiện trong manifest của Deployment — chỉ có trong
Secret. Đây chính là điều thực sự bật xác thực trên image redis chính thức,
vốn không tự đọc mật khẩu từ môi trường.
Giá trị origin trong các Aggregates có xác thực là một giá trị giữ chỗ cho phát triển;
hãy cung cấp một giá trị thật qua nguồn thông tin xác thực của bạn cho mọi triển khai thực tế.