Grafana — một Aggregate, hai đích, thông tin xác thực quản trị tùy chọn
Ví dụ này biên dịch một máy chủ bảng điều khiển và trực quan hóa Grafana duy nhất từ một Aggregate do Developer soạn thành hai hiện thực:
- Docker Compose cho phát triển cục bộ, và
- Recipe helm được tổng hợp chạy trực tiếp image chính thức
grafana/grafanacủa upstream trên Kubernetes (không dùng chart bên ngoài).
Recipe helm được tổng hợp là con đường 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 kết xuất của nó đúng như những gì workload khai báo.
Cùng một aggregate.yaml điều khiển cả hai. Chỉ có lớp Recipe do
Manifest chọn thay đổi theo từng hiện thực. Hai Aggregates khác thể hiện cùng máy chủ đó
với một thông tin xác thực mật khẩu quản trị tùy chọn được gắn vào: aggregate-auth.yaml cho
con đường Compose (một thông tin xác thực inject-value được đưa ra dưới dạng biến
môi trường), và aggregate-helm-synth-auth.yaml cho con đường helm được tổng hợp (một
thông tin xác thực có thể tham chiếu được hiện thực hóa thành một Kubernetes Secret).
Máy chủ Grafana được đóng gói dùng giấy phép AGPL-3.0.
Các tệp
| Tệp | Vai trò |
|---|---|
aggregate.yaml | Ý định của Developer: một component dashboards thuộc kiểu core/observability/grafana, không có thông tin xác thực — tài khoản quản trị dùng mật khẩu phát triển tất định của Recipe. |
aggregate-auth.yaml | Cùng máy chủ đó với một thông tin xác thực mật khẩu quản trị được gắn vào slot tùy chọn admin_password của component (con đường Compose). |
aggregate-helm-synth-auth.yaml | Cùng máy chủ đó với một thông tin xác thực có thể tham chiếu được gắn vào cho con đường helm được tổng hợp — giá trị được hiện thực hóa thành một Kubernetes Secret mà Deployment tham chiếu tới. |
manifest-compose.yaml | Ánh xạ kiểu Grafana tới Recipe Compose (compose/grafana) và thông tin xác thực tới dotenv-secret. |
manifest-helm-synth.yaml | Ánh xạ kiểu Grafana tới Recipe helm được tổng hợp (helm/grafana) 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 gắn thông tin 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 máy chủ dựa trên volume bền vững. Grafana lưu trạng thái của nó — người dùng,
bảng điều khiển đã lưu, tùy chọn — trên đĩa, nên component khai báo một volume
dữ liệu có kích thước lấy từ
infra.storage. Trên Kubernetes, Recipe helm được tổng hợp kết xuất một Deployment với một PersistentVolumeClaim được gắn tại/var/lib/grafana; trên Compose, service gắn một volume có tên tại cùng đường dẫn đó. - 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 ClusterIP Service chạy image chính thức
grafana/grafana— mà helm provider chuyển thành các manifest Kubernetes mà không cần chart bên ngoài. Tập tài nguyên được kết xuất đúng như những gì Workload khai báo. Vì cả Recipe Compose và Recipe helm được tổng hợp đều mang têngrafana, các Manifests tham chiếu chúng theo phạm vi provider làcompose/grafanavàhelm/grafana. - Một mật khẩu quản trị tất định. Tài khoản quản trị Grafana luôn
tồn tại. Component này truyền mật khẩu qua một slot thông tin xác thực tùy chọn
admin_password: khi không gắn thông tin xác thực nào (Aggregate cơ sở), Recipe đặt một mật khẩu phát triển tất định, nên bản kết xuất giống hệt nhau từng byte qua các lần chạy; khi có thông tin xác thực được gắn, giá trị được chèn vào trở thành mật khẩu quản trị. Trên Compose, nó xuất hiện dưới dạng biến môi trườngGF_SECURITY_ADMIN_PASSWORD; trên Kubernetes, con đường helm được tổng hợp hiện thực hóa nó thành một Secret mà Deployment tham chiếu qua một envsecretKeyRef, nên bản rõ không bao giờ xuất hiện trong manifest của Deployment.
Chưa được mô hình hóa ở đây
Grafana được triển khai độc lập. Việc nối một nguồn metrics hoặc logs — ví dụ một máy chủ Prometheus — vào Grafana như một datasource được cấp sẵn không được mô hình hóa: component này không khai báo socket uses nào.
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 grafana-dashboardsSau đó 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 grafana-dashboardsBuild
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), development admin passwordaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin passwordaggrega 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ỉ 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 `grafana-dashboards`, hãy gọi công cụ `scaffold` một lần với `example` đặt thành `grafana-dashboards` và không có `dir`: công cụ này ghi ví dụ vào một thư mục `grafana-dashboards` 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`, `release-helm-synth-auth.yaml` — mỗi lần với `workspace_root` đặt thành `grafana-dashboards`, `release` đặt thành tệp đó, `auto_pull` đặt thành true và `write` đặt thành true. Hãy cho tôi biết mỗi lần build đã ghi những tệp nào; chúng nằm trong `grafana-dashboards/dist/`.Ghi chú về việc cung cấp thông tin xác thực
Trên con đường Compose, thông tin xác thực là một secret inject-value
(aggregate-auth.yaml): giá trị của nó được truyền trên đường ống môi trường của component
và trở thành biến môi trường service GF_SECURITY_ADMIN_PASSWORD.
Con đường 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 hóa thành một Kubernetes
Secret, và Deployment tham chiếu nó qua một env secretKeyRef gắn với
GF_SECURITY_ADMIN_PASSWORD. Do đó mật khẩu dạng rõ không bao giờ xuất hiện trong
manifest của Deployment — chỉ có trong Secret.
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ế.
Chạy thử (Compose)
aggrega build --release release-compose.yaml --auto-pulldocker compose -f dist/app/compose/docker-compose.yaml up -dMở http://localhost:3000 — giao diện web của Grafana — và đăng nhập với tên admin bằng
mật khẩu phát triển. Gỡ bỏ bằng
docker compose -f dist/app/compose/docker-compose.yaml down.