Redis — 1 つの Aggregate、2 つのターゲット、オプションの認証
この簡潔な例では、Developer が作成した 1 つの Aggregate から、単一の Redis インメモリキャッシュ(Redis ワイヤプロトコル)を 2 つの実現形態にコンパイルします:
- ローカル開発向けの Docker Compose、そして
- 公式のアップストリーム
redisイメージを Kubernetes 上で直接実行する 合成された helm Recipe (外部チャートなし)。
合成された helm Recipe は Kubernetes 向けの経路です。サードパーティのチャートではなく 公式イメージのタグのみに依存し、レンダリングされるリソース セットは workload が宣言するものと完全に一致します。
同じ aggregate.yaml が両方を駆動します。実現形態ごとに変わるのは、
Manifest が選択する Recipe レイヤーだけです。2 つ目の Aggregate である aggregate-auth.yaml は、
Compose 経路向けにオプションのパスワード資格情報を付与した同じキャッシュを
示します。aggregate-helm-synth-auth.yaml は、合成された helm 経路向けに
参照可能な資格情報を付与します。
この例がマッピングするカタログの Redis の Recipes である compose/redis と helm/redis は、AGPL-3.0 ライセンスを宣言しています。valkey-cache の例は、同じワイヤプロトコルを話す Valkey をデプロイします。その helm/valkey Recipe は BSD-3-Clause を宣言しています。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:型 core/datastore/redis の cache コンポーネントが 1 つ、資格情報なし — キャッシュは認証なしで動作します。 |
aggregate-auth.yaml | コンポーネントのオプションの password スロットにパスワード資格情報を付与した同じキャッシュ(Compose 経路)。 |
aggregate-helm-synth-auth.yaml | 同じキャッシュに、合成された helm の経路向けに参照可能な資格情報を付与したもの — 値は Deployment が参照する Kubernetes Secret として具現化されます。 |
manifest-compose.yaml | Redis 型を Compose Recipe(compose/redis)に、資格情報を dotenv-secret にマッピングします。 |
manifest-helm-synth.yaml | Redis 型を合成された helm Recipe(helm/redis)に、資格情報を k8s-secret-from-parameter にマッピングします。 |
release-compose.yaml / release-helm-synth.yaml | 2 つの実現形態向けの Operator レコード、認証なし。 |
release-compose-auth.yaml / release-helm-synth-auth.yaml | 認証を有効にする Operator レコード。 |
示す内容
- 1 つの作成インターフェース、多数のターゲット。 1 つの Aggregate が、スタックが 何 であるかの信頼できる唯一の情報源です。各 Manifest は、それを どのように 実現するかを記述します。
- キャッシュ用途のデータストア。 ここでは Redis をインメモリキャッシュとして使用し、
何も永続的に保存しないため、コンポーネントは
stateful-serverではなく単純なserverとして型付けされます。Kubernetes では合成された Recipe が StatefulSet ではなく Deployment をレンダリングし、永続ボリュームを要求しません。 Compose ではサービスがデータボリュームを宣言しません。 - Workload の合成(Kubernetes)。 合成された helm Recipe は、公式の
redisイメージを実行する Deployment と ClusterIP Service からなる Workload を宣言し、helm プロバイダーがそれを外部チャートなしで Kubernetes マニフェストに 変換します。レンダリングされるリソースセットは Workload が宣言するものと完全に一致します。 Compose Recipe と合成された helm Recipe の両方がredisという名前を持つため、 Manifests はそれらをプロバイダースコープ付きでcompose/redisおよびhelm/redisとして参照します。 - 資格情報スロットによるオプションの認証。 コンポーネントは
featuresSchemaにオプションのpasswordスロットを 1 つ宣言します。資格情報が付与されていない場合(ベースの Aggregate)、Recipe は認証を無効にしたキャッシュをレンダリングします。これはスロットのない Recipe とバイト単位で同一です。資格情報が付与されると、両方のターゲットが--requirepass付きで Redis を起動するため、サーバーはパスワードを要求します。Compose(aggregate-auth.yaml)では値がその引数としてサーバーに渡され、合成された Kubernetes 経路(aggregate-helm-synth-auth.yaml)では Deployment が参照する Secret として具現化されます。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example redis-cacheその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd redis-cacheビルド
このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。
# Local development (Docker Compose), no authenticationaggrega build --release release-compose.yaml --auto-pull
# Kubernetes (synthesized helm Recipe, official image), no authenticationaggrega build --release release-helm-synth.yaml --auto-pull
# The same realizations with authentication enabledaggrega build --release release-compose-auth.yaml --auto-pullaggrega build --release release-helm-synth-auth.yaml --auto-pullレンダリングされた成果物は dist/ 配下に出力されます。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールのみを使用し、フォルダーは自分で作成しないでください。Workspace フォルダーにまだ `redis-cache` フォルダーがない場合は、`example` を `redis-cache` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、新しい `redis-cache` フォルダーに例が書き込まれます。次に、各 Release について 1 回ずつ、`release-compose.yaml`、`release-helm-synth.yaml`、`release-compose-auth.yaml`、`release-helm-synth-auth.yaml` の順に `build` ツールを呼び出してください。毎回、`workspace_root` を `redis-cache`、`release` をそのファイル、`auto_pull` を true、`write` を true に設定します。各ビルドが書き込んだファイルを教えてください。それらは `redis-cache/dist/` の下にあります。資格情報の受け渡しに関する注記
Compose 経路では、資格情報は inject-value シークレットです(aggregate-auth.yaml)。その値はコンポーネントの環境パイプで、values.key が指定する変数 REDIS_PASSWORD として受け渡され、Recipe はそれを --requirepass としてサーバーに渡します。公式の redis イメージはパスワード変数を読み取らないため、値は引数として渡され、サービスのコマンドに現れます。Recipe が読み取るどの変数でもない形で値が届くアタッチメントは、キャッシュを開いたままにするのではなく、スロットを示してビルドを停止させます。
合成された helm 経路では参照可能な資格情報を使用します
(aggregate-helm-synth-auth.yaml)。値は Kubernetes Secret として具現化され、
Deployment は env の secretKeyRef を通じてそれを参照し、Redis は
その環境変数を読み取る --requirepass 付きで起動されます。そのため平文の
パスワードが Deployment マニフェストに現れることはなく、Secret にのみ存在します。
これが、単独では環境からパスワードを読み取らない公式の redis
イメージで実際に認証を有効にする仕組みです。
認証付きの Aggregates にある origin の値は開発用のプレースホルダーです。
実際のデプロイでは、資格情報ソースを通じて実際の値を指定してください。