モジュール境界ルーティング — サブモジュール全体を境界に配置する
この例では、オブジェクトストレージ上の Thanos メトリクス読み取り層 と、MongoDB ワイヤプロトコルを話す ドキュメントデータベース という 2 つの機能を、
Developer が記述した 1 つの Aggregate からコンパイルし、Release からそれぞれを
独自の境界に配置します。
どちらの機能も モジュール です。モジュールとは、それぞれが複数の単一ワークロードのコンポーネントを
組み合わせ、独自の内部エッジを接続する再利用可能なサブアグリゲートです。
Aggregate は 2 つのモジュールを指定するだけで、それらがどこで実行されるかについては何も記述しません。Release は
境界ごとに 1 つの aggregates: エントリで各モジュール全体を配置します。オペレーターは、機能の内部に何があるかを
追跡したり再記述したりすることなく、その機能をどこで実行するかを決定します。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:メトリクスモジュール(core/thanos)とドキュメントデータベースモジュール(core/ferretdb)をインポートします。 |
manifest.yaml | 2 つのモジュールが提供するすべてのコンポーネントタイプをその synth helm Recipe に、メトリクスモジュールがアタッチする認証情報 Feature をモジュールの 2 つのキーパラメーターのそれぞれから Secret を出力する実現に、そして scrape Feature をその FeatureRecipe にマッピングします。 |
release.yaml | オペレーターの記録:各モジュールをそれぞれ独自の境界にルーティングし、1 つのモジュールの 1 つのコンポーネントのサイズを設定し、そこに scrape Feature をアタッチします。 |
示す内容
- モジュール全体を境界にルーティングする。 境界の
aggregates:エントリは、 Aggregate 内のモジュール名をキーとします。このエントリはモジュールに含まれるすべてのコンポーネントを 配置するため、3 つのメトリクスコンポーネントすべての出力成果物はobservability境界の下に、 2 つのドキュメントデータベースコンポーネントはどちらもdataの下に出力されます。 - コンポーネントを一切指定しないことが基本の形です。
data境界は ドキュメントデータベースモジュールを素のdocuments: {}でルーティングします。 その中のすべてのコンポーネントが配置され、それぞれ独自のスキーマのデフォルトを使用します。Release に必要なのは モジュールの名前だけで、それ以外は何も必要ありません。 - ルーティングされたコンポーネントをローカル名で設定する。 ルーティングエントリは、
ルーティングするモジュールの個々のコンポーネントを設定することもできます。その際は、各コンポーネントがそのモジュール内で持つ
ローカル 名で指定します。
metrics.queryではなくqueryです。 モジュール内ではそれが唯一の名前だからです。1 つのコンポーネントを指定しても、 他のコンポーネントについては何も指定しません。ここではqueryのサイズが設定され、スクレイプターゲットが与えられる一方、 オブジェクトストアとストアゲートウェイはデフォルトのままルーティングされます。 - ルーティングされたコンポーネントはその境界のコンポーネントです。 他のコンポーネントと同様に、
境界のアノテーションカスケードを継承します。これにより、ルーティングされたモジュールのすべての
リソースが境界の
aggrega.ai/namespace値を持ちます。 ルーティングエントリで一度も言及されていないコンポーネントも含みます。 - ルーティングは配置であり、異なる種類のメンバーシップではありません。 何も指定されずに ルーティングされたコンポーネントは、同じコンポーネントをその境界内で空の本体で直接指定した場合と 同じようにレンダリングされます。2 つの書き方は、コンポーネントの所属先を示す 2 つの方法であり、 2 つの異なる動作ではありません。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example module-boundary-routingその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd module-boundary-routingビルド
このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。
aggrega build --release release.yaml --auto-pullレンダリングされた成果物は dist/ 以下に出力されます。Kubernetes ターゲットはオフラインで
プレーンなマニフェストをレンダリングするため、チャートのプルは不要です。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `module-boundary-routing` フォルダーがない場合は、`example` を `module-boundary-routing` に設定し、`dir` を指定せずに `scaffold` ツールを一度呼び出してください。これにより、例が新しい `module-boundary-routing` フォルダーに書き込まれます。次に、`workspace_root` を `module-boundary-routing`、`release` を `release.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `module-boundary-routing/dist/` の下にあります。配置されたスタックの構成
各境界の directory は、その境界に配置されたすべてのものの成果物ルートです。そのため、
2 つのモジュールのコンポーネントは、それらをルーティングした境界ごとにディスク上で分離されます:
dist/observability/helm/ metrics-zdobjstore, metrics-zdstore, metrics-zdquerydist/data/helm/ documents-zdproxy, documents-zdbackendファイル名には、モジュール区切り文字を書き下した形で各コンポーネントの識別子が含まれます。
ドットはすべてのリソース名に使用できる文字ではないためです。Aggregate 内の metrics.store
はクラスター内では metrics-zdstore になります。識別子に区切り文字が入るのはモジュールを組み合わせた場合だけなので、
直接指定したコンポーネントはどちらの場所でも同じ綴りになります。
すべてのリソースはルーティング元の境界の名前空間を持ち、どの境界がそのリソースを配置したかを 記録します。ストアゲートウェイはルーティングエントリで一度も指定されていませんが、 それでも両方を継承します:
metadata: name: metrics-zdstore namespace: observability [… omitted: the labels every rendered document carries] annotations: aggrega.ai/boundary-path: observability [… omitted: the annotation naming the Recipe that rendered it]メトリクスモジュールの認証情報 Feature が、オブジェクトストアのキーペアと、ストアゲートウェイがそれに提示するキーペアに対して出力する 4 つの Secret についても同様です。それぞれ observability の下に、その名前空間で、それを読み取るワークロードと並んで出力されます。
ルーティングされた query コンポーネントにアタッチされた scrape Feature は、同じ境界の下に
独自の成果物をレンダリングし、オペレーターのスクレイプ設定を保持します:
apiVersion: monitoring.coreos.com/v1kind: ServiceMonitormetadata: name: metrics-zdquery-scrape [… omitted: the namespace, labels and annotations every rendered document carries]spec: selector: matchLabels: app.kubernetes.io/name: metrics-zdquery endpoints: - port: http interval: 30s path: /metrics