Terraform RDS(内置模块)
与 terraform-rds 示例相同的 MariaDB 意图,但通过 Terraform provider 的
sourced 形态渲染:Recipe 不使用内联 HCL 主体,而是指向一个本地 Terraform 模块,编译器将其原样内置,
然后从开发者和运维两大支柱提供其输入变量。
编译器输出的内容
构建在 dist/infra/terraform/ 下生成边界的根
配置,在 dist/infra/terraform/modules/db/ 下生成 db 组件
自身的文件:
- 边界根目录下的
aggrega.modules.tf— 根配置,将db声明为一个module块,其source为./modules/db,其参数 即模块的输入变量,按确定的键顺序排列。每个 terraform 边界都有一个这样的文件,正是它把边界的各个组件放入同一个 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"}其中两个参数值得追溯到它们的编写位置。
subnet_id 是 Release 在 infra.overrides 下提供的 DB 子网组名称 — 该子网组在本部署之外运维,其名称
因环境而异,且模块自身的声明没有默认值,因此
Recipe 将其断言为必需,缺失时构建会明确中止,而不是
针对错误的网络进行规划。instance_class 来自同一支柱,
但在 Recipe 中带有默认值,因此未作任何声明的 Release 得到
db.t3.small。
**无论 Recipe 向这些参数映射什么,编译器都原样传递
且从不解析 — 包括 Terraform 的 ${...} 指针。**随位置
变化的是该指针落在何处:模块参数是 Terraform 会求值的位置之一,因此写在那里的指针会在规划时针对
根配置解析,而不是作为字面字符串到达模块。它仍须指向该配置声明的某个内容。
由于输入在根配置中声明,单独的 modules/db/ 并不是一个
可以按部署状态进行规划的配置 — 如果你尝试这样做,引擎会如何处理,请参阅
Terraform provider 页面。
文件
aggregate.yaml— 开发者意图:一个类型为core/datastore/mariadb的db组件。release.yaml—infra边界的运维规格设定。其中db的条目用core/generated-secret绑定该 Component 必需的root_password槽位(见下文),并附加core/backup,使实例的每个自动备份保留 14 天——即上文的backup_retention_period;没有该附加项时,实例保留 7 天。manifest.yaml— 将 MariaDB 组件类型绑定到 Terraform Recipeterraform/mariadb-rds-module(该 Recipe 从本地获取其模块),将凭据 Feature 类型绑定到terraform/generated-secret,并将备份 Feature 类型绑定到terraform/backup-native,后者不渲染任何内容:Recipe 读取该附加项并自行提供模块的备份输入。.aggrega-config.yaml— 指定目录实体从中解析的 hub 注册表。
托管目标上的凭据槽位
core/datastore/mariadb 将 root_password 声明为必需槽位:只要没有绑定它,
构建就会中止。RDS 自行生成并轮换主密码,而本 Recipe 复制的内置模块设置了
manage_master_user_password 以启用该功能 — 因此该槽位委托给
引擎,而不是填入编写的值。
凭据是否由引擎管理,取决于 Manifest
选择的 Recipe,因此由运维在 Release 中 db 的条目上绑定该槽位。
它用 core/generated-secret 绑定,该类型不配置任何内容,因为
没有需要编写的内容,其 FeatureRecipe
(terraform/generated-secret)是纯粹的连接,不渲染任何内容。内置
模块和根配置的输出与完全没有附加时逐字节相同。Manifest 的引用带有 provider 限定,因为
裸 recipe 名称只有在恰好一个 provider 提供它时才能解析,而
标准库在多个 provider 下都提供了 generated-secret FeatureRecipe —
因此裸名称根本无法解析,构建会明确中止,而不是
悄悄替你选择一个 provider。
生成示例
你可以用下面的命令构建这个示例,也可以让你的 AI 助手替你构建。
将示例写入一个以其命名的新文件夹:
aggrega scaffold --example terraform-rds-module然后它会打印接下来要运行的命令。第一条命令进入新文件夹:
cd terraform-rds-module构建
aggrega build --release release.yaml --auto-pull--auto-pull 会在构建期间写入全新克隆所缺少的 lockfile。
借助 AI 助手
已配置 Aggrega 工具的 AI 助手也能完成同样的操作:把下面这条提示粘贴给它。
仅使用 Aggrega 工具,不要自行创建任何文件夹。如果工作区文件夹中还没有 `terraform-rds-module` 文件夹,请调用一次 `scaffold` 工具,将 `example` 设为 `terraform-rds-module`,且不设 `dir`:它会把示例写入新的 `terraform-rds-module` 文件夹。然后调用 `build` 工具,将 `workspace_root` 设为 `terraform-rds-module`,`release` 设为 `release.yaml`,`auto_pull` 设为 true,`write` 设为 true。告诉我构建写入了哪些文件;它们位于 `terraform-rds-module/dist/` 下。