Terragrunt多云架构配置实践指南

多云环境下的Terragrunt架构设计

在当今多云环境中，如何优雅地使用Terragrunt管理跨云平台的基础设施是一个常见挑战。本文将深入探讨如何构建一个支持AWS和Azure双云环境的Terragrunt项目结构。

典型项目结构分析

一个合理的多云Terragrunt项目结构通常如下所示：

├── terragrunt.hcl
├── aws
│   ├── providers.hcl
│   ├── main
│   │   ├── account.hcl
│   │   ├── us-east-1
│   │   │   ├── region.hcl
│   │   │   └── staging
│   │   │       ├── env.hcl
│   │   │       └── some_app
│   │   │           └── terragrunt.hcl
└── azure
    ├── providers.hcl
    ├── main
    │   ├── subscription.hcl
    │   ├── eastus
    │   │   ├── region.hcl
    │   │   └── production
    │   │       ├── env.hcl
    │   │       └── some_app
    │   │           └── terragrunt.hcl

这种结构清晰地分离了不同云平台的配置，同时保持了环境(如staging/production)和区域(如us-east-1/eastus)的一致性。

配置文件的职责划分

根级terragrunt.hcl

根目录下的terragrunt.hcl应该只包含真正跨云平台通用的配置项：

locals {
  namespace = "some-company"
  
  # 读取各层级配置
  provider_vars = read_terragrunt_config(find_in_parent_folders("providers.hcl"))
  region_vars = read_terragrunt_config(find_in_parent_folders("region.hcl"))
  environment_vars = read_terragrunt_config(find_in_parent_folders("env.hcl"))
}

inputs = merge(
  local.provider_vars.locals,
  local.region_vars.locals,
  local.environment_vars.locals,
  {
    namespace = local.namespace
  }
)

云平台特定的providers.hcl

每个云平台目录下的providers.hcl负责定义该平台特有的配置：

AWS示例：

locals {
  account_vars = read_terragrunt_config(find_in_parent_folders("account.hcl"))
  aws_account_name = local.account_vars.locals.aws_account_name
  aws_account_id   = local.account_vars.locals.aws_account_id
  aws_region       = local.region_vars.locals.aws_region
}

generate "provider" {
  path      = "provider.tf"
  if_exists = "overwrite_terragrunt"
  contents  = <<EOF
provider "aws" {
  region = "${local.aws_region}"
  allowed_account_ids = ["${local.aws_account_id}"]
  default_tags {
    tags = {
      terraformed = "true"
    }
  }
}
EOF
}

remote_state {
  backend = "s3"
  config = {
    bucket         = "terraform-state-${local.aws_account_name}-${local.aws_region}"
    dynamodb_table = "terraform-locks"
    encrypt        = true
    key            = "${path_relative_to_include()}/terraform.tfstate"
    region         = local.aws_region
  }
}

Azure示例：

locals {
  subscription_vars = read_terragrunt_config(find_in_parent_folders("subscription.hcl"))
  azure_region      = local.region_vars.locals.azure_region
  subscription_id   = local.subscription_vars.locals.subscription_id
}

generate "provider" {
  path      = "provider.tf"
  if_exists = "overwrite_terragrunt"
  contents  = <<EOF
provider "azurerm" {
  features {}
}
EOF
}

remote_state {
  backend = "azurerm"
  config = {
    storage_account_name = local.namespace
    container_name       = "terraform-state"
    key                  = "${path_relative_to_include()}/terraform.tfstate"
    resource_group_name  = local.namespace
  }
}

命名规范的最佳实践

在多云环境中，变量命名需要特别注意：

1. 区域命名：建议使用通用名称region而非aws_region或azure_region，让目录上下文决定其含义
2. 账户命名：可以考虑统一使用account而非混合使用account(AWS)和subscription(Azure)
3. 环境变量：保持完全一致，如都使用environment而非env或stage

解决include层级限制

Terragrunt只允许一级include，这是设计上的限制而非bug。解决方案是：

1. 避免使用根级include，改为使用read_terragrunt_config读取共享配置
2. 每个模块只include其直接父级的配置(如providers.hcl)
3. 通过find_in_parent_folders函数向上查找其他需要的配置

例如模块级的terragrunt.hcl应简化为：

terraform {
  source = "git::[e-mail]:redacted.git//some_app"
}

include "providers" {
  path = find_in_parent_folders("providers.hcl")
}

配置合并策略

使用merge函数合并配置时，建议遵循以下顺序：

1. 最通用的配置(如namespace)放在最底层
2. 云平台特定的配置(如region, account)放在中间层
3. 环境特定的配置(如environment)放在最上层

这样可以确保特定性强的配置覆盖通用配置。

总结

构建多云Terragrunt项目时，关键在于清晰的目录结构和合理的配置分层。通过将通用配置与云平台特定配置分离，并利用Terragrunt的配置合并功能，可以创建出既灵活又易于维护的多云基础设施代码库。记住保持命名一致性，并合理利用read_terragrunt_config而非多层include来解决配置共享问题。