如何覆写Terraform模块中locals定义的map类型默认参数值

核心实现逻辑 #

通过Terraform内置的合并函数将模块内置默认配置和用户传入的自定义配置做深度合并，用户传入的字段优先级高于默认值，未传入的字段自动沿用默认配置，无需全量重写配置。 #

第一步：模块内部改造 #

1. 规范变量定义 #

首先明确instance变量的结构，标记所有字段为可选，配置空默认值：

variable "instance" {
  type = map(object({
    instance_id   = optional(string)
    instance_type = optional(string)
    ami           = optional(string)
    instance_config = optional(object({
      ebs = optional(map(number))
    }))
  }))
  default = {}
}

2. 配置合并逻辑 #

在模块的locals块中新增合并后的最终实例配置：

locals {
  # 原有内置默认实例配置
  default_instance = {
    "instance_1" = {
      instance_id   = "test_1"
      instance_type = "t2.medium"
      ami           = "ami-1234567"
      instance_config = {
        ebs = {
          "xvdb" = 20
        }
      }
    },
    "instance_2" = {
      instance_id   = "test_2"
      instance_type = "t2.small"
      ami           = "ami-7654321"
      instance_config = {
        ebs = {
          "xvdb" = 30
        }
      }
    }
  }

  # 深度合并默认配置与用户传入配置，用户值优先
  # Terraform 1.3+ 可直接用defaults函数，写法更简洁
  merged_instance = defaults(var.instance, local.default_instance)

  # 低版本Terraform兼容写法：手动遍历合并
  # merged_instance = merge(
  #   local.default_instance,
  #   {for k, v in var.instance : k => merge(local.default_instance[k], v)}
  # )
}

后续模块内创建EC2等资源时，直接引用local.merged_instance即可。 #

第二步：模块调用侧用法 #

调用侧无需修改原有写法，仅传入需要覆盖的差异化配置即可：

module "ec2" {
  source = "./modules/ec2" # source指定模块所在目录即可，无需指向单个tf文件
  instance = local.instance
}

locals {
  instance = {
    "instance_1" = {
      instance_type = "m5.xlarge"
      instance_config = {
        ebs = {
          "xvdb" = 100
        }
      }
    }
  }
}

方案优势 #

• 支持任意层级的参数覆盖，无需重写完整的实例配置
• 类型校验严格，变量定义明确字段结构，Terraform执行计划阶段即可发现类型错误
• 扩展性强，新增默认实例仅需在local.default_instance中添加配置，无需修改其他逻辑
• 向后兼容，原有调用侧代码无需调整即可直接使用

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