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

Livraison des informations d’identification — `secretKeyRef` de bout en bout

Une seule base de données PostgreSQL dont le mot de passe est fourni par le sous-système des informations d’identification, présenté par fournisseur. Le même slot password sur core/datastore/postgres accepte l’une ou l’autre famille d’informations d’identification ; la famille que rattache le développeur décide de la façon dont le mot de passe est livré, et la Recipe de la base de données lit le slot de la façon que prend en charge son fournisseur.

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 credential-secretkeyref

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

Terminal window
cd credential-secretkeyref

Build

Cet exemple a trois releases. Construisez-en une par exécution :

Terminal window
aggrega build --release release-helm.yaml --auto-pull
aggrega build --release release-compose.yaml --auto-pull
aggrega build --release release-negative.yaml --auto-pull # expected to fail (see below)

Chaque release résout ses entités de catalogue via le .aggrega-config.yaml de cet espace de travail, depuis le registre du hub qu’il nomme par défaut, si bien qu’aucun flag --catalog n’est nécessaire, et --auto-pull écrit pendant le build le lockfile qui manque à un clone récent.

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 `credential-secretkeyref`, appelez une fois l’outil `scaffold` avec `example` défini sur `credential-secretkeyref` et sans `dir` : il écrit l’exemple dans un nouveau dossier `credential-secretkeyref`. Appelez ensuite l’outil `build` une fois pour chaque Release, dans cet ordre — `release-helm.yaml`, `release-compose.yaml` — en définissant à chaque fois `workspace_root` sur `credential-secretkeyref`, `release` sur ce fichier, `auto_pull` sur true et `write` sur true. Appelez ensuite l’outil `build` de la même manière avec `release` défini sur `release-negative.yaml` : ce build doit être refusé, alors lisez-moi le refus. Indiquez-moi les fichiers écrits par chaque build ; ils se trouvent sous `credential-secretkeyref/dist/`.

Helm — un Secret référençable + secretKeyRef

aggregate-helm.yaml rattache core/referenced-secret au slot password. Le Manifest le fait correspondre à k8s-secret-from-parameter, qui matérialise un Secret Kubernetes et publie l’identité du Secret sous la forme provides {name, key}. La Recipe helm de postgres référence le slot via containers.attachments, que le synthétiseur rend sous la forme d’un secretKeyRef d’env.

Terminal window
aggrega build --release release-helm.yaml --auto-pull

Le Secret généré (dist/helm/helm/db--password--db-secret-db-password.yaml) et le secretKeyRef de la base de données (dist/helm/helm/db-statefulset.yaml) nomment la même ressource, parce que les deux lisent .features.password.provides.name — il n’y a aucune re-dérivation ni aucune convention sur laquelle les deux côtés devraient s’accorder :

db--password--db-secret-db-password.yaml
[… omitted: the apiVersion and the Secret kind]
metadata:
name: db-password
[… omitted: the labels and annotations every rendered document carries]
stringData:
POSTGRES_PASSWORD: "dev-pw-change-me"
# db-statefulset.yaml (container env)
- name: POSTGRES_PASSWORD
valueFrom:
secretKeyRef:
name: db-password # == the Secret's metadata.name
key: POSTGRES_PASSWORD # == the Secret's data key

Compose — une information d’identification à valeur injectée

aggregate-compose.yaml rattache core/secret-value. Compose n’a pas de primitive ressource Secret / secretKeyRef, si bien que le Manifest fait correspondre l’information d’identification à dotenv-secret, qui livre la valeur sur le pipe d’injection sous la clé que le rattachement nomme dans values.key, ici POSTGRES_PASSWORD, et la Recipe compose de postgres la lit sous cette clé.

Terminal window
aggrega build --release release-compose.yaml --auto-pull
# dist/compose/compose/docker-compose.yaml → POSTGRES_PASSWORD: dev-pw-change-me

Négatif — un remplissage non référençable rejeté par une référence

aggregate-negative.yaml rattache l’information d’identification à valeur injectée core/secret-value au slot password, puis construit sur helm, où la Recipe de postgres référence le slot via containers.attachments (un secretKeyRef). Un secretKeyRef a besoin d’une ressource Secret vers laquelle pointer, mais une information d’identification à valeur injectée n’en publie aucune — si bien que le build s’arrête de manière explicite :

Terminal window
aggrega build --release release-negative.yaml --auto-pull
# [… omitted: the pull's lines, which carry the same halt, and two lint notices]
# [CATALOG_ERROR E0212] instance db
# rendering node "db"
# [… omitted: the cause, "workload attachment slot is not referenceable", naming the Recipe and its path in your catalog, then one line each for the "name" and the "key" the slot's provides does not expose]

Cette release est censée échouer — l’arrêt est la leçon. Le build se termine avec 1 au lieu de signaler un succès, si bien que le garde-fou est visible pour un lecteur et pour tout script qui l’exécute.

Il existe deux corrections. Rattachez une information d’identification référençable (core/referenced-secret), comme dans aggregate-helm.yaml ; ou conservez le rattachement core/secret-value et mappez-le dans le Manifest vers k8s-secret-from-value, la réalisation Helm de core/secret-value qui écrit la valeur dans un Secret qu’elle émet et publie le nom et la clé de ce Secret, de sorte que la référence dispose d’une ressource vers laquelle pointer. Liée à env-secret, une information d’identification à valeur injectée atteint au contraire le conteneur par le pipe d’injection, jamais par une référence containers.attachments.