Grafana — jeden Aggregate, dwa cele, opcjonalne poświadczenie administratora
Ten przykład kompiluje pojedynczy serwer dashboardów i wizualizacji Grafana z jednej encji Aggregate napisanej przez dewelopera do dwóch realizacji:
- Docker Compose do lokalnego programowania oraz
- syntetyzowany Recipe helm, uruchamiający oficjalny obraz
grafana/grafanabezpośrednio w Kubernetes (bez zewnętrznego chartu).
Syntetyzowany Recipe helm to ścieżka dla Kubernetes: zależy wyłącznie od oficjalnego tagu obrazu zamiast od chartu zewnętrznego dostawcy, a renderowany zestaw zasobów jest dokładnie tym, co deklaruje workload.
Ten sam plik aggregate.yaml steruje obiema realizacjami. Dla każdej realizacji zmienia się
tylko warstwa Recipe wybrana przez Manifest. Dwa kolejne Aggregates pokazują ten sam serwer
z dołączonym opcjonalnym poświadczeniem hasła administratora: aggregate-auth.yaml dla
ścieżki Compose (poświadczenie typu inject-value udostępniane jako zmienna
środowiskowa) oraz aggregate-helm-synth-auth.yaml dla syntetyzowanej ścieżki helm
(poświadczenie referencyjne materializowane jako Secret Kubernetes).
Pakowany serwer Grafana jest objęty licencją AGPL-3.0.
Pliki
| Plik | Rola |
|---|---|
aggregate.yaml | Intencja dewelopera: jeden komponent dashboards typu core/observability/grafana, bez poświadczenia — konto administratora używa deterministycznego hasła deweloperskiego z encji Recipe. |
aggregate-auth.yaml | Ten sam serwer z poświadczeniem hasła administratora dołączonym do opcjonalnego slotu admin_password komponentu (ścieżka Compose). |
aggregate-helm-synth-auth.yaml | Ten sam serwer z poświadczeniem referencyjnym dołączonym dla syntetyzowanej ścieżki helm — wartość jest materializowana jako Secret Kubernetes, do którego odwołuje się Deployment. |
manifest-compose.yaml | Mapuje typ Grafana na Recipe Compose (compose/grafana), a poświadczenie na dotenv-secret. |
manifest-helm-synth.yaml | Mapuje typ Grafana na syntetyzowany Recipe helm (helm/grafana), a poświadczenie na k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Rekordy operatora dla obu realizacji, bez dołączonego poświadczenia. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Rekordy operatora włączające uwierzytelnianie. |
Co demonstruje
- Jedna powierzchnia tworzenia, wiele celów. Pojedyncza encja Aggregate jest źródłem prawdy o tym, czym jest stos. Każda encja Manifest mówi, jak go zrealizować.
- Serwer oparty na trwałym wolumenie. Grafana przechowuje swój stan — użytkowników,
zapisane dashboardy, preferencje — na dysku, dlatego komponent deklaruje wolumen
danych o rozmiarze wynikającym z
infra.storage. W Kubernetes syntetyzowany Recipe helm renderuje Deployment z PersistentVolumeClaim zamontowanym w/var/lib/grafana; w Compose usługa montuje nazwany wolumen w tej samej ścieżce. - Synteza Workload (Kubernetes). Syntetyzowany Recipe helm deklaruje
Workload — Deployment oraz Service typu ClusterIP uruchamiające oficjalny obraz
grafana/grafana— który provider helm tłumaczy na manifesty Kubernetes bez zewnętrznego chartu. Renderowany zestaw zasobów jest dokładnie tym, co deklaruje Workload. Ponieważ zarówno Recipe Compose, jak i syntetyzowany Recipe helm noszą nazwęgrafana, Manifests odwołują się do nich z zakresem providera jakocompose/grafanaihelm/grafana. - Deterministyczne hasło administratora. Konto administratora Grafana jest zawsze
obecne. Ten komponent przekazuje hasło przez opcjonalny slot poświadczenia
admin_password: gdy żadne poświadczenie nie jest dołączone (bazowy Aggregate), Recipe ustawia deterministyczne hasło deweloperskie, dzięki czemu render jest identyczny bajt w bajt między uruchomieniami; gdy poświadczenie jest dołączone, wstrzyknięta wartość staje się hasłem administratora. W Compose jest udostępniana jako zmienna środowiskowaGF_SECURITY_ADMIN_PASSWORD; w Kubernetes syntetyzowana ścieżka helm materializuje ją jako Secret, do którego Deployment odwołuje się przez envsecretKeyRef, więc jawny tekst nigdy nie pojawia się w manifeście Deployment.
Czego tu nie zamodelowano
Grafana jest wdrażana samodzielnie. Podłączenie źródła metryk lub logów — na przykład serwera Prometheus — do Grafany jako aprowizowanego źródła danych nie jest modelowane: komponent nie deklaruje gniazda uses.
Generowanie przykładu
Ten przykład można zbudować za pomocą poniższych poleceń albo zlecić jego zbudowanie asystentowi AI.
Należy zapisać przykład w nowym folderze nazwanym tak jak on:
aggrega scaffold --example grafana-dashboardsNastępnie wypisuje polecenia do uruchomienia w dalszej kolejności. Pierwsze przechodzi do nowego folderu:
cd grafana-dashboardsKompilacja
Ta przestrzeń robocza nie zawiera pliku .aggrega-config.yaml, więc encje biblioteki standardowej są rozwiązywane z rejestru hub, hub.aggrega.ai, i flaga katalogu nie jest potrzebna; --auto-pull zapisuje w trakcie kompilacji plik blokady, którego brakuje w świeżym klonie:
# 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-pullWyrenderowane artefakty trafiają do dist/.
Z asystentem AI
Asystent AI skonfigurowany z narzędziami Aggrega może zrobić to samo: wystarczy wkleić mu ten prompt.
Używaj wyłącznie narzędzi Aggrega i nie twórz samodzielnie żadnego folderu. Jeśli folder obszaru roboczego nie zawiera jeszcze folderu `grafana-dashboards`, wywołaj raz narzędzie `scaffold` z `example` ustawionym na `grafana-dashboards` i bez `dir`: zapisuje ono przykład w nowym folderze `grafana-dashboards`. Następnie wywołaj narzędzie `build` raz dla każdej encji Release, w tej kolejności — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — za każdym razem z `workspace_root` ustawionym na `grafana-dashboards`, `release` ustawionym na ten plik, `auto_pull` ustawionym na true i `write` ustawionym na true. Podaj mi, które pliki zapisała każda kompilacja; znajdują się w `grafana-dashboards/dist/`.Uwaga o dostarczaniu poświadczeń
W ścieżce Compose poświadczenie jest sekretem typu inject-value
(aggregate-auth.yaml): jego wartość jest dostarczana kanałem środowiskowym komponentu
i staje się zmienną środowiskową usługi GF_SECURITY_ADMIN_PASSWORD.
Syntetyzowana ścieżka helm używa poświadczenia referencyjnego
(aggregate-helm-synth-auth.yaml): wartość jest materializowana jako Secret
Kubernetes, a Deployment odwołuje się do niego przez env secretKeyRef powiązane z
GF_SECURITY_ADMIN_PASSWORD. Hasło w postaci jawnej nigdy więc nie pojawia się w
manifeście Deployment — tylko w Secret.
Wartość origin w uwierzytelnionych Aggregates jest symbolem zastępczym do celów deweloperskich;
w każdym rzeczywistym wdrożeniu należy dostarczyć prawdziwą wartość ze źródła poświadczeń.
Uruchomienie (Compose)
aggrega build --release release-compose.yaml --auto-pulldocker compose -f dist/app/compose/docker-compose.yaml up -dNależy otworzyć http://localhost:3000 — interfejs webowy Grafana — i zalogować się jako admin
z hasłem deweloperskim. Środowisko usuwa się poleceniem
docker compose -f dist/app/compose/docker-compose.yaml down.