Aller au contenu
AggregaAggrega
Selectionner la langue: Français
Cette page a été traduite automatiquement. Lire l’original en anglais.

Grafana — un Aggregate, deux cibles, information d’identification d’administration facultative

Cet exemple compile un seul serveur de tableaux de bord et de visualisation Grafana à partir d’un seul Aggregate écrit par le développeur en deux réalisations :

  • Docker Compose pour le développement local, et
  • la Recipe helm synthétisée qui exécute l’image upstream officielle grafana/grafana directement sur Kubernetes (aucun chart externe).

La Recipe helm synthétisée est le chemin Kubernetes : elle ne dépend que d’un tag d’image officiel plutôt que d’un chart tiers, et son ensemble de ressources rendu est exactement ce que déclare la charge de travail.

Le même aggregate.yaml pilote les deux. Seule la couche de Recipe sélectionnée par le Manifest change d’une réalisation à l’autre. Deux autres Aggregates montrent le même serveur avec une information d’identification facultative de mot de passe d’administration rattachée : aggregate-auth.yaml pour le chemin Compose (une information d’identification inject-value exposée sous forme de variable d’environnement), et aggregate-helm-synth-auth.yaml pour le chemin helm synthétisé (une information d’identification référençable matérialisée sous forme de Secret Kubernetes).

Le serveur Grafana empaqueté est sous licence AGPL-3.0.

Fichiers

FichierRôle
aggregate.yamlIntention du développeur : un composant dashboards de type core/observability/grafana, sans information d’identification — le compte d’administration utilise le mot de passe de développement déterministe de la Recipe.
aggregate-auth.yamlLe même serveur avec une information d’identification de mot de passe d’administration rattachée à l’emplacement facultatif admin_password du composant (chemin Compose).
aggregate-helm-synth-auth.yamlLe même serveur avec une information d’identification référençable rattachée pour le chemin helm synthétisé — la valeur est matérialisée sous forme d’un Secret Kubernetes que référence le Deployment.
manifest-compose.yamlAssocie le type Grafana à la Recipe Compose (compose/grafana) et l’information d’identification à dotenv-secret.
manifest-helm-synth.yamlAssocie le type Grafana à la Recipe helm synthétisée (helm/grafana) et l’information d’identification à k8s-secret-from-parameter.
release-compose.yaml / release-helm-synth.yamlEnregistrements de l’opérateur pour les deux réalisations, sans information d’identification rattachée.
release-compose-auth.yaml / release-helm-synth-auth.yamlEnregistrements de l’opérateur qui activent l’authentification.

Ce qu’il démontre

  • Une seule surface de rédaction, plusieurs cibles. Un seul Aggregate est la source de vérité sur ce qu’est la stack. Chaque Manifest dit comment la réaliser.
  • Un serveur adossé à un volume persistant. Grafana conserve son état — utilisateurs, tableaux de bord enregistrés, préférences — sur disque, si bien que le composant déclare un volume de données dimensionné à partir de infra.storage. Sur Kubernetes, la Recipe helm synthétisée rend un Deployment avec un PersistentVolumeClaim monté sur /var/lib/grafana ; sur Compose, le service monte un volume nommé sur le même chemin.
  • Synthèse de Workload (Kubernetes). La Recipe helm synthétisée déclare un Workload — un Deployment plus un Service ClusterIP exécutant l’image officielle grafana/grafana — que le fournisseur helm traduit en manifestes Kubernetes sans aucun chart externe. L’ensemble de ressources rendu est exactement ce que déclare le Workload. Comme le nom grafana est porté à la fois par une Recipe Compose et par une helm synthétisée, les Manifests les référencent avec une portée de fournisseur sous les noms compose/grafana et helm/grafana.
  • Un mot de passe d’administration déterministe. Le compte d’administration de Grafana est toujours présent. Ce composant câble le mot de passe via un emplacement d’informations d’identification facultatif admin_password : lorsqu’aucune information d’identification n’est rattachée (l’Aggregate de base), la Recipe définit un mot de passe de développement déterministe, si bien que le rendu est identique octet par octet d’une exécution à l’autre ; lorsqu’une information d’identification est rattachée, la valeur injectée devient le mot de passe d’administration. Sur Compose, elle apparaît sous forme de variable d’environnement GF_SECURITY_ADMIN_PASSWORD ; sur Kubernetes, le chemin helm synthétisé la matérialise sous forme d’un Secret que le Deployment référence via un secretKeyRef d’environnement, si bien que le texte en clair n’apparaît jamais dans le manifeste du Deployment.

Non modélisé ici

Grafana est déployé de manière autonome. Le câblage d’une source de métriques ou de logs — par exemple un serveur Prometheus — dans Grafana en tant que source de données provisionnée n’est pas modélisé : le composant ne déclare aucun socket uses.

Générer l’exemple

Vous pouvez construire cet exemple avec les commandes ci-dessous, ou le faire construire pour vous par votre assistant IA.

Écrivez l’exemple dans un nouveau dossier qui porte son nom :

Terminal window
aggrega scaffold --example grafana-dashboards

Elle affiche ensuite les prochaines commandes à exécuter. La première vous place dans le nouveau dossier :

Terminal window
cd grafana-dashboards

Build

Ce workspace ne contient aucun .aggrega-config.yaml, si bien que les entités de la bibliothèque standard sont résolues depuis le registre du hub, hub.aggrega.ai, et aucune option de catalogue n’est nécessaire ; --auto-pull écrit pendant le build le lockfile qui manque à un clone récent :

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

Les artefacts rendus atterrissent sous dist/.

Avec un assistant IA

Un assistant IA configuré avec les outils d’Aggrega peut faire de même : collez-lui ce prompt.

Utilisez uniquement les outils Aggrega et ne créez vous-même aucun dossier. Si le dossier de l’espace de travail ne contient pas encore de dossier `grafana-dashboards`, appelez une fois l’outil `scaffold` avec `example` défini sur `grafana-dashboards` et sans `dir` : il écrit l’exemple dans un nouveau dossier `grafana-dashboards`. Appelez ensuite l’outil `build` une fois pour chaque Release, dans cet ordre — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml`, `release-helm-synth-auth.yaml` — en définissant à chaque fois `workspace_root` sur `grafana-dashboards`, `release` sur ce fichier, `auto_pull` sur true et `write` sur true. Indiquez-moi les fichiers écrits par chaque build ; ils se trouvent sous `grafana-dashboards/dist/`.

Note sur la livraison des informations d’identification

Sur le chemin Compose, l’information d’identification est un secret inject-value (aggregate-auth.yaml) : sa valeur est livrée sur le pipe d’environnement du composant et devient la variable d’environnement de service GF_SECURITY_ADMIN_PASSWORD.

Le chemin helm synthétisé utilise une information d’identification référençable (aggregate-helm-synth-auth.yaml) : la valeur est matérialisée sous forme de Secret Kubernetes, et le Deployment la référence via un secretKeyRef d’environnement lié à GF_SECURITY_ADMIN_PASSWORD. Le mot de passe en clair n’apparaît donc jamais dans le manifeste du Deployment — seulement dans le Secret.

La valeur origin dans les Aggregates authentifiés est un espace réservé de développement ; fournissez une valeur réelle via votre source d’informations d’identification pour tout déploiement réel.

L’exécuter (Compose)

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

Ouvrez http://localhost:3000 — l’interface web de Grafana — et connectez-vous en tant que admin avec le mot de passe de développement. Pour tout arrêter, utilisez docker compose -f dist/app/compose/docker-compose.yaml down.