Keycloak スタック — モジュールとして構成された、データベースを持つ ID サーバー
この例では、小規模な実際のスタック(データベースを持つ ID
サーバー)を、Developer が作成した 1 つの
Aggregate から合成された Kubernetes マニフェストへとコンパイルします。
ID サーバーは単一のコンポーネントではありません。これはモジュール、つまり 2 つの単一ワークロードのコンポーネントを構成する再利用可能な サブアグリゲートです。
- サーバー。HTTP ポートでアカウントコンソールとトークンエンドポイントを提供し、 ローカル状態を持ちません。
- バックエンド(PostgreSQL)。サーバーのレルム、クライアント、ユーザーを保持し、 ボリュームに永続化します。
モジュールはサーバーからバックエンドへの自身の内部エッジを接続し、
サーバーを公開エンドポイント http としてエクスポートします。トップレベルの Aggregate は
モジュールを名前でインポートし、構成されたスタックをレンダリングします。オペレーターは
Release でモジュールの内部コンポーネントのサイズを指定します。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:ID サーバーモジュール(core/keycloak)をインポートします。 |
manifest-helm-synth.yaml | サーバーとバックエンドの型をそれぞれの synth helm Recipes にマッピングし、モジュールがアタッチする認証情報の Feature を、モジュールの認証情報パラメーターから Secret を出力する実現にマッピングします。 |
release-helm-synth.yaml | Kubernetes ターゲット向けのオペレーターのレコードです。モジュールの内部コンポーネントをモジュールスコープの ID でサイズ指定します。スキーマのデフォルトに任せた部分は自己完結した形でレンダリングされます。 |
示す内容
- モジュールとしての構成。 複数ワークロードの機能(実際にはサーバーと設定データベースから成る ID サーバー)を、1 つのモノリシックなコンポーネントとしてではなく、2 つの単一ワークロードのコンポーネントを構成する サブアグリゲートとしてパッケージ化します。モジュールは名前でインポートされ、ID サーバーが必要な場所で再利用されます。
- モジュール内部のエッジ。 サーバーはバックエンドの使用を宣言します。
バックエンドの Recipe の
providesであるホスト、ポート、ユーザー、データベースは サーバーに渡され、そのデータベース接続に組み立てられます。コンパイラは これらの文字列を解釈せずにルーティングします。 - 公開エンドポイント。 モジュールはサーバーを
httpとしてエクスポートします。これはコンシューマーが接続する安定した 公開名であり、モジュールの内部コンポーネント名からは切り離されています。 - オペレーターによる内部コンポーネントのサイズ指定。 Release はモジュールの
内部コンポーネントをモジュールスコープの ID(
server.backend、server.server)で指定してコンピュートを設定するため、開発者の Aggregate で 物理的なサイズを再記述する必要はありません。 - 自己マイグレーションするスキーマ。 サーバーは起動時にバックエンドに対して自身のスキーマを プロビジョニングしてマイグレーションするため、別途マイグレーション手順を設けずに準備済みのスキーマで起動します。
- 参照で受け取る共有認証情報。 サーバーは PostgreSQL バックエンドに対して認証するため、
両者は 1 つのパスワードを共有します。モジュールはこれをパラメーター
db_passwordとして受け取り、core/referenced-secret認証情報の Feature をそれとともに 2 回アタッチします。1 回はバックエンド自身の認証情報スロットに、 もう 1 回はサーバーからバックエンドへの接続(サーバーがそのパスワードを提示する接続)のcredentialとしてです。 各ワークロードはパスワードをインラインで保持せず、Secret から読み取ります。ブートストラップ管理者アカウントの パスワードは 2 つ目のパラメーターadmin_passwordです。 モジュールがその Feature をアタッチするため、Manifest がそれをマッピングします。この例では 両パラメーターをモジュールの開発用デフォルトのままにし、 Feature をk8s-secret-from-parameterにマッピングします。これは各値を持つ Secret を出力するため、 スタックは自己完結して動作します。実際のトラフィックを扱う Release では、 Aggregate が自身のパラメーターを宣言してaggregates.server.parametersを通じて渡し、Release がそれらを満たし、 Manifest が Feature をk8s-existing-secretにマッピングします。これは各 パラメーターを、名前空間にすでに存在する Secret の名前として読み取ります。 - 再現可能なイメージ。 サーバーとバックエンドの両方が明示的なイメージ タグを固定するため、レンダリングされたマニフェストは安定したイメージを参照します。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example keycloak-stackその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd keycloak-stackビルド
このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。
aggrega build --release release-helm-synth.yaml --auto-pullレンダリングされた成果物は dist/ 以下に出力されます。Kubernetes ターゲットはオフラインで
プレーンなマニフェストをレンダリングするため、チャートのプルは不要です。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `keycloak-stack` フォルダーがない場合は、`example` を `keycloak-stack` に設定し、`dir` を指定せずに `scaffold` ツールを一度呼び出してください。これにより、例が新しい `keycloak-stack` フォルダーに書き込まれます。次に、`workspace_root` を `keycloak-stack`、`release` を `release-helm-synth.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `keycloak-stack/dist/` の下にあります。構成されたスタックの姿
サーバーは、ステートレスな Deployment と、HTTP ポート上の ClusterIP Service としてレンダリングされます。 そのコンテナは、バックエンドのエッジから組み立てられた接続(バックエンドのクラスター内 Service 名、ユーザー、データベース)に加え、 自己完結した HTTP 設定、有効化されて管理ポートで提供されるヘルスエンドポイント、 ブートストラップ管理者アカウントを持ち、両方のパスワードは Secret から読み取られます:
env: - name: KC_DB_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-db.credential key: db-password - name: KC_BOOTSTRAP_ADMIN_PASSWORD valueFrom: secretKeyRef: name: server-zdserver-admin-password key: admin-password - name: KC_DB value: postgres - name: KC_DB_URL_HOST value: server-zdbackend-default - name: KC_DB_URL_PORT value: "5432" - name: KC_DB_URL_DATABASE value: keycloak - name: KC_DB_USERNAME value: keycloak - name: KC_HTTP_ENABLED value: "true" - name: KC_HOSTNAME_STRICT value: "false" - name: KC_HEALTH_ENABLED value: "true" - name: KC_HTTP_MANAGEMENT_PORT value: "9000" - name: KC_BOOTSTRAP_ADMIN_USERNAME value: adminコンテナは HTTP ポートの横に管理ポート 9000 を宣言し、
Deployment はそこでサーバーをプローブします。/health/started のスタートアッププローブは
サーバーの起動中に他のプローブを保留し、/health/ready のレディネスプローブは
応答するまでトラフィックを遠ざけ、/health/live のライブネスプローブは
停止した場合に再起動します。Service は引き続き HTTP ポートのみを転送します。
バックエンドは、/var/lib/postgresql/data にマウントされた永続ボリュームを持つ StatefulSet と、
ClusterIP Service およびヘッドレス Service としてレンダリングされます。その
POSTGRES_PASSWORD は、同じデータベースパスワードを自身の Secret
server-zdbackend-password から読み取ります。3 つの Secret はワークロードの横に出力され、
モジュールがアタッチする認証情報ごとに 1 つずつ、それぞれモジュールの開発用
デフォルトを保持します。