コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

認証情報の受け渡し — `secretKeyRef` のエンドツーエンド

パスワードが認証情報サブシステムから供給される単一の PostgreSQL データベースを、プロバイダーごとに示します。core/datastore/postgres の同じ password スロットは、どちらの認証情報ファミリーも受け付けます。開発者がアタッチするファミリーによってパスワードの受け渡し方法が決まり、データベースの Recipe は、そのプロバイダーがサポートする方法でスロットを読み取ります。

サンプルを生成する

このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。

例の名前を付けた新しいフォルダーに例を書き出します。

Terminal window
aggrega scaffold --example credential-secretkeyref

その後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。

Terminal window
cd credential-secretkeyref

ビルド

この例には 3 つの release があります。1 回の実行につき 1 つをビルドします。

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)

どのリリースも、このワークスペースの .aggrega-config.yaml を通じて、それがデフォルトとして指定するハブレジストリからカタログのエンティティを解決するため、--catalog フラグは不要です。また --auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。

AI アシスタントを使う

Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。

Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `credential-secretkeyref` フォルダーがない場合は、`example` を `credential-secretkeyref` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、例が新しい `credential-secretkeyref` フォルダーに書き込まれます。次に、各 Release について `build` ツールを 1 回ずつ、`release-helm.yaml`、`release-compose.yaml` の順に呼び出してください。毎回、`workspace_root` を `credential-secretkeyref`、`release` をそのファイル、`auto_pull` を true、`write` を true に設定します。次に、同じ方法で `release` を `release-negative.yaml` に設定して `build` ツールを呼び出してください。これは拒否されることを意図したものなので、拒否の内容を読み上げてください。各ビルドが書き込んだファイルを教えてください。ファイルは `credential-secretkeyref/dist/` の下にあります。

Helm — 参照可能な Secret + secretKeyRef

aggregate-helm.yaml は core/referenced-secret を password スロットにアタッチします。Manifest はこれを k8s-secret-from-parameter にマッピングし、これが Kubernetes の Secret を生成して、その Secret の識別情報を provides {name, key} として公開します。postgres の helm Recipe は containers.attachments を通じてスロットを参照し、シンセサイザーはこれを env の secretKeyRef としてレンダリングします。

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

生成された Secret(dist/helm/helm/db--password--db-secret-db-password.yaml)とデータベースの secretKeyRef(dist/helm/helm/db-statefulset.yaml)は、どちらも .features.password.provides.name を読み取るため、同じリソースを指します。再導出はなく、両者が合わせるべき慣例もありません。

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 — inject-value の認証情報

aggregate-compose.yaml は core/secret-value をアタッチします。Compose には Secret リソース / secretKeyRef のプリミティブがないため、Manifest は認証情報を dotenv-secret にマッピングし、これがアタッチメントの values.key で指定されたキー(ここでは POSTGRES_PASSWORD)の下で inject パイプに値を受け渡します。postgres の compose Recipe はそのキーで値を読み取ります。

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

失敗例 — 参照から拒否される参照不可能なフィル

aggregate-negative.yaml は inject-value の core/secret-value を password スロットにアタッチし、helm でビルドします。helm では postgres の Recipe が containers.attachments(secretKeyRef)を介してスロットを参照します。secretKeyRef には指し示す Secret リソースが必要ですが、inject-value の認証情報はそれを公開しないため、ビルドは明示的に停止します。

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]

このリリースは失敗することが想定されており、停止そのものが学ぶべき点です。ビルドは成功を報告するのではなく 1 で終了するため、このガードレールは読者にも、これを実行するどのスクリプトにも見えます。

修正方法は 2 つあります。aggregate-helm.yaml のように参照可能な認証情報(core/referenced-secret)をアタッチするか、core/secret-value のアタッチメントをそのまま残し、Manifest でそれを k8s-secret-from-value にマッピングします。これは core/secret-value の Helm の実現で、出力する Secret に値を書き込み、その Secret の名前とキーを公開するため、参照が指すリソースが存在します。env-secret にバインドした場合、inject-value の認証情報は、containers.attachments の参照ではなく、inject パイプを通じてコンテナに届きます。