Zum Inhalt springen
AggregaAggrega
Sprache wählen: Deutsch
Diese Seite wurde maschinell übersetzt. Das englische Original lesen.

Grafana — ein Aggregate, zwei Ziele, optionale Admin-Zugangsdaten

Dieses Beispiel kompiliert einen einzelnen Grafana-Server für Dashboards und Visualisierung aus einem einzigen vom Entwickler verfassten Aggregate zu zwei Realisierungen:

  • Docker Compose für die lokale Entwicklung und
  • das synthetisierte helm-Recipe, das das offizielle Upstream-Image grafana/grafana direkt auf Kubernetes ausführt (kein externes Chart).

Das synthetisierte helm-Recipe ist der Kubernetes-Pfad: Es hängt nur von einem offiziellen Image-Tag statt von einem Chart eines Drittanbieters ab, und seine gerenderte Ressourcenmenge ist genau das, was die Arbeitslast deklariert.

Dasselbe aggregate.yaml steuert beide. Pro Realisierung ändert sich nur die vom Manifest ausgewählte Recipe-Schicht. Zwei weitere Aggregates zeigen denselben Server mit angebundenen optionalen Zugangsdaten für das Admin-Passwort: aggregate-auth.yaml für den Compose-Pfad (Zugangsdaten vom Typ inject-value, als Umgebungsvariable bereitgestellt) und aggregate-helm-synth-auth.yaml für den synthetisierten helm-Pfad (referenzierbare Zugangsdaten, als Kubernetes-Secret materialisiert).

Der paketierte Grafana-Server steht unter AGPL-3.0.

Dateien

DateiRolle
aggregate.yamlEntwicklerabsicht: eine Komponente dashboards vom Typ core/observability/grafana, keine Zugangsdaten — das Admin-Konto verwendet das deterministische Entwicklungspasswort des Recipe.
aggregate-auth.yamlDerselbe Server mit Zugangsdaten für das Admin-Passwort, angebunden an den optionalen Slot admin_password der Komponente (Compose-Pfad).
aggregate-helm-synth-auth.yamlDerselbe Server mit referenzierbaren Zugangsdaten, angebunden für den synthetisierten helm-Pfad — der Wert wird als Kubernetes-Secret materialisiert, das das Deployment referenziert.
manifest-compose.yamlBildet den Grafana-Typ auf das Compose-Recipe (compose/grafana) und die Zugangsdaten auf dotenv-secret ab.
manifest-helm-synth.yamlBildet den Grafana-Typ auf das synthetisierte helm-Recipe (helm/grafana) und die Zugangsdaten auf k8s-secret-from-parameter ab.
release-compose.yaml / release-helm-synth.yamlBetreiber-Datensätze für die beiden Realisierungen, ohne angebundene Zugangsdaten.
release-compose-auth.yaml / release-helm-synth-auth.yamlBetreiber-Datensätze, die die Authentifizierung aktivieren.

Was es zeigt

  • Eine Authoring-Oberfläche, viele Ziele. Ein einziges Aggregate ist die maßgebliche Quelle dafür, was der Stack ist. Jedes Manifest sagt, wie er zu realisieren ist.
  • Ein Server mit einem persistenten Volume. Grafana hält seinen Zustand — Benutzer, gespeicherte Dashboards, Einstellungen — auf der Festplatte, daher deklariert die Komponente ein Daten-Volume, dessen Größe aus infra.storage stammt. Auf Kubernetes rendert das synthetisierte helm-Recipe ein Deployment mit einem PersistentVolumeClaim, der unter /var/lib/grafana eingehängt ist; auf Compose hängt der Service ein benanntes Volume unter demselben Pfad ein.
  • Workload-Synthese (Kubernetes). Das synthetisierte helm-Recipe deklariert eine Workload — ein Deployment plus einen ClusterIP-Service, der das offizielle Image grafana/grafana ausführt —, die der helm-Provider ohne externes Chart in Kubernetes-Manifeste übersetzt. Die gerenderte Ressourcenmenge ist genau das, was die Workload deklariert. Da der Name grafana sowohl von einem Compose- als auch von einem synthetisierten helm-Recipe getragen wird, referenzieren die Manifests sie auf den Provider bezogen als compose/grafana und helm/grafana.
  • Ein deterministisches Admin-Passwort. Das Grafana-Admin-Konto ist immer vorhanden. Diese Komponente verdrahtet das Passwort über einen optionalen Zugangsdaten-Slot admin_password: Sind keine Zugangsdaten angebunden (das Basis-Aggregate), setzt das Recipe ein deterministisches Entwicklungspasswort, sodass das Rendering über Läufe hinweg byteidentisch ist; sind Zugangsdaten angebunden, wird der injizierte Wert zum Admin-Passwort. Auf Compose erscheint er als Umgebungsvariable GF_SECURITY_ADMIN_PASSWORD; auf Kubernetes materialisiert der synthetisierte helm-Pfad ihn als Secret, das das Deployment über einen secretKeyRef in der Umgebung referenziert, sodass der Klartext nie im Deployment-Manifest erscheint.

Hier nicht modelliert

Grafana wird eigenständig bereitgestellt. Das Anbinden einer Metrik- oder Log-Quelle — zum Beispiel eines Prometheus-Servers — an Grafana als vorab eingerichtete Datenquelle ist nicht modelliert: Die Komponente deklariert keinen Socket uses.

Das Beispiel generieren

Sie können dieses Beispiel mit den folgenden Befehlen bauen oder es von Ihrem KI-Assistenten für Sie bauen lassen.

Schreiben Sie das Beispiel in einen neuen Ordner, der nach ihm benannt ist:

Terminal window
aggrega scaffold --example grafana-dashboards

Danach gibt er die als Nächstes auszuführenden Befehle aus. Der erste wechselt in den neuen Ordner:

Terminal window
cd grafana-dashboards

Build

Dieser Workspace enthält kein .aggrega-config.yaml, daher werden die Entitäten der Standardbibliothek aus der Hub-Registry hub.aggrega.ai aufgelöst, und es ist kein Katalog-Flag nötig; --auto-pull schreibt während des Builds das Lockfile, das einem frischen Klon fehlt:

Terminal window
# Local development (Docker Compose), development admin password
aggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), development admin password
aggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabled
aggrega build --release release-compose-auth.yaml --auto-pull
aggrega build --release release-helm-synth-auth.yaml --auto-pull

Gerenderte Artefakte landen unter dist/.

Mit einem KI-Assistenten

Ein KI-Assistent, der mit den Tools von Aggrega eingerichtet ist, kann dasselbe tun: Fügen Sie ihm diesen Prompt ein.

Verwenden Sie ausschließlich die Aggrega-Tools und legen Sie selbst keinen Ordner an. Wenn der Arbeitsbereichsordner noch keinen Ordner `grafana-dashboards` enthält, rufen Sie das Tool `scaffold` einmal mit `example` auf `grafana-dashboards` gesetzt und ohne `dir` auf: Es schreibt das Beispiel in einen neuen Ordner `grafana-dashboards`. Rufen Sie dann das Tool `build` einmal für jedes Release auf, in dieser Reihenfolge — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — jedes Mal mit `workspace_root` auf `grafana-dashboards`, `release` auf diese Datei, `auto_pull` auf true und `write` auf true gesetzt. Nennen Sie mir die Dateien, die jeder Build geschrieben hat; sie liegen unter `grafana-dashboards/dist/`.

Hinweis zur Zustellung der Zugangsdaten

Auf dem Compose-Pfad sind die Zugangsdaten ein Secret vom Typ inject-value (aggregate-auth.yaml): Sein Wert wird über die Umgebungs-Pipe der Komponente zugestellt und wird zur Service-Umgebungsvariable GF_SECURITY_ADMIN_PASSWORD.

Der synthetisierte helm-Pfad verwendet referenzierbare Zugangsdaten (aggregate-helm-synth-auth.yaml): Der Wert wird als Kubernetes-Secret materialisiert, und das Deployment referenziert es über einen secretKeyRef in der Umgebung, der an GF_SECURITY_ADMIN_PASSWORD gebunden ist. Das Klartext-Passwort erscheint daher nie im Deployment-Manifest — nur im Secret.

Der Wert origin in den authentifizierten Aggregates ist ein Platzhalter für die Entwicklung; liefern Sie für jede reale Bereitstellung einen echten Wert über Ihre Zugangsdatenquelle.

Ausführen (Compose)

Terminal window
aggrega build --release release-compose.yaml --auto-pull
docker compose -f dist/app/compose/docker-compose.yaml up -d

Öffnen Sie http://localhost:3000 — die Web-UI von Grafana — und melden Sie sich als admin mit dem Entwicklungspasswort an. Abbauen mit docker compose -f dist/app/compose/docker-compose.yaml down.