Redis — un Aggregate, deux cibles, authentification facultative
Cet exemple minimal compile un seul cache en mémoire Redis (protocole réseau de Redis) à 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
redisdirectement 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. Un second Aggregate, aggregate-auth.yaml, montre le même cache avec une information d’identification facultative de mot de passe rattachée pour le chemin Compose ; aggregate-helm-synth-auth.yaml rattache une information d’identification référençable pour le chemin helm synthétisé.
Les Recipes Redis du catalogue que cet exemple associe, compose/redis et helm/redis, déclarent la licence AGPL-3.0. L’exemple valkey-cache déploie Valkey, qui parle le même protocole réseau ; sa Recipe helm/valkey déclare BSD-3-Clause.
Fichiers
| Fichier | Rôle |
|---|---|
aggregate.yaml | Intention du développeur : un composant cache de type core/datastore/redis, sans information d’identification — le cache fonctionne sans authentification. |
aggregate-auth.yaml | Le même cache avec une information d’identification de mot de passe rattachée à l’emplacement facultatif password du composant (chemin Compose). |
aggregate-helm-synth-auth.yaml | Le même cache 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.yaml | Associe le type Redis à la Recipe Compose (compose/redis) et l’information d’identification à dotenv-secret. |
manifest-helm-synth.yaml | Associe le type Redis à la Recipe helm synthétisée (helm/redis) et l’information d’identification à k8s-secret-from-parameter. |
release-compose.yaml / release-helm-synth.yaml | Documents de l’opérateur pour les deux réalisations, sans authentification. |
release-compose-auth.yaml / release-helm-synth-auth.yaml | Enregistrements 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 datastore dans un rôle de cache. Redis est utilisé ici comme cache en mémoire et ne stocke rien de manière durable, si bien que le composant est typé comme un simple
serverplutôt que comme unstateful-server. Sur Kubernetes, la Recipe synthétisée rend un Deployment, et non un StatefulSet, et ne demande aucun volume persistant ; sur Compose, le service ne déclare aucun volume de données. - 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
redis— 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 nomredisest 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 nomscompose/redisethelm/redis. - Authentification facultative via un emplacement d’identifiants. Le composant déclare un emplacement facultatif
passworddans sonfeaturesSchema. Lorsqu’aucune information d’identification n’est rattachée (l’Aggregate de base), la Recipe rend le cache avec l’authentification désactivée — de manière identique octet par octet à une Recipe sans emplacement. Lorsqu’une information d’identification est rattachée, les deux cibles démarrent Redis avec--requirepass, si bien que le serveur exige le mot de passe : sur Compose (aggregate-auth.yaml), la valeur est transmise au serveur comme cet argument ; sur le chemin Kubernetes synthétisé (aggregate-helm-synth-auth.yaml), elle est matérialisée sous forme d’un Secret que référence le Deployment.
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 :
aggrega scaffold --example redis-cacheElle affiche ensuite les prochaines commandes à exécuter. La première vous place dans le nouveau dossier :
cd redis-cacheBuild
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 :
# Local development (Docker Compose), no authenticationaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), no authenticationaggrega 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-pullLes 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 Workspace ne contient pas encore de dossier `redis-cache`, appelez une fois l’outil `scaffold` avec `example` défini sur `redis-cache` et sans `dir` : il écrit l’exemple dans un nouveau dossier `redis-cache`. Appelez ensuite l’outil `build` une fois pour chaque Release, dans cet ordre — `release-compose.yaml`, `release-helm-synth.yaml`, `release-compose-auth.yaml` et `release-helm-synth-auth.yaml` — en définissant à chaque fois `workspace_root` sur `redis-cache`, `release` sur ce fichier, `auto_pull` sur true et `write` sur true. Indiquez-moi quels fichiers chaque build a écrits ; ils se trouvent sous `redis-cache/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 sous la variable que nomme son values.key, REDIS_PASSWORD, et la Recipe la transmet au serveur comme --requirepass. L’image officielle redis ne lit aucune variable de mot de passe, si bien que la valeur est transmise comme argument et apparaît dans la commande du service. Un rattachement dont la valeur n’atteint la Recipe sous aucune variable qu’elle lit arrête le build, en nommant l’emplacement, plutôt que de laisser le cache ouvert.
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, le Deployment la référence via un secretKeyRef d’environnement, et Redis est démarré avec --requirepass lisant cette variable d’environnement. Le mot de passe en clair n’apparaît donc jamais dans le manifeste du Deployment — seulement dans le Secret. C’est ce qui active réellement l’authentification sur l’image officielle redis, qui ne lit pas d’elle-même de mot de passe depuis l’environnement.
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.