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

ビルドのファイル

このページでは 1 つの考え方、つまりビルドのどのファイルが何を述べるかを説明します。実行可能なワークスペースではありません。PostgreSQL を使う Web アプリを 1 ステップずつ構築するでは、ビルドするワークスペースでこれを示しています。次のコマンドで自分のフォルダーに書き出せます:

Terminal window
aggrega scaffold --example quickstart-web

その後、次に実行するコマンドを表示します。

Terminal window
cd quickstart-web
cd 1
aggrega build --release release.yaml --auto-pull
export QUICKSTART_DB_PASSWORD=choose-a-password
docker compose -p quickstart-web -f dist/compose/docker-compose.yaml up -d --wait
# then open http://127.0.0.1:8080/ in your browser

5 種類のファイル、それぞれに 1 人の作成者

ビルドは 5 種類のファイルを読み込みます。それぞれが 1 つのことを述べ、典型的なチームではそれぞれに専任の作成者がいます:

  • Component は、ある種類のコンポーネントが何であるかを述べます。開発者が設定できる値、オペレーターが設定できるインフラストラクチャ設定、接続してくるコンポーネントに公開するもの、そして接続に使うソケットです。標準ライブラリのカタログには、core/datastore/postgres や core/compute/server など、ほとんどのアプリケーションが必要とする Components が含まれているため、ワークスペースでは通常 1 つも書きません;
  • Aggregate は開発者のものです。アプリケーションがどのコンポーネントを持ち、それぞれが何に接続するかを示します;
  • Recipe は、ある種類のコンポーネントを 1 つのツール向けのファイルに変換します — Compose サービス、Helm チャート、Terraform モジュールなどです;
  • Manifest は、1 つのターゲットについて、各種類のコンポーネントをどの Recipe で実現するかを選びます;
  • Release は Aggregate と Manifest を指定し、1 つの環境の設定を与えます。これがビルドする対象です:aggrega build --release release.yaml。

この分担はガイダンスです。1 人で 5 つすべてを書いてもよく、ビルドはそれぞれが有効である限りどれでも受け付けます。

Aggregate:コンポーネントとその接続

この例の最初のステップは、Web アプリケーションとそのデータベースです。その Aggregate を、コメントを省いて 1/aggregate.yaml から示します:

spec:
components:
web:
type: core/compute/server
features:
db_password:
type: core/secret-value
values:
key: PGPASSWORD
origin: "${QUICKSTART_DB_PASSWORD}"
uses:
database:
db:
target: db
inject:
env:
- in: PGHOST
from: host
- in: PGPORT
from: port
- in: PGUSER
from: user
- in: PGDATABASE
from: database
db:
type: core/datastore/postgres
features:
password:
type: core/secret-value
values:
key: POSTGRES_PASSWORD
origin: "${QUICKSTART_DB_PASSWORD}"

ここではポート、ホスト、名前空間、ツールのいずれも指定していません。web は自身の database ソケットを通じて db に接続し、inject リストは、データベースが公開する各エントリをアプリケーションのどの変数が受け取るかを示します。from: はエントリを、in: は変数を指定します。

接続はパイプで渡される文字列

データベースの Recipe は、接続が読み取る host、port、user、database を公開します。host がどのアドレスを保持するかは、Manifest が選んだ Recipe によって決まります。データベースがアプリケーションと並んで動作する場合はサービス名、マネージドデータベースの場合はプロビジョニングツールが解決するポインター文字列、あるいは既に存在するサーバーのアドレスです。ビルドは公開された各文字列を Aggregate が指定した変数にコピーし、その内容を解釈しません。アドレスを解決することも、到達可能かを確認することもありません。

Manifest と Release

1/manifest.yaml の Manifest は、各種類のコンポーネントとパスワードのアタッチメントを、Docker Compose 上でそれを実現する Recipe に結び付けます:

spec:
mappings:
components:
type:
core/compute/server:1.1.0: compose/server:2.0.0
core/datastore/postgres:1.0.0: compose/postgres:1.0.0
features:
type:
core/secret-value:1.0.0: compose/dotenv-secret:1.0.0

1/release.yaml の Release は、Aggregate と Manifest を指定し、環境だけが知っているもの、ここではアプリケーションが実行するイメージ、待ち受けるポート、そして Docker Compose がマシンのループバックアドレス上でそれを公開するポートを与えます(イメージのダイジェストは短縮しています):

spec:
aggregate: quickstart-web
manifest: quickstart-web-compose
components:
web:
infra:
image: hub.aggrega.ai/tools/quickstart-web:1.1.0@sha256:…
port: 8080
published_port: 8080
db: {}

例の後半のステップでこれを拡張します。データベースの横に Redis キャッシュを置き、次に同じコンポーネントを Terraform で AWS 上に構築し、さらにデータベースのバックアップを追加します。

パラメーター:1 つの Aggregate、複数の環境

環境ごとに異なる値は、Aggregate で型付きパラメーターとして宣言し、使用する箇所で参照し、各 Release で与えます。オンデマンドで実行するタスクでは、Aggregate がレポートのスケジュールを宣言しています:

spec:
parameters:
report_schedule:
type: string
default: ""
components:
report:
type: core/compute/task
values:
schedule: "{{ .parameters.report_schedule }}"

そして Release がそれを満たします:

spec:
parameters:
report_schedule: "30 2 * * 1-5"

ビルドは、テンプレートを埋める前に、Release が与える各値をパラメーターの型と照合します。Release がコンポーネントの values を自ら書くことはありません。Aggregate が公開するパラメーターを満たすだけなので、どの値が環境によって変わるかを示す場所は Aggregate だけのままです。Release はパラメーターを専用のファイルから読み込むこともできます:parameters: { $import: ./env/prod-values.yaml }。