external-secrets — Kubernetes のシークレット同期オペレーター
この例では、小規模ながら実際のスタックである external-secrets オペレーターを、
Developer が記述した 1 つの Aggregate から Kubernetes へコンパイルします。基盤には公式の
external-secrets Helm チャートを使用します。
external-secrets は、外部のシークレット管理システム(HashiCorp Vault、AWS Secrets Manager、
Google Secret Manager、Azure Key Vault など)からシークレットを
ネイティブの Kubernetes Secret に同期し、ソースの変更に合わせて同期状態を保ちます。
アプリケーションがルーティングする先のサーバーではなく、独自のカスタムリソースで
クラスター API を拡張するクラスタースコープのコントローラーであるため、
uses エッジを取らず、公開するのは Prometheus サーバーがメトリクスを見つける場所だけです。
アプリケーションは ExternalSecret リソースと SecretStore リソースを宣言して
シークレットを取得し、オペレーターが対応する Kubernetes の Secret を生成します。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:リリースとともにカスタムリソース定義をインストールする単一の external-secrets コンポーネント(core/security/external-secrets)。 |
manifest.yaml | コンポーネントタイプを公式のソース付き Recipe(external-secrets)にマッピングします。 |
release.yaml | Kubernetes ターゲット向けのオペレーターレコード:オペレーターのコンピュートサイジング。 |
示す内容
- 単一のオーサリング面。 1 つの Aggregate がオペレーターが何であるかの 信頼できる唯一の情報源となり、Manifest がそれをどのように実現するかを示します。
- 開発者の値がレンダリングまで流れる。 開発者の
install_crds値はチャートのinstallCRDs値に書き込まれ、リリースとともに external-secrets のカスタムリソース定義をクラスターに導入します。 - クラスターを拡張するコントローラーで、トポロジーエッジはなし。 external-secrets は
独自のカスタムリソースをクラスター API に追加します。利用側はそれらのリソースを宣言して
シークレットを要求するため、コンポーネントは
usesエッジを配線せず、 メトリクスの場所以外は何もエクスポートしません。 - 単一の一貫したオペレーター。 チャートはコントローラー、Webhook、 証明書コントローラーを 1 つのオペレーターとしてレンダリングします。同梱のプロバイダーサブチャートは 無効のため、外部のデータストア、キャッシュ、ブローカーは取り込まれません。レンダリング 出力は同じ入力に対する実行間でバイト単位で同一です。
- 再現可能なイメージ。 Recipe は 3 つのコンテナイメージすべてを解決可能なリリースタグ(
ghcr.io/external-secrets/external-secrets:v2.7.0)に固定するため、レンダリングされたワークロードは固定されたバージョンを参照します。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example external-secrets-operatorその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd external-secrets-operatorビルド
このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。
aggrega pull --release release.yamlaggrega build --release release.yamlレンダリングされた成果物は dist/ 以下に出力されます。ビルドは aggrega pull 時に
アップストリームのチャートを OCI 参照で解決し、ロックファイルに固定します。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `external-secrets-operator` フォルダーがない場合は、`example` を `external-secrets-operator` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、例が新しい `external-secrets-operator` フォルダーに書き込まれます。次に、`workspace_root` を `external-secrets-operator`、`release` を `release.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `external-secrets-operator/dist/` の下にあります。レンダリングされるもの
ビルドは external-secrets オペレーターを Kubernetes オブジェクトの集合として出力します:
- external-secrets API 用の 24 個の
CustomResourceDefinition(ExternalSecret、SecretStore、ClusterSecretStore、および関連するプッシュリソースとジェネレーター リソース)、 - 3 つの
Deployment(コントローラー、Webhook、証明書 コントローラー)、 - それらをバインドする RBAC:
ClusterRole、ClusterRoleBinding、1 つのRole、 1 つのRoleBinding、 - ワークロードごとに 1 つ、計 3 つの
ServiceAccount、 - Webhook 用の
Service、 - 2 つの
ValidatingWebhookConfiguration、 - 証明書コントローラーが実行時に Webhook の
サービング証明書で埋めるプレースホルダーの
Secret。
3 つのコンテナイメージはすべてリリースタグに固定されているため、ワークロードは固定されたイメージを参照します。