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

MySQL — 1 つの Aggregate、2 つのターゲット

この簡潔な例では、Developer が作成した Aggregate から単一の MySQL データベースを 2 つのターゲットへコンパイルします:

  • helm プロバイダーの Workload 合成による Kubernetes(公式 mysql イメージ上に直接 レンダリングされる StatefulSet で、外部チャートは使いません)、および
  • ローカル開発向けの Docker Compose。

同じ開発者の意図が各ターゲットを駆動します。ターゲットごとに変わるのは、 Manifest が選択する Recipe レイヤーだけです。

ファイル

ファイル役割
aggregate-helm-synth.yamlKubernetes base バリアント向けの開発者の意図:型 core/datastore/mysql の db コンポーネント 1 つ、その値、および必須の root_password 資格情報のみ。
aggregate-helm-synth-auth.yamlKubernetes full バリアント向けの開発者の意図:root_password と user_password の両方の資格情報スロット。
manifest-helm-synth.yamlMySQL 型を合成された helm Recipe(helm/mysql)に、各資格情報をその FeatureRecipe(env-secret、k8s-secret-from-parameter)にマッピングします。
release-helm-synth.yamlKubernetes base バリアント向けのオペレーターの記録で、運用上のサイジング(engine_version、storage)を含みます。
release-helm-synth-auth.yamlKubernetes full バリアント向けのオペレーターの記録。
aggregate.yamlローカル Compose ターゲット向けの開発者の意図:同じ db コンポーネントで、両方の資格情報スロットを inject-value 資格情報として渡します。
manifest-compose.yamlMySQL 型を Compose Recipe(mysql)に、資格情報を dotenv-secret にマッピングします。
release-compose.yamlローカル Compose ターゲット向けのオペレーターの記録で、正確なコンテナイメージを固定するプロバイダー固有の infra.overrides エントリを含みます。

示す内容

  • 1 つの作成面、多数のターゲット。 Aggregate は、スタックが何であるかの 信頼できる情報源です。各 Manifest は、それをどのように実現するかを記述します。
  • Kubernetes での Workload 合成(推奨)。 helm/mysql Recipe は form: stateful を持つ capability に依存しない Workload を宣言し、helm プロバイダーは StatefulSet、ClusterIP Service、Headless Service (StatefulSet の安定したネットワーク ID)、およびデータディレクトリ用の volumeClaimTemplate を合成します。コンテナの環境には MYSQL_DATABASE、 MYSQL_USER、MYSQL_ROOT_PASSWORD、MYSQL_PASSWORD が含まれます。文字セットと 照合順序は mysqld サーバーのコマンドライン引数 (--character-set-server、--collation-server)として反映されます。公式の mysql イメージはこれらを環境変数ではなくサーバーフラグとして受け取るためです。
  • Compose での Workload 合成。 Compose Recipe は capability に依存しない Workload を宣言し、compose プロバイダーは MySQL イメージ、その環境、名前付き データボリューム、ヘルスチェックを備えた docker-compose.yaml サービスを合成します。
  • オペレーターのエスケープハッチ。 Compose の release は infra.overrides.image を設定します。これは Component 自身のスキーマが名前を持たない provider 固有の事実のための開かれた柱であり、レンダリングされたサービスはその正確なイメージ参照で実行されます。 Provider 固有のオーバーライドを参照してください。
  • 2 スロットの資格情報モデル。 パスワードはコンポーネントの features: 柱へのアタッチメントで、それぞれ feature.aggrega.ai/kind: secret のラベルが付いた Feature であり、 アプリケーションの values とは分離されています。Component の featuresSchema は Black-Box の root_password スロットと透過的な user_password スロットを宣言します。

Kubernetes での資格情報の受け渡し

root_password は Black-Box スロット(inject: [])で、受け渡しは Recipe が制御します。 アタッチされた inject-value 資格情報は値をコンポーネントの inject パイプに載せ、Recipe はそれを .context.inject.env.MYSQL_ROOT_PASSWORD として読み取り、通常のコンテナ環境変数を出力します。 これに対して Kubernetes Secret は生成されません。

user_password は透過的なスロット(inject: [env, file])です。full バリアントは参照可能な資格情報をアタッチし、それが Kubernetes Secret を実体化してその ID を公開します。Recipe は containers.attachments を通じてスロットを参照し、合成器はこれを env の secretKeyRef としてレンダリングします。 生成された Secret とコンテナの参照は、どちらも .features.user_password.provides.name を読み取るため、 同じリソースを指します。user_password を アタッチしないまま(base バリアント)にすることも有効です。その場合 Recipe はインラインの 開発用デフォルト(MYSQL_PASSWORD: apppass)にフォールバックし、Secret は生成されないため、 最小構成のデプロイでもレンダリングと実行ができます。

サンプルを生成する

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

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

Terminal window
aggrega scaffold --example mysql-standalone

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

Terminal window
cd mysql-standalone

ビルド

このワークスペースには .aggrega-config.yaml がないため、標準ライブラリのエンティティはハブレジストリ hub.aggrega.ai から解決され、カタログフラグは不要です。--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き込みます。

Terminal window
# Kubernetes — synthesized helm StatefulSet (base: root credential only)
aggrega build --release release-helm-synth.yaml --auto-pull
# Kubernetes — synthesized helm StatefulSet (full: both credential slots)
aggrega build --release release-helm-synth-auth.yaml --auto-pull
# Local development (Docker Compose)
aggrega build --release release-compose.yaml --auto-pull

レンダリングされた成果物は dist/ 配下に出力されます。

AI アシスタントを使う

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

Aggrega のツールだけを使い、フォルダーは自分で作成しないでください。ワークスペースフォルダーにまだ `mysql-standalone` フォルダーがない場合は、`example` を `mysql-standalone` に設定し、`dir` を指定せずに `scaffold` ツールを一度呼び出してください。これにより、例が新しい `mysql-standalone` フォルダーに書き込まれます。次に、`release-helm-synth.yaml`、`release-helm-synth-auth.yaml`、`release-compose.yaml` の順に、各 Release について `build` ツールを一度ずつ呼び出してください。毎回、`workspace_root` を `mysql-standalone`、`release` をそのファイル、`auto_pull` を true、`write` を true に設定します。各ビルドが書き込んだファイルを教えてください。ファイルは `mysql-standalone/dist/` の下にあります。

オペレーターによるサイジング

Kubernetes の releases は環境ごとにオペレーターによるサイジングの柱を満たします: コンテナイメージのタグは infra.engine_version(mysql:8.4)から、 volumeClaimTemplate のリクエストとストレージクラスは infra.storage から得られます。 開発者の Aggregate がこれらのフィールドを持つことはありません。

Provider 固有のオーバーライド

サイジングの柱は名前付きフィールドです。Component は engine_version と storage を宣言するため、オペレーターがいずれかを設定することは、Component が 想定していたフィールドを埋めることになります。infra.overrides は Component が想定できないもののための柱です。 任意のネスト構造を受け付けるオブジェクトとして宣言され、 各 Recipe はどのキーを読み取るかを文書化します。

release-compose.yaml はこれを使用します。Compose Recipe は 1 つのキー image を読み取り、 それが設定されている場合、コンテナは Recipe が engine_version から組み立てる参照ではなく、 その正確な参照を実行します:

infra:
engine_version: "8.4"
overrides:
image: "registry.internal.example/library/mysql:8.4"

レンダリングされたサービスは、オーバーライドをそのまま保持します:

services:
db:
image: registry.internal.example/library/mysql:8.4
[… omitted: the service's environment, labels, volume, network and health check]

これは、同じサーバーバージョンのレジストリミラー版やダイジェスト固定版のビルドを使うための方法です。 これは Component の契約ではなく、ターゲット環境に属するデプロイ上の事実です。キーのセットは Component ごとではなく Recipe ごとであるため、どのキーが適用されるかは Recipe を確認します。 ここでの Compose Recipe は image を読み取り、何も読み取らない Recipe はその旨を明記します。