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

Terraform RDS(インライン HCL アーティファクト)

単一の MariaDB データベースを開発者の意図として一度だけ記述し、マネージドな AWS RDS インスタンスをプロビジョニングする Terraform HCL ファイルとしてレンダリングします。

この例は Terraform provider の アーティファクト 形式を示します。 Recipe は artifacts: の下にインラインの main.tf 本文を持ち、コンパイラは そのテンプレート式を解決したうえで本文をそのまま出力します。provider は terraform を実行することはなく、下流の terraform apply が実行する HCL を生成します。

ファイル

  • aggregate.yaml — 開発者の意図:型が core/datastore/mariadb の db component を 1 つ、論理データベース名とともに宣言します。 クラウドのターゲットに関する情報はここには含まれません。
  • release.yaml — オペレーターによるサイジング:infra 境界のエンジンバージョン、ストレージ、HA です。db のエントリは、Component の必須スロット root_password を core/generated-secret でバインドします。これは、エンジンが認証情報を所有することを示す認証情報 Feature です(後述)。さらに、インスタンスがバックアップを保持する期間を設定する core/backup をアタッチします。
  • manifest.yaml — MariaDB の component 型を Terraform Recipe terraform/mariadb-rds に、認証情報の Feature 型を terraform/generated-secret に、バックアップの Feature 型を terraform/backup-native にバインドします。
  • .aggrega-config.yaml — カタログのエンティティの解決元となるハブレジストリを指定します。

サンプルを生成する

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

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

Terminal window
aggrega scaffold --example terraform-rds

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

Terminal window
cd terraform-rds

ビルド

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

--auto-pull は、新しいクローンに欠けているロックファイルをビルド中に書き出します。レンダリングされた main.tf は dist/infra/terraform/modules/db/ に配置され、dist/infra/terraform/ にある境界のルート設定 aggrega.modules.tf が db をそれを指す module ブロックとして宣言します。本文は、ビルドを識別する # コメントの来歴ブロックで始まり、続いて AWS provider のバージョンを制約する required_providers ブロック、解決済みの aws_db_instance リソース(ストレージと HA の値は Release から代入され、バックアップの保持期間は core/backup のアタッチが設定し、認証情報は manage_master_user_password により RDS が管理します)、そしてインスタンスのホスト名を持つ address 出力が続きます。Recipe はこれを ${module.db.address} の形式で host として公開します。

この module ブロックには引数がありません。その理由はこの例の形式にあります。 Recipe が本文を記述したため、Release の値をリソースに直接代入しています。モジュールは variable ブロックを宣言せず、 コンパイラが渡すものは何も残っていません。

module "db" {
source = "./modules/db"
}

代わりにモジュールをベンダリングする Recipe( terraform-rds-module の例)は、それらの入力を 本文で宣言しないままにするため、コンパイラがこのブロックの引数として供給します。

AI アシスタントを使う

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

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

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

core/datastore/mariadb は root_password を必須スロットとして宣言しており、何もバインドされていない間は ビルドが停止します。セルフホストの MariaDB では記述時にパスワードをバインドする必要がありますが、 マネージドな RDS インスタンスでは不要です。RDS がマスターパスワードを自ら生成・ローテーションし、 この Recipe の manage_master_user_password がそれを有効にします。

そのためオペレーターは、Release の db のエントリで、 エンジンがマテリアルを所有する認証情報 Feature である core/generated-secret によってスロットをバインドします。 エンジンが認証情報を所有するかどうかは Manifest が選ぶ Recipe から決まるため、 バインドはオペレーターが行い、Aggregate はそれについて何も記述しません。

components:
db:
features:
root_password:
type: core/generated-secret

記述すべきものがないためアタッチメントは何も設定せず、 Manifest が選択する FeatureRecipe(terraform/generated-secret)は何もレンダリングしない純粋な配線です。 そのため、レンダリングされた main.tf はアタッチメントがまったくない場合とバイト単位で同一です。 スロットはバインドされ、そのためのアーティファクトは出力されません。

Manifest の FeatureRecipe 参照は provider で修飾されている (terraform/generated-secret:1.0.0)点に注意してください。修飾なしの recipe 名は、 それを持つ provider がちょうど 1 つの場合にのみ解決されます。標準ライブラリは generated-secret FeatureRecipe を複数の provider で提供しているため、修飾なしの generated-secret:1.0.0 はまったく解決されず、provider を暗黙に選ぶのではなく、 ビルドは明示的に停止します。

マネージドターゲットでのバックアップ

RDS はインスタンスを自らバックアップし、特に指定がなければ各自動バックアップを 7 日間保持します。オペレーターは、Release で資格情報の隣に core/backup をアタッチすることでこれを変更します:

backup:
type: core/backup
infra:
retention_days: 14

Manifest はこの Feature を terraform/backup-native にバインドします。これは独自には何もレンダリングしません。バックアップはインスタンスの設定であるため、Recipe はアタッチメントを読み取り、すでにレンダリングしているリソースに書き込みます。main.tf 内の aws_db_instance のバックアップ部分:

## ── Backup ───────────────────────────────────────────────
backup_retention_period = 14

30 2 * * * のような infra.schedule は、インスタンスの backup_window も 02:30-03:00(UTC で解釈)に設定します。ここでのように省略すると、RDS がウィンドウを選びます。RDS が保持できない値 — 35 日を超える保持期間や、毎日 1 つの時刻以外のスケジュール — は、アタッチメントを示してビルドを停止させます。