Grafana — un Aggregate, due target, credenziale di amministrazione facoltativa
Questo esempio compila un singolo server di dashboard e visualizzazione Grafana a partire da un unico Aggregate scritto dallo sviluppatore in due realizzazioni:
- Docker Compose per lo sviluppo locale, e
- la Recipe helm sintetizzata che esegue l’immagine upstream ufficiale
grafana/grafanadirettamente su Kubernetes (nessun chart esterno).
La Recipe helm sintetizzata è il percorso Kubernetes: dipende solo da un tag di immagine ufficiale anziché da un chart di terze parti, e il suo insieme di risorse renderizzato è esattamente ciò che dichiara il carico di lavoro.
Lo stesso aggregate.yaml guida entrambe. Per ogni realizzazione cambia solo il livello di Recipe selezionato dal Manifest. Altri due Aggregates mostrano lo stesso server con una credenziale facoltativa per la password di amministrazione associata: aggregate-auth.yaml per il percorso Compose (una credenziale inject-value esposta come variabile d’ambiente), e aggregate-helm-synth-auth.yaml per il percorso helm sintetizzato (una credenziale referenziabile materializzata come Secret Kubernetes).
Il server Grafana pacchettizzato è AGPL-3.0.
File
| File | Ruolo |
|---|---|
aggregate.yaml | Intento dello sviluppatore: un componente dashboards di tipo core/observability/grafana, nessuna credenziale — l’account di amministrazione usa la password di sviluppo deterministica della Recipe. |
aggregate-auth.yaml | Lo stesso server con una credenziale per la password di amministrazione associata allo slot facoltativo admin_password del componente (percorso Compose). |
aggregate-helm-synth-auth.yaml | Lo stesso server con una credenziale referenziabile associata per il percorso helm sintetizzato — il valore viene materializzato come un Secret Kubernetes a cui fa riferimento il Deployment. |
manifest-compose.yaml | Mappa il tipo Grafana sulla Recipe Compose (compose/grafana) e la credenziale su dotenv-secret. |
manifest-helm-synth.yaml | Mappa il tipo Grafana sulla Recipe helm sintetizzata (helm/grafana) e la credenziale su k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Documenti dell’operatore per le due realizzazioni, nessuna credenziale associata. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Documenti dell’operatore che abilitano l’autenticazione. |
Che cosa dimostra
- Un’unica superficie di authoring, molti target. Un unico Aggregate è la fonte di verità su che cosa è lo stack. Ogni Manifest dice come realizzarlo.
- Un server appoggiato a un volume persistente. Grafana conserva il proprio stato — utenti, dashboard salvate, preferenze — su disco, quindi il componente dichiara un volume di dati dimensionato a partire da
infra.storage. Su Kubernetes la Recipe helm sintetizzata renderizza un Deployment con un PersistentVolumeClaim montato in/var/lib/grafana; su Compose il servizio monta un volume con nome nello stesso percorso. - Sintesi del Workload (Kubernetes). La Recipe helm sintetizzata dichiara un Workload — un Deployment più un Service ClusterIP che esegue l’immagine ufficiale
grafana/grafana— che il provider helm traduce in manifest Kubernetes senza alcun chart esterno. L’insieme di risorse renderizzato è esattamente ciò che dichiara il Workload. Poiché il nomegrafanaè portato sia da una Recipe Compose sia da una helm sintetizzata, i Manifests vi fanno riferimento con ambito di provider comecompose/grafanaehelm/grafana. - Una password di amministrazione deterministica. L’account di amministrazione di Grafana è sempre presente. Questo componente cabla la password attraverso uno slot di credenziale facoltativo
admin_password: quando non è associata alcuna credenziale (l’Aggregate di base) la Recipe imposta una password di sviluppo deterministica, così il rendering è identico byte per byte tra un’esecuzione e l’altra; quando è associata una credenziale, il valore iniettato diventa la password di amministrazione. Su Compose emerge come variabile d’ambienteGF_SECURITY_ADMIN_PASSWORD; su Kubernetes il percorso helm sintetizzato la materializza come un Secret a cui il Deployment fa riferimento tramite unsecretKeyRefenv, così il testo in chiaro non compare mai nel manifest del Deployment.
Non modellato qui
Grafana è distribuito in modo autonomo. Il cablaggio di una sorgente di metriche o di log — per esempio un server Prometheus — in Grafana come datasource predisposto non è modellato: il componente non dichiara alcun socket uses.
Generare l’esempio
Puoi eseguire la build di questo esempio con i comandi qui sotto, oppure farla eseguire al tuo assistente IA.
Scrivi l’esempio in una nuova cartella che porta il suo nome:
aggrega scaffold --example grafana-dashboardsPoi stampa i prossimi comandi da eseguire. Il primo ti porta nella nuova cartella:
cd grafana-dashboardsBuild
Questo workspace non contiene alcun .aggrega-config.yaml, quindi le entità della libreria standard vengono risolte dal registry dell’hub, hub.aggrega.ai, e non serve alcun flag di catalogo; --auto-pull scrive durante il build il lockfile che manca a un clone appena creato:
# 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-pullGli artefatti renderizzati finiscono sotto dist/.
Con un assistente AI
Un assistente IA configurato con gli strumenti di Aggrega può fare lo stesso: incolla questo prompt nell’assistente.
Usa solo gli strumenti di Aggrega e non creare tu alcuna cartella. Se la cartella dell’area di lavoro non contiene ancora una cartella `grafana-dashboards`, chiama una volta lo strumento `scaffold` con `example` impostato a `grafana-dashboards` e senza `dir`: scrive l’esempio in una nuova cartella `grafana-dashboards`. Poi chiama lo strumento `build` una volta per ogni Release, in quest’ordine — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — ogni volta con `workspace_root` impostato a `grafana-dashboards`, `release` impostato a quel file, `auto_pull` impostato a true e `write` impostato a true. Dimmi quali file ha scritto ciascuna build; si trovano in `grafana-dashboards/dist/`.Nota sulla consegna delle credenziali
Sul percorso Compose la credenziale è un segreto inject-value (aggregate-auth.yaml): il suo valore viene consegnato sulla pipe d’ambiente del componente e diventa la variabile d’ambiente del servizio GF_SECURITY_ADMIN_PASSWORD.
Il percorso helm sintetizzato usa una credenziale referenziabile (aggregate-helm-synth-auth.yaml): il valore viene materializzato come Secret Kubernetes, e il Deployment vi fa riferimento tramite un secretKeyRef env legato a GF_SECURITY_ADMIN_PASSWORD. La password in chiaro quindi non compare mai nel manifest del Deployment — solo nel Secret.
Il valore origin negli Aggregates autenticati è un segnaposto di sviluppo; fornisci un valore reale tramite la tua sorgente di credenziali per qualsiasi distribuzione reale.
Eseguirlo (Compose)
aggrega build --release release-compose.yaml --auto-pulldocker compose -f dist/app/compose/docker-compose.yaml up -dApri http://localhost:3000 — la UI web di Grafana — e accedi come admin con la password di sviluppo. Per smontarlo, usa docker compose -f dist/app/compose/docker-compose.yaml down.