Ngăn xếp Keycloak — một máy chủ định danh dùng cơ sở dữ liệu, được kết hợp dưới dạng module
Ví dụ này biên dịch một ngăn xếp nhỏ, có thật — một máy chủ định danh
dùng cơ sở dữ liệu — thành các manifest Kubernetes được tổng hợp từ một
Aggregate do Developer viết.
Máy chủ định danh không phải là một component đơn lẻ. Nó là một module: một sub-aggregate có thể tái sử dụng, kết hợp hai component một workload —
- một server phục vụ bảng điều khiển tài khoản và các endpoint token trên cổng HTTP của nó và không giữ trạng thái cục bộ, và
- một backend, PostgreSQL, giữ các realm, client và người dùng của server và lưu trữ chúng trên một volume.
Module tự nối cạnh nội bộ của nó từ server tới backend và
xuất server làm endpoint công khai http. Aggregate cấp cao nhất
nhập module theo tên và kết xuất ngăn xếp đã kết hợp; operator định cỡ
các component nội bộ của module trong Release.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate.yaml | Ý định của Developer: nhập module máy chủ định danh (core/keycloak). |
manifest-helm-synth.yaml | Ánh xạ các kiểu server và backend tới các Recipes synth helm của chúng, và ánh xạ Feature thông tin xác thực mà module gắn vào tới realization phát ra một Secret từ các tham số thông tin xác thực của module. |
release-helm-synth.yaml | Bản ghi của operator cho đích Kubernetes. Định cỡ các component nội bộ của module theo ID trong phạm vi module của chúng; mọi thứ để theo giá trị mặc định của schema sẽ được kết xuất tự chứa. |
Ví dụ này minh họa điều gì
- Kết hợp dưới dạng module. Một năng lực nhiều workload — một máy chủ định danh thực chất là một server cộng một cơ sở dữ liệu cấu hình — được đóng gói dưới dạng một sub-aggregate kết hợp hai component một workload, chứ không phải một component nguyên khối. Module được nhập theo tên và tái sử dụng ở bất cứ đâu cần một máy chủ định danh.
- Một cạnh nội bộ bên trong module. Server khai báo việc sử dụng
backend; host, cổng, người dùng và cơ sở dữ liệu trong
providescủa Recipe backend được chuyển vào server và kết hợp thành kết nối cơ sở dữ liệu của nó. Trình biên dịch định tuyến các chuỗi mà không diễn giải chúng. - Một endpoint công khai. Module xuất server của nó dưới tên
http, tên công khai ổn định mà bên tiêu thụ kết nối tới — tách biệt khỏi tên các component nội bộ của module. - Operator định cỡ các component nội bộ. Release tham chiếu các component nội bộ
của module theo ID trong phạm vi module của chúng (
server.backend,server.server) để thiết lập tài nguyên tính toán, mà Aggregate của developer không phải nêu lại kích cỡ vật lý. - Schema tự di chuyển. Server tự cấp phát và di chuyển schema của nó khi khởi động dựa trên backend, nên nó khởi động với một schema sẵn sàng mà không cần bước di chuyển riêng.
- Một thông tin xác thực dùng chung, lấy theo tham chiếu. Server xác thực với
backend PostgreSQL của nó, nên hai bên dùng chung một mật khẩu. Module nhận mật khẩu đó làm
tham số,
db_password, và gắn Feature thông tin xác thựccore/referenced-secretvới nó hai lần: vào vị trí thông tin xác thực riêng của backend, và làmcredentialcủa kết nối từ server tới backend, tức kết nối mà server xuất trình mật khẩu đó. Mỗi workload đọc mật khẩu từ một Secret thay vì mang nó trực tiếp; mật khẩu của tài khoản admin khởi tạo là tham số thứ hai,admin_password. Vì module gắn Feature đó, Manifest ánh xạ nó. Ví dụ này để cả hai tham số ở giá trị mặc định phát triển của module và ánh xạ Feature tớik8s-secret-from-parameter, thứ phát ra một Secret mang từng giá trị, nên ngăn xếp chạy tự chứa. Với một Release phục vụ lưu lượng thật, Aggregate khai báo các tham số riêng và truyền chúng xuống quaaggregates.server.parameters, Release đáp ứng chúng, và Manifest ánh xạ Feature tớik8s-existing-secret, thứ đọc mỗi tham số như tên của một Secret đã tồn tại trong namespace. - Image có thể tái tạo. Cả server và backend đều ghim tag image tường minh, nên các manifest được kết xuất tham chiếu các image ổn định.
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 keycloak-stackSau đó 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 keycloak-stackBuild
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:
aggrega build --release release-helm-synth.yaml --auto-pullCác artifact được kết xuất nằm trong dist/. Đích Kubernetes kết xuất manifest
thuần ở chế độ ngoại tuyến — không cần kéo chart.
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 `keycloak-stack`, hãy gọi công cụ `scaffold` một lần với `example` được đặt thành `keycloak-stack` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `keycloak-stack` mới. Sau đó gọi công cụ `build` với `workspace_root` được đặt thành `keycloak-stack`, `release` được đặt thành `release-helm-synth.yaml`, `auto_pull` được đặt thành true và `write` được đặt thành true. Hãy cho tôi biết bản build đã ghi những tệp nào; chúng nằm trong `keycloak-stack/dist/`.Ngăn xếp đã kết hợp trông như thế nào
Server được kết xuất thành một Deployment phi trạng thái cộng một Service ClusterIP trên cổng HTTP. Container của nó mang kết nối được kết hợp từ cạnh backend — tên Service trong cluster, người dùng và cơ sở dữ liệu của backend — cùng với các thiết lập HTTP tự chứa, các endpoint sức khỏe được bật và phục vụ trên cổng quản lý, và tài khoản admin khởi tạo, với cả hai mật khẩu được đọc từ Secret:
env: - name: KC_DB_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-db.credential key: db-password - name: KC_BOOTSTRAP_ADMIN_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-admin-password key: admin-password - name: KC_DB value: postgres - name: KC_DB_URL_HOST value: server-zdbackend-default - name: KC_DB_URL_PORT value: "5432" - name: KC_DB_URL_DATABASE value: keycloak - name: KC_DB_USERNAME value: keycloak - name: KC_HTTP_ENABLED value: "true" - name: KC_HOSTNAME_STRICT value: "false" - name: KC_HEALTH_ENABLED value: "true" - name: KC_HTTP_MANAGEMENT_PORT value: "9000" - name: KC_BOOTSTRAP_ADMIN_USERNAME value: adminContainer khai báo cổng quản lý, 9000, bên cạnh cổng HTTP, và
Deployment thăm dò server tại đó: một startup probe trên /health/started giữ
các probe khác lại trong khi server khởi động, một readiness probe trên /health/ready
ngăn lưu lượng cho đến khi server phản hồi, và một liveness probe trên /health/live
khởi động lại server nếu nó ngừng hoạt động. Service vẫn chỉ chuyển tiếp cổng HTTP.
Backend được kết xuất thành một StatefulSet với một persistent volume được gắn tại
/var/lib/postgresql/data, cộng một Service ClusterIP và một headless Service.
POSTGRES_PASSWORD của nó đọc cùng mật khẩu cơ sở dữ liệu từ một Secret riêng,
server-zdbackend-password. Ba Secret được phát ra bên cạnh các workload,
mỗi Secret cho một thông tin xác thực mà module gắn vào, mỗi cái mang giá trị mặc định
phát triển của module.