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

Zustellung von Zugangsdaten — `secretKeyRef` von Ende zu Ende

Eine einzelne PostgreSQL-Datenbank, deren Passwort vom Zugangsdaten-Subsystem geliefert wird, gezeigt pro Provider. Derselbe Slot password an core/datastore/postgres akzeptiert jede der beiden Zugangsdaten-Familien; die Familie, die der Entwickler anbindet, entscheidet, wie das Passwort zugestellt wird, und das Recipe der Datenbank liest den Slot so, wie sein Provider es unterstützt.

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

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

Terminal window
cd credential-secretkeyref

Build

Dieses Beispiel hat drei Releases. Bauen Sie pro Lauf eines:

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)

Jedes Release löst seine Katalogentitäten über die .aggrega-config.yaml dieses Workspace auf, aus der Hub-Registry, die sie als Standard nennt, daher ist kein Flag --catalog nötig, und --auto-pull schreibt während des Builds das Lockfile, das einem frischen Klon fehlt.

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 `credential-secretkeyref` enthält, rufen Sie das Tool `scaffold` einmal mit `example` auf `credential-secretkeyref` gesetzt und ohne `dir` auf: Es schreibt das Beispiel in einen neuen Ordner `credential-secretkeyref`. Rufen Sie dann das Tool `build` einmal für jedes Release auf, in dieser Reihenfolge — `release-helm.yaml`, `release-compose.yaml` — jedes Mal mit `workspace_root` auf `credential-secretkeyref`, `release` auf diese Datei, `auto_pull` auf true und `write` auf true gesetzt. Rufen Sie dann das Tool `build` auf dieselbe Weise mit `release` auf `release-negative.yaml` gesetzt auf: Dieser Build soll abgelehnt werden, lesen Sie mir also die Ablehnung vor. Nennen Sie mir die Dateien, die jeder Build geschrieben hat; sie liegen unter `credential-secretkeyref/dist/`.

Helm — ein referenzierbares Secret + secretKeyRef

aggregate-helm.yaml bindet core/referenced-secret an den Slot password an. Das Manifest bildet das auf k8s-secret-from-parameter ab, das ein Kubernetes-Secret materialisiert und die Identität des Secrets als provides {name, key} veröffentlicht. Das postgres-Helm-Recipe referenziert den Slot über containers.attachments, das der Synthesizer als env-secretKeyRef rendert.

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

Das erzeugte Secret (dist/helm/helm/db--password--db-secret-db-password.yaml) und der secretKeyRef der Datenbank (dist/helm/helm/db-statefulset.yaml) nennen dieselbe Ressource, weil beide .features.password.provides.name lesen — es gibt keine erneute Ableitung und keine Konvention, auf die sich die beiden Seiten einigen müssten:

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 — Zugangsdaten mit injiziertem Wert

aggregate-compose.yaml bindet core/secret-value an. Compose hat kein Primitiv Secret-Ressource / secretKeyRef, daher bildet das Manifest die Zugangsdaten auf dotenv-secret ab, das den Wert über die Injektions-Pipe unter dem Schlüssel zustellt, den die Anbindung in values.key nennt, hier POSTGRES_PASSWORD, und das postgres-Compose-Recipe liest ihn unter diesem Schlüssel.

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

Negativ — eine nicht referenzierbare Füllung, von einer Referenz abgelehnt

aggregate-negative.yaml bindet die Zugangsdaten mit injiziertem Wert core/secret-value an den Slot password an und baut dann auf helm, wo das postgres-Recipe den Slot über containers.attachments (ein secretKeyRef) referenziert. Ein secretKeyRef braucht eine Secret-Ressource, auf die er zeigt, aber Zugangsdaten mit injiziertem Wert veröffentlichen keine — daher bricht der Build unübersehbar ab:

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]

Dieses Release soll fehlschlagen — der Abbruch ist die Lektion. Der Build endet mit 1, statt Erfolg zu melden, sodass der Guardrail für Lesende und für jedes Skript, das ihn ausführt, sichtbar ist.

Es gibt zwei Lösungen. Binden Sie referenzierbare Zugangsdaten (core/referenced-secret) an, wie in aggregate-helm.yaml; oder behalten Sie die Anbindung core/secret-value bei und ordnen Sie sie im Manifest k8s-secret-from-value zu, der Helm-Realisierung von core/secret-value, die den Wert in ein Secret schreibt, das sie erzeugt, und Namen und Schlüssel dieses Secrets veröffentlicht, sodass die Referenz eine Ressource hat, auf die sie zeigen kann. An env-secret gebunden, erreichen Zugangsdaten mit injiziertem Wert den Container stattdessen über die Injektions-Pipe, nie über eine Referenz containers.attachments.