FerretDB スタック — モジュールとして構成されたドキュメントデータベース
この例では、小規模で実用的なスタック — MongoDB ワイヤープロトコルを公開するドキュメントデータベース — を、
Developer が作成した 1 つの Aggregate から合成された Kubernetes マニフェストへコンパイルします。
このドキュメントデータベースは単一のコンポーネントではありません。モジュール、つまり再利用可能な サブアグリゲートであり、単一ワークロードのコンポーネント 2 つを構成します —
- MongoDB ワイヤープロトコルを話し、ローカルな状態を持たないプロキシ、および
- DocumentDB 拡張を備えた PostgreSQL 17 で、データをボリュームに永続化する バックエンド。
モジュールはプロキシからバックエンドへの内部エッジを自ら配線し、プロキシを
公開エンドポイント mongo としてエクスポートします。トップレベルの Aggregate はモジュールを
名前でインポートし、構成されたスタックをレンダリングします。オペレーターは Release でモジュールの
内部コンポーネントのサイズを指定します。
ファイル
| ファイル | 役割 |
|---|---|
aggregate.yaml | Developer の意図:ドキュメントデータベースモジュール(core/ferretdb)をインポートします。 |
manifest-helm-synth.yaml | プロキシとバックエンドの型を、それぞれの synth helm Recipes にマッピングします。 |
release-helm-synth.yaml | Kubernetes ターゲット向けのオペレーターのレコードです。モジュールの内部コンポーネントをモジュールスコープの ID でサイズ指定します。スキーマのデフォルトに任せた部分は自己完結した形でレンダリングされます。 |
示す内容
- モジュールとしての構成。 複数ワークロードからなる機能 — 実体はプロキシとストレージバックエンドである ドキュメントデータベース — を、1 つのモノリシックなコンポーネントではなく、単一ワークロードの コンポーネント 2 つを構成するサブアグリゲートとしてパッケージ化します。モジュールは名前でインポートされ、 ドキュメントデータベースが必要な場所ならどこでも再利用されます。
- モジュール内部のエッジ。 プロキシはバックエンドの利用を宣言します。
バックエンド Recipe の
providesのホスト、ポート、ユーザー、データベースがプロキシに渡され、 その PostgreSQL 接続へと構成されます。コンパイラはこれらの文字列を解釈せずにルーティングします。 - 公開エンドポイント。 モジュールはプロキシを
mongoとしてエクスポートします。これは ドキュメントデータベースの利用側が配線する安定した公開名であり、モジュールの 内部コンポーネント名からは切り離されています。 - オペレーターによる内部コンポーネントのサイズ指定。 Release はモジュールの内部コンポーネントをモジュールスコープの ID(
database.backend、database.proxy)で指定してコンピュートを設定するため、Developer の Aggregate で物理的なサイズを改めて記述する必要はありません。 - 共有の認証情報。 プロキシは認証を PostgreSQL バックエンドに委ねるため、 両者は 1 つのパスワードを共有します。この例では共有のインライン開発用デフォルトを使用するため、 外部シークレットなしでスタックが自己完結して動作します。
- パスワードを含まない接続文字列。 プロキシの PostgreSQL 接続 URL は
パスワードを埋め込まずにレンダリングされます。パスワードは標準の libpq の
PGPASSWORD環境変数で 別途渡され、ドライバーがそれを接続にマージします。これにより、レンダリングされたマニフェストの 接続文字列に認証情報が含まれません。 - 再現可能なイメージ。 プロキシとバックエンドはどちらも明示的なイメージタグを固定しているため、 レンダリングされたマニフェストは安定したイメージを参照します。
サンプルを生成する
このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example ferretdb-stackその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd ferretdb-stackビルド
このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。
aggrega build --release release-helm-synth.yaml --auto-pullレンダリングされた成果物は dist/ 以下に出力されます。Kubernetes ターゲットはオフラインで
プレーンなマニフェストをレンダリングするため、チャートのプルは不要です。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `ferretdb-stack` フォルダーがない場合は、`example` を `ferretdb-stack` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、例が新しい `ferretdb-stack` フォルダーに書き込まれます。次に、`workspace_root` を `ferretdb-stack`、`release` を `release-helm-synth.yaml`、`auto_pull` を true、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `ferretdb-stack/dist/` の下にあります。構成されたスタックの姿
プロキシは、ステートレスな Deployment と、ワイヤーポート上の ClusterIP Service として レンダリングされます。コンテナの環境変数には、バックエンドのエッジから構成された接続 — バックエンドの クラスター内 Service 名、ユーザー、データベースで、URL にパスワードは含まれません — が入り、 FerretDB のデバッグリスナーは Pod のループバックアドレス上に置かれ、他の Pod からは到達できません:
env: - name: FERRETDB_LISTEN_ADDR value: :27017 - name: FERRETDB_DEBUG_ADDR value: 127.0.0.1:8088 - name: FERRETDB_POSTGRESQL_URL value: postgres://postgres@database-zdbackend-default:5432/postgres - name: PGPASSWORD value: apppassどちらのプローブもそのリスナーを必要としません。readiness プローブはコンテナ内で ferretdb ping を
実行し、ワイヤーポートに ping を送るため、バックエンドへの接続も確認できます。liveness プローブは
ワイヤーポートが接続を受け付けるかどうかだけを確認するため、バックエンドが停止するとプロキシは
再起動されずに Service から外されます:
livenessProbe: tcpSocket: port: 27017readinessProbe: exec: command: - /ferretdb - pingバックエンドは、/var/lib/postgresql/data にマウントされた永続ボリュームを持つ StatefulSet と、
ClusterIP Service および headless Service としてレンダリングされます。