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

Terraform RDS(ベンダリングしたモジュール)

terraform-rds の例と同じ MariaDB のインテントを、Terraform プロバイダーの ソース参照形式でレンダリングします。インラインの HCL 本体の代わりに、 Recipe はローカルの Terraform モジュールを指し、コンパイラはそれをそのままベンダリングしたうえで、 開発者と運用者の柱からその入力変数を供給します。

コンパイラが出力するもの

ビルドは、dist/infra/terraform/ の下に境界のルート 設定を、dist/infra/terraform/modules/db/ の下に db コンポーネント 自身のファイルを生成します。

  • 境界のルートにある aggrega.modules.tf — ルート設定です。 db を module ブロックとして宣言し、その source は ./modules/db、引数は モジュールの入力変数で、決定的なキー順に並びます。すべての terraform 境界が 1 つずつ持ち、境界のコンポーネントを単一の Terraform 設定にまとめるのはこのファイルです。
  • バイト単位でそのままコピーされたモジュールファイル(variables.tf、main.tf。 モジュール作成者が書いた ${...} 補間も含みます)。
  • それらのファイルの隣にある aggrega.provenance.tf — ビルドを識別する # コメントのファイルです。

この例が出力する db ブロックは次のとおりです。

module "db" {
source = "./modules/db"
allocated_storage = 100
backup_retention_period = 14
db_name = "appdb"
engine_version = "11.4"
instance_class = "db.t3.small"
multi_az = true
port = 3306
skip_final_snapshot = false
storage_type = "gp3"
subnet_id = "production-private-db-subnets"
}

これらの引数のうち 2 つは、記述された場所までたどる価値があります。 subnet_id は、Release が infra.overrides の下で供給する DB サブネットグループ名です。このグループはこのデプロイの外で運用され、名前は 環境ごとに異なり、モジュール自身の宣言にはデフォルトがありません。そのため Recipe はこれを必須とし、値がない場合は誤ったネットワークに対して プランを作成するのではなく、ビルドを明示的に停止します。instance_class も同じ柱から来ますが、 Recipe にデフォルトがあるため、何も指定しない Release には db.t3.small が適用されます。

Recipe がこれらの引数にマッピングしたものは、Terraform の ${...} ポインタを含め、コンパイラが 手を加えずにそのまま渡し、解決することはありません。 位置によって変わるのは、そのポインタがどこに届くかです。モジュールの引数は Terraform が評価する 位置の 1 つなので、そこに書かれたポインタはモジュールにリテラル文字列として届くのではなく、 プラン時にルート設定に対して解決されます。それでも、その設定が宣言しているものを指している必要があります。

入力はルートで指定されるため、modules/db/ 単体では、デプロイされたとおりに プランできる設定ではありません。試した場合にエンジンがどう動作するかは Terraform プロバイダーのページ を参照してください。

ファイル

  • aggregate.yaml — 開発者のインテント。型が core/datastore/mariadb の db コンポーネントを 1 つ定義します。
  • release.yaml — infra 境界に対する運用者のサイジング。db のエントリで、Component の必須スロット root_password を core/generated-secret でバインドし(後述)、core/backup をアタッチして、インスタンスの自動バックアップをそれぞれ 14 日間保持させます。これが上記の backup_retention_period です。アタッチしない場合、インスタンスは 7 日間保持します。
  • manifest.yaml — MariaDB コンポーネント型を、モジュールをローカルから取得する Terraform Recipe terraform/mariadb-rds-module に、認証情報の Feature 型を terraform/generated-secret に、バックアップの Feature 型を terraform/backup-native にバインドします。後者は何もレンダリングしません。Recipe がアタッチメントを読み取り、モジュールのバックアップ入力を自ら供給します。
  • .aggrega-config.yaml — カタログのエンティティの解決元となるハブレジストリを指定します。

マネージドなターゲットにおける認証情報スロット

core/datastore/mariadb は root_password を必須スロットとして宣言しています。何もバインドされていない間、 ビルドは停止します。RDS はマスターパスワードを自ら生成・ローテーションし、 この Recipe がコピーするベンダリングされたモジュールは manage_master_user_password を設定してこれを有効にします。そのため、このスロットは記述した値で埋めるのではなく、 エンジンに委ねられます。

エンジンが認証情報を所有するかどうかは Manifest が選ぶ Recipe によって決まるため、 運用者は Release の db のエントリでスロットをバインドします。 バインドには core/generated-secret を使います。記述すべきものがないためこれは何も設定せず、 その FeatureRecipe (terraform/generated-secret)は何もレンダリングしない純粋な配線です。ベンダリングされた モジュールとルート設定は、アタッチメントがまったくない場合とバイト単位で同じ内容で出力されます。 Manifest の参照がプロバイダー修飾されているのは、修飾なしのレシピ名は それを持つプロバイダーがちょうど 1 つの場合にしか解決されず、標準ライブラリは generated-secret FeatureRecipe を複数のプロバイダーの下で提供しているためです。 そのため修飾なしの名前はまったく解決されず、ビルドはプロバイダーを黙って選ぶのではなく、 明示的に停止します。

サンプルを生成する

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

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

Terminal window
aggrega scaffold --example terraform-rds-module

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

Terminal window
cd terraform-rds-module

ビルド

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

--auto-pull は、新しいクローンにはない lockfile をビルド中に書き出します。

AI アシスタントを使う

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

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