Compose プロジェクトをインポートする — PostgreSQL と Redis を使うノート API
API、そのノートを保存する PostgreSQL データベース、Redis キャッシュを実行する Compose ファイルを、aggrega import で Aggrega ファイルに下書きし — 接続、データベースの設定、変数参照としてのパスワード、各イメージのタグを引き継いで — Docker Compose 向けにビルドしたものです。
Compose プロジェクトをインポートする では、コマンド、書き出すファイルと各行がある理由、ビルド、そして実行中のスタックまでを順を追って説明します。このフォルダーには、そのウォークスルーの各段階が収められています:
| フォルダーまたはファイル | 内容 |
|---|---|
source/ | Compose プロジェクト compose.yaml、フォルダーをワークスペースにする .aggrega-config.yaml、そして Kubernetes 向けのビルドに必要でありながらどの Compose ファイルも持たない唯一の値を記した import-answers.yaml |
draft/ | aggrega import compose.yaml --target compose が書き出したファイル(変更なし、release.lock を含む)と、出力した内容:標準出力は stdout.txt、標準エラーは import.txt |
ドキュメントリポジトリのチェックアウトでは、check.sh がインポートを再実行し、書き出した内容と出力した内容を draft/ と比較し、ウォークスルーが引用するブロックをこれらのファイルと比較して、インポートが書き出したものを検証しビルドします。このリポジトリの隣に標準ライブラリのカタログ(入手先)がチェックアウトされているか、そのディレクトリが AGGREGA_CATALOG_DIRS に指定されている必要があります。
サンプルを生成する
この例のインポートは、以下のコマンドで実行することも、AI アシスタントに代わりに実行させることもできます。
例の名前を付けた新しいフォルダーに例を書き出します。
aggrega scaffold --example import-composeその後、次に実行するコマンドを表示します。最初のコマンドは新しいフォルダーに移動します。
cd import-composeビルド
インポートは、プロジェクトの隣の source/ に Aggrega ファイルを下書きします。プロジェクトは標準ライブラリのカタログと照らし合わせて評価されます。このカタログはワークスペースのデフォルトレジストリが署名付きスナップショットとして公開しており、最初のインポートがそれを取得して検証し、ワークスペースのコンテンツキャッシュに保持し、下書きの隣に書き出す記録の中でそのダイジェストによって指定します。独自のカタログフォルダーを指定するワークスペース — AGGREGA_CATALOG_DIRS で、または workspace.catalog_dirs の下で — は、代わりにそれらに対してインポートします。インポートは次に下書きされた Release が依存するものをプルするため、すぐにビルドを続けられます:
cd sourceaggrega import compose.yaml --target composeaggrega build --release release.yamlビルドは dist/compose/docker-compose.yaml を書き出します。その実行方法は、上記リンク先のウォークスルーにあります。
AI アシスタントを使う
Aggrega のツールでセットアップした AI アシスタントでも同じことができます。次のプロンプトを貼り付けてください。
Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `import-compose` フォルダーがない場合は、`example` を `import-compose` に設定し、`dir` を指定せずに `scaffold` ツールを 1 回呼び出してください。これにより、例が新しい `import-compose` フォルダーに書き込まれ、その `source` フォルダーにこの例がインポートするものが入ります。次に、`workspace_root` を `import-compose/source`、`source` を `compose.yaml`、`target` を `compose` に設定して `import` ツールを呼び出してください。このツールは、必要な回答を `compose.yaml` の隣にある `import-answers.yaml` から読み取り、ドラフトを `import-compose/source` に書き込み、ドラフトに必要なものをプルします。次に、`workspace_root` を `import-compose/source`、`release` を `release.yaml` に設定して `validate` ツールを呼び出し、`workspace_root` を `import-compose/source`、`release` を `release.yaml`、`write` を true に設定して `build` ツールを呼び出してください。ビルドが書き込んだファイルを教えてください。ファイルは `import-compose/source/dist/` の下にあります。テストする
ウォークスルーと同じ方法でスタックを実行し、ポート 8080 で HTTP に応答するイメージを API 用に指定した状態で、Release が公開するポートで API に問い合わせます:
curl -sS http://127.0.0.1:8080/notesウォークスルーの代替プログラムは、受け取ったリクエストの説明を返します:
{ "path": "/notes", "headers": { "host": "127.0.0.1:8080", [… omitted: the user agent and the media types the client sent] }, "method": "GET", [… omitted: the rest of the request as the stand-in received it, the client's address and the container's host name]}ウォークスルーに示すように、--target helm でインポートして Kubernetes に適用した場合も、ローカルポートをその Service にフォワードすれば、API は同じアドレスで同じリクエストに応答します。ただし、Secret はデータベースにしか届かないため、そこでは API はまだデータベースのパスワードを受け取りません:
kubectl port-forward -n <namespace> svc/api-default 8080:8080