コンテンツにスキップ
AggregaAggrega
言語の選択: 日本語
このページは機械翻訳されています。英語の原文を読む。

PostgreSQL のブートストラップスクリプトとカスタム設定 — synthesized helm

core/datastore/postgres は、データベースの初回起動を形作る 2 つの任意の開発者値を公開しています。init_scripts(初期化時に一度だけ実行される SQL またはシェル)と custom_config(postgresql.conf の断片)です。synthesized helm ターゲットでは、Recipe がこれらをマウントされた ConfigMap としてコンテナに渡します。この例は、この機能が追加的であることを示します。どちらの値も設定しない Aggregate は最小構成のデータベースとまったく同じようにレンダリングされ、値を設定した Aggregate には ConfigMap、ボリューム、マウントが加わり、それ以外は何も変わりません。

同じ Component、同じ Manifest の 2 つの Releases で、違いは開発者値のみです。

  • release-bare.yaml(aggregate-bare.yaml)— init_scripts と custom_config は未設定です。
  • release-config.yaml(aggregate-config.yaml)— 両方とも設定済みです。

サンプルを生成する

このサンプルは以下のコマンドでビルドできます。または、AI アシスタントにビルドを任せることもできます。

例の名前を付けた新しいフォルダーに例を書き出します。

Terminal window
aggrega scaffold --example postgres-init-config

その後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。

Terminal window
cd postgres-init-config

ビルド

Terminal window
aggrega build --release release-bare.yaml --auto-pull
aggrega build --release release-config.yaml --auto-pull

カタログは .aggrega-config.yaml で指定された hub レジストリから解決されるため、--catalog フラグは不要です。また --auto-pull が、新しいクローンに欠けているロックファイルをビルド中に書き出します。bare の release は dist/helm/helm/ 配下に 3 つのファイルを書き出し、設定済みの release はその 3 つに加えて dist/helm/helm/db/ 配下にさらに 2 つを書き出します。

AI アシスタントを使う

Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。

Aggrega のツールのみを使用し、フォルダーは自分で作成しないでください。Workspace フォルダーにまだ `postgres-init-config` フォルダーがない場合は、`example` を `postgres-init-config` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、新しい `postgres-init-config` フォルダーに例が書き込まれます。次に、各 Release について 1 回ずつ、`release-bare.yaml`、`release-config.yaml` の順に `build` ツールを呼び出してください。毎回、`workspace_root` を `postgres-init-config`、`release` をそのファイル、`auto_pull` を true、`write` を true に設定します。各ビルドが書き込んだファイルを教えてください。それらは `postgres-init-config/dist/` の下にあります。

Bare — 追加的なベースライン

aggregate-bare.yaml は両方の値を未設定のままにします。レンダリング結果は StatefulSet、ClusterIP Service、Headless Service であり、ConfigMap も、 configmap ボリュームも、init ディレクトリへのボリュームマウントも、コンテナの 設定ファイル引数もありません。これは最小構成の PostgreSQL データベースの通常の形です。

dist/helm/helm/db-statefulset.yaml
dist/helm/helm/db-default-service.yaml
dist/helm/helm/db-headless-service.yaml

Recipe では両方の値が存在ガードされているため、未設定の値は何も出力しません。ConfigMap の本体は空でレンダリングされてスキップされ、ボリューム、マウント、サーバー引数の行はガードによって除外されます。これらの値に一切触れない Aggregate は、その値が存在しても変化しません。

設定済み — スクリプトと設定のマウント

aggregate-config.yaml は両方の値を設定します。

values:
init_scripts:
01-schema.sql: |
CREATE TABLE app_users ( ... );
02-seed.sql: |
INSERT INTO app_users (email) VALUES ('founder@example.com');
custom_config: |
max_connections = 200
shared_buffers = 256MB

ビルドは 2 つの ConfigMap を追加で書き出し、それらを StatefulSet に接続します。

dist/helm/helm/db/initdb-configmap.yaml
dist/helm/helm/db/config-configmap.yaml

どちらも、component 自身の名前である db/ 配下に置かれます。Recipe はこれらを artifacts: ブロックで命名しており、そこで命名されたファイルは component を識別する情報ではなく 作成者が書いたキーを持ちます。そのため、ビルドはそれを宣言した component の配下に書き出し、1 つの Recipe を共有する 2 つの component が 同じパスに配置されることはありません。StatefulSet と 2 つの Service は、ターゲットが 所属する component から命名するため、境界自身のディレクトリに留まります。

2 つの値は、それぞれが丸ごと異なるコンテナパスにマウントされるため、 別々の ConfigMap に格納されます。

  • init_scripts → ConfigMap db-initdb、スクリプトごとに 1 つのデータキー(01-schema.sql、 02-seed.sql)。configmap ボリュームがこれを /docker-entrypoint-initdb.d にマウントし、 PostgreSQL は初回初期化時にそこのファイルをキーのアルファベット順に 一度だけ実行します。
  • custom_config → ConfigMap db-config、データキーは postgresql.conf の 1 つ。 2 つ目の configmap ボリュームがこれを /etc/postgresql にマウントし、コンテナの args: がサーバーにそれを指し示します: postgres -c config_file=/etc/postgresql/postgresql.conf。断片が省略した設定は 組み込みのデフォルト値を保ちます。
# db-statefulset.yaml (container)
containers:
- name: main
image: postgres:16
args:
- postgres
- -c
- config_file=/etc/postgresql/postgresql.conf
[… omitted: the container's port, environment and resources]
volumeMounts:
- name: data
mountPath: /var/lib/postgresql/data
- name: initdb
mountPath: /docker-entrypoint-initdb.d
- name: pgconf
mountPath: /etc/postgresql
[… omitted: the liveness and readiness probes]
volumes:
- name: initdb
configMap:
name: db-initdb
- name: pgconf
configMap:
name: db-config

これらのサーバー引数は command: ではなく args: として渡され、この違いによってデータベースが内容を持った状態で起動するかどうかが決まります。args: はイメージのエントリポイントに引数を渡すのに対し、command: はエントリポイントを置き換えます。そのエントリポイントは、空のデータディレクトリにデータベースを作成し、POSTGRES_* 環境変数を読み取り、/docker-entrypoint-initdb.d 配下のファイルを実行する起動スクリプトです。これを置き換えると、サーバーはマウントされた postgresql.conf で起動し、初期化とブートストラップスクリプトの両方がスキップされます。Aggregate が設定した値はマニフェストにレンダリングされても実行されることはありません。

2 つの値のうち 1 つだけを設定することも同様に有効です。もう一方の ConfigMap、 ボリューム、マウントは単に存在せず、設定ファイル引数は custom_config が設定されている場合にのみ現れます。

Compose

core/datastore/postgres 向けの Compose Recipe は同じ Component を読み取り、 compose 独自のプリミティブで両方の値を実現します。トップレベルの configs: エントリをレンダリングし、サービスがそれぞれをファイルとしてマウントします。

  • init_scripts → キーごとに 1 つの config で、それぞれが /docker-entrypoint-initdb.d 配下に固有のファイル名でマウントされます。イメージはそこにあるファイルを ファイル名順に一度だけ実行し、それはデータディレクトリが空の場合に限られます。すでにデータを持つデータベースには 手が加えられません。
  • custom_config → 1 つの config で、単一ファイル /etc/postgresql/postgresql.conf としてマウントされ、同じ postgres -c config_file=… 引数がサーバーにそれを指し示します。断片が省略した設定は 組み込みのデフォルト値を保ちます。

ここでもそれぞれが存在ガードされているため、一方の値を未設定のままにした Aggregate はそのキーが存在しないかのようにレンダリングされます。

compose デプロイメント向けに custom_config ブロックを書く際に触れておくべき設定が 1 つあります。 listen_addresses はデフォルトでローカル接続のみを受け付けるため、これを省略した ブロックでは、compose ネットワーク上の他のサービスからデータベースに到達できなくなります。

この例の Manifest は core/datastore/postgres を helm の Recipe にルーティングします。 同じ Aggregate を compose でビルドするには、代わりにそれを compose/postgres にルーティングする Manifest を用います。開発者値は変わりません。