如何在Terraform中通过多tfvars文件增量合并对象变量？

核心思路 #

通过Terraform内置的merge函数，将三层配置（通用、地域、实例）的对象变量逐层合并，实现属性级的增量覆盖，而非全量替换整个对象映射。

1. 定义分层变量 #

在你的Terraform模块中，定义三个独立的变量，分别对应不同层级的配置，其中非通用层的变量仅包含需要覆盖的可选属性：

# 通用层变量：定义完整的对象结构
variable "common_cluster_secrets" {
  type = map(object({
    namespace          = string
    cluster_name       = string
    cluster_server     = string
    cluster_bearertoken = string
  }))
  default = {}
}

# 地域层变量：仅定义需要地域级覆盖的属性，标记为可选
variable "region_cluster_secrets" {
  type = map(object({
    cluster_name = optional(string)
    # 可添加其他地域专属的可选属性
  }))
  default = {}
}

# 实例层变量：仅定义需要实例级覆盖的属性，标记为可选
variable "instance_cluster_secrets" {
  type = map(object({
    cluster_server = optional(string)
    # 可添加其他实例专属的可选属性
  }))
  default = {}
}

2. 合并变量生成最终配置 #

通过locals结合merge函数，逐层合并三层变量，实现属性的增量覆盖：

locals {
  # 第一步：合并通用层与地域层配置
  merged_region_secrets = merge(
    var.common_cluster_secrets,
    {
      for secret_key, region_attrs in var.region_cluster_secrets :
      secret_key => merge(var.common_cluster_secrets[secret_key], region_attrs)
    }
  )

  # 第二步：合并上述结果与实例层配置，得到最终的集群密钥配置
  cluster_secrets = merge(
    local.merged_region_secrets,
    {
      for secret_key, instance_attrs in var.instance_cluster_secrets :
      secret_key => merge(local.merged_region_secrets[secret_key], instance_attrs)
    }
  )
}

3. 配置文件与执行命令 #

保持你现有的三层tfvars文件结构，调整每个文件的变量定义：

• 通用tfvars（如common.tfvars）：填写完整的common_cluster_secrets配置

  common_cluster_secrets = {
    "argocd-cluster-secret" = {
      namespace = "argocd",
      cluster_name = "default-cluster",
      cluster_server = "https://default.example.com",
      cluster_bearertoken = "token-default"
    }
  }
  

• 地域tfvars（如us-east.tfvars）：仅填写需要覆盖的地域级属性

  region_cluster_secrets = {
    "argocd-cluster-secret" = {
      cluster_name = "us-east-cluster"
    }
  }
  

• 实例tfvars（如us-east-prod.tfvars）：仅填写需要覆盖的实例级属性

  instance_cluster_secrets = {
    "argocd-cluster-secret" = {
      cluster_server = "https://us-east-prod.example.com/k8s/clusters/c-xxxxxx"
    }
  }
  

执行Terraform时，依次加载这三个文件即可：

terraform plan -var-file=common.tfvars -var-file=us-east.tfvars -var-file=us-east-prod.tfvars

关键注意事项 #

• 确保非通用层变量的属性标记为optional()，避免未赋值时的类型报错
• 如果某个密钥仅在通用层存在，地域或实例层没有对应key，合并后会自动保留通用层的完整配置
• 后续新增属性只需在通用层的object定义中添加，无需拆分单个变量，保持对象结构的完整性

内容的提问来源于stack exchange，提问作者sibaz