Terraform 模块模板生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/terraform-module-template-generator
技能介绍
要解决的问题
手工编写 Terraform 模块时,重复劳动很容易占用大部分时间:目录结构要自己定,variables.tf 里的入参要逐个补齐,outputs.tf 的输出契约也常常遗漏。团队若要维护风格一致、文档可读的模块,靠复制粘贴只会积累漂移,版本升级或补 README.md 时也会很痛。
这个技能如何工作
它围绕模块脚手架展开,核心能力包括:
- 使用 HCL 模板快速搭建模块目录与基础文件;
- 生成
variables.tf与outputs.tf,明确输入参数和对外暴露的输出; - 借助 Terraform Registry API 拉取目标模块 schema,用于对齐参数和输出;
- 调用
terraform-docs自动生成或刷新README.md。
典型流程是先确定模块用途和输入输出边界,再基于模板生成骨架,然后通过 Registry API 校验或补全 schema,最后运行 terraform-docs 生成文档。
适用边界与注意点
它适合标准模块初始化或重构阶段,尤其是需要统一团队模块结构、补齐变量与输出定义的场景。对于高度定制的业务逻辑、复杂多云编排,或需要精细控制生成策略的模块,仍建议人工审核生成结果。生成内容依赖 Registry 中的 schema 与本地 terraform-docs,因此使用前要确认相关工具和依赖可用。
使用场景
- 首次创建Terraform模块时,生成基础目录结构和初始文件
- 补充模块变量定义和输出块,确保输入输出契约完整
- 通过Terraform Registry API拉取模块schema,对齐参数与输出
- 调用terraform-docs自动生成模块README文档
适合人员
- Terraform开发者,需要快速生成标准模块结构
- 云原生工程师,希望统一团队模块的变量和输出定义
- 平台工程团队,需要标准化模块文档和维护流程
- 基础设施维护者,负责模块升级和schema对齐