Terragrunt 基础设施示例项目教程

Terragrunt 基础设施示例项目教程

terragrunt-infrastructure-live-exampleA repo used to show examples file/folder structures you can use with Terragrunt and Terraform项目地址:https://gitcode.com/gh_mirrors/te/terragrunt-infrastructure-live-example

1. 项目的目录结构及介绍

Terragrunt 基础设施示例项目的目录结构如下：

terragrunt-infrastructure-live-example/
├── _envcommon/
│   └── non-prod.hcl
│   └── prod.hcl
├── non-prod/
│   ├── account.hcl
│   ├── region.hcl
│   └── terragrunt.hcl
├── prod/
│   ├── account.hcl
│   ├── region.hcl
│   └── terragrunt.hcl
├── .gitignore
├── CODEOWNERS
├── LICENSE.txt
└── README.md

目录结构介绍

• _envcommon/: 包含环境通用的配置文件。
  • non-prod.hcl: 非生产环境的通用配置。
  • prod.hcl: 生产环境的通用配置。
• non-prod/ 和 prod/: 分别包含非生产环境和生产环境的配置文件。
  • account.hcl: 账户级别的配置文件。
  • region.hcl: 区域级别的配置文件。
  • terragrunt.hcl: Terragrunt 的主配置文件。
• .gitignore: Git 忽略文件配置。
• CODEOWNERS: 代码所有者配置。
• LICENSE.txt: 项目许可证文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件主要是 terragrunt.hcl，它位于每个环境的目录下（如 non-prod/terragrunt.hcl 和 prod/terragrunt.hcl）。

terragrunt.hcl 文件介绍

terragrunt.hcl 文件是 Terragrunt 的主配置文件，它包含了以下内容：

# -----------------------------------------------------------------------------
# TERRAGRUNT CONFIGURATION
# -----------------------------------------------------------------------------
locals {
  common_vars = read_terragrunt_config("${get_terragrunt_dir()}/common.hcl")
  account_vars = read_terragrunt_config(find_in_parent_folders("account.hcl"))
  region_vars = read_terragrunt_config(find_in_parent_folders("region.hcl"))

  name_prefix = local.common_vars.locals.name_prefix
  account_name = local.account_vars.locals.account_name
  account_id = local.account_vars.locals.account_id
  default_region = local.common_vars.locals.default_region
  aws_region = local.region_vars["aws_region"]
}
# -----------------------------------------------------------------------------

• common_vars: 读取通用配置文件。
• account_vars: 读取账户级别的配置文件。
• region_vars: 读取区域级别的配置文件。
• name_prefix, account_name, account_id, default_region, aws_region: 从配置文件中读取的变量。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几种：

common.hcl

通用配置文件，包含所有环境通用的配置。

account.hcl

账户级别的配置文件，包含账户相关的配置。

region.hcl

区域级别的配置文件，包含区域相关的配置。

terragrunt.hcl

Terragrunt 的主配置文件，包含 Terragrunt 的配置和引用其他配置文件的逻辑。

这些配置文件共同构成了 Terragrunt 项目的配置体系，确保了项目的灵活性和可维护性。

terragrunt-infrastructure-live-exampleA repo used to show examples file/folder structures you can use with Terragrunt and Terraform项目地址:https://gitcode.com/gh_mirrors/te/terragrunt-infrastructure-live-example