Terragrunt 中 Catalog、Scaffold 和 Boilerplate 的最佳实践指南

在基础设施即代码(IaC)领域，Terragrunt 作为 Terraform 的包装工具，提供了 Catalog、Scaffold 和 Boilerplate 三大功能来优化模块管理和项目初始化流程。本文将深入解析这些功能的使用场景和最佳实践。

核心功能定位与区别

Scaffold 主要用于快速生成模块基础结构，它能够基于模板快速创建模块目录结构和配置文件。而 Boilerplate 则更适合处理复杂的架构蓝图生成，特别是那些不依赖 Terragrunt 环境的场景，如基础设施根目录的初始化。

Catalog 功能作为模块目录管理工具，支持通过标准 go-getter URL 获取模块信息。最新版本(v0.70.1+)已增强对 GitHub Enterprise 的支持，用户可以使用 HTTPS 或 SSH 协议格式的 URL 来避免兼容性问题。

架构蓝图管理实践

对于企业级参考架构蓝图，建议采用以下目录结构进行管理：

examples/for-production/terragrunt-architecture-catalog/
├── blueprints/        # 存放架构蓝图定义
└── templates/         # 存放可复用的模板文件
    └── services/      # 服务级别模板

这种集中化管理方式便于维护和版本控制，同时保持与业务服务的清晰对应关系。

自定义模板开发指南

在需要定制 Scaffold 模板的场景下，可以在目标目录创建.boilerplate子目录来存放定制化配置。这种方式既保持了与标准模板的兼容性，又能满足特定项目的个性化需求。

对于企业私有仓库用户，建议注意以下几点：

1. 使用标准协议格式(HTTPS/SSH)的仓库URL
2. 确保模板路径符合项目规范
3. 在复杂场景下考虑结合 Boilerplate 进行二次渲染

版本兼容性说明

从 Terragrunt v0.70.1 版本开始，工具链已全面支持 GitHub Enterprise 等私有仓库方案。用户在企业内网环境中可以放心使用全套功能，无需担心兼容性障碍。

通过合理组合这些功能，团队可以建立起高效、规范的基础设施代码管理体系，显著提升 IaC 工程实践的标准化程度和可维护性。