Terragrunt项目中实现多资源创建的优雅方案

在基础设施即代码(IaC)实践中，我们经常遇到需要批量创建相似资源的情况。本文将以Terragrunt项目中创建多个VPC终端节点为例，探讨如何优雅地实现这一需求。

传统方式的局限性

传统做法是为每个VPC终端节点创建单独的terragrunt.hcl文件，这种方式虽然直观但存在明显缺点：

• 代码重复率高
• 维护成本增加
• 部署效率低下

更优解决方案

通过改造Terraform模块和优化Terragrunt配置，我们可以实现单一配置管理多个资源。

Terraform模块改造

关键点在于将输入变量设计为支持列表类型：

variable "endpoints" {
  type = list(object({
    name                            = string
    endpoint_type                   = string
    interface_endpoint_service_name = string
    subnet_ids                      = optional(list(string), [])
  }))
}

然后使用for_each循环创建资源：

resource "aws_vpc_endpoint" "this" {
  for_each = { for idx, endpoint in var.endpoints : idx => endpoint }

  vpc_id              = var.vpc_id
  service_name        = each.value.interface_endpoint_service_name
  vpc_endpoint_type   = each.value.endpoint_type
  subnet_ids          = each.value.subnet_ids
  private_dns_enabled = true

  tags = merge(
    var.tags,
    {
      Name = each.value.name
    }
  )
}

Terragrunt配置优化

在terragrunt.hcl中，我们可以简洁地定义多个终端节点：

inputs = {
  endpoints = [
    {
      name                            = "vault"
      endpoint_type                   = "Interface"
      interface_endpoint_service_name = "com.amazonaws.us-east-1.vault"
      subnet_ids                      = ["subnet-123456", "subnet-123456", "subnet-123456"]
    },
    {
      name                            = "s3"
      endpoint_type                   = "Gateway"
      interface_endpoint_service_name = "com.amazonaws.us-east-1.s3"
      subnet_ids                      = ["subnet-234567", "subnet-234567", "subnet-234567"]
    }
  ]
}

方案优势

1. 代码简洁性：避免了重复配置，所有终端节点定义在一个结构中
2. 维护便利：修改或新增终端节点只需编辑列表项
3. 状态管理：所有资源由单一状态文件管理，降低复杂度
4. 扩展性：可轻松添加更多终端节点而不改变基础架构

实现细节

1. 索引处理：使用for循环的idx作为资源标识符，确保每个资源有唯一标识
2. 可选参数：通过optional函数为subnet_ids等参数提供默认值
3. 标签合并：使用merge函数将公共标签与资源特定标签结合

适用场景

此方案特别适合以下场景：

• 需要创建多个同类型AWS资源
• 资源配置相似但参数不同
• 希望简化配置管理
• 需要保持基础设施代码DRY(Don't Repeat Yourself)原则

总结

通过将Terraform模块设计为支持列表输入，并结合Terragrunt的配置能力，我们可以优雅地实现多资源创建。这种方法不仅提高了代码的可维护性，还简化了部署流程，是基础设施即代码实践中的优秀范例。