NATS — 1 つの Aggregate、2 つのターゲット、オプションの認証
この例では、単一の NATS メッセージングサーバー(pub-sub、request-reply、キューイング)を、Developer が作成した 1 つの Aggregate から 2 つの実現形態へコンパイルします:
- ローカル開発向けの Docker Compose、そして
- 公式アップストリームの
natsイメージを Kubernetes 上で直接実行する 合成 helm Recipe(外部チャートなし)。
合成された helm Recipe は、推奨される Kubernetes の経路です。サードパーティのチャートではなく 公式イメージのタグのみに依存し、レンダリングされるリソースセットは workload が宣言する内容とまったく同じです。
同じ aggregate.yaml が両方を駆動します。実現形態ごとに変わるのは、
Manifest が選択する Recipe レイヤーだけです。2 つ目の Aggregate である aggregate-auth.yaml は、
Compose 経路向けに inject-value のパスワード資格情報を付与した同じサーバーを
示します。aggregate-helm-synth-auth.yaml は、合成 helm 経路向けに参照可能な
資格情報を付与します。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:型 core/messaging/nats の bus コンポーネントが 1 つ、資格情報なし。サーバーは認証なしで動作します。 |
aggregate-auth.yaml | コンポーネントのオプションの password スロットに inject-value のパスワード資格情報を付与した同じサーバー(Compose 経路)。 |
aggregate-helm-synth-auth.yaml | 合成 helm 経路向けに参照可能な資格情報を付与した同じサーバー。値は Deployment が参照する Kubernetes Secret として具現化されます。 |
manifest-compose.yaml | NATS の型を Compose Recipe(compose/nats)に、資格情報を dotenv-secret にマッピングします。 |
manifest-helm-synth.yaml | NATS の型を合成 helm Recipe(helm/nats)に、資格情報を 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 は、それを どのように 実現するかを記述します。
- ステートレスなメッセージングサーバー。 この簡素な構成では、NATS は JetStream のファイルストレージを無効にした状態で
サブジェクトをメモリ内でルーティングするため、コンポーネントは
serverとして型付けされます。Kubernetes では、合成 Recipe が永続ボリュームのない 単一レプリカの Deployment をレンダリングします。Compose サービスは ローカル開発向けにサーバーを公開します。 - Workload の合成(Kubernetes)。 合成 helm Recipe は、公式の
natsイメージを実行する Deployment と ClusterIP Service からなる Workload を宣言し、 helm provider がそれを外部チャートなしで Kubernetes マニフェストに変換します。 レンダリングされるリソースセットは Workload が宣言するものと完全に一致します。 Compose Recipe と合成 helm Recipe の両方がnatsという名前を持つため、 Manifests はそれらを provider スコープ付きでcompose/natsおよびhelm/natsとして参照します。 - オプションの認証、どちらの場合も決定的。 NATS の認証は デフォルトで無効です。資格情報が付与されていない場合、どちらの実現形態も 認証を有効にせず、レンダリング結果は実行間でバイト単位で同一です。資格情報が 付与されている場合、注入された値によって両方の実現形態でユーザー/パスワード認証が 有効になります。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example nats-messagingその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd nats-messagingビルド
このワークスペースには .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 のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `nats-messaging` フォルダーがない場合は、`example` を `nats-messaging` に設定し、`dir` を指定せずに `scaffold` ツールを一度呼び出してください。これにより、例が新しい `nats-messaging` フォルダーに書き込まれます。次に、`release-compose.yaml`、`release-helm-synth.yaml`、`release-compose-auth.yaml`、`release-helm-synth-auth.yaml` の順に、各 Release について `build` ツールを一度ずつ呼び出してください。毎回、`workspace_root` を `nats-messaging`、`release` をそのファイル、`auto_pull` を true、`write` を true に設定します。各ビルドが書き込んだファイルを教えてください。ファイルは `nats-messaging/dist/` の下にあります。資格情報の受け渡しに関する注記
Compose 経路では、資格情報は inject-value シークレット
(aggregate-auth.yaml)です。その値はコンポーネントの環境
パイプで渡され、サーバーはユーザー/パスワード認証フラグ付きで起動されます。
合成 helm 経路では参照可能な資格情報
(aggregate-helm-synth-auth.yaml)を使用します。値は Kubernetes
Secret として具現化され、Deployment は env の secretKeyRef を通じてそれを参照し、
サーバーはその環境変数を読み取る --user/--pass フラグ付きで起動されます。
そのため、平文のパスワードは Deployment
マニフェストには現れず、Secret にのみ存在します。
認証付きの Aggregates にある origin の値は開発用のプレースホルダーです。
実際のデプロイでは、資格情報ソースを通じて実際の値を指定してください。