如何在Terraform GCP实例模板模块中支持自定义任意metadata键值对？

要让你的Terraform模块支持传入自定义metadata并和内置配置合并，按以下步骤操作：

1. 在模块中定义接收自定义metadata的变量 #

在模块目录下创建variables.tf文件，添加一个类型为map(string)的变量，默认值设为空字典，这样调用模块时可按需传入：

variable "custom_metadata" {
  type        = map(string)
  description = "自定义实例元数据键值对，将与模块内置元数据合并"
  default     = {}
}

2. 合并内置与自定义metadata #

修改模块内的google_compute_instance_template资源，使用Terraform的merge函数把模块内置的metadata和外部传入的自定义配置合并。如果自定义键与内置键重复，自定义值会覆盖内置值：

resource "google_compute_instance_template" "main" {
  # 其他实例模板配置...
  
  metadata = merge(
    {
      # 模块内置的固定元数据
      api-key = "secret value"
      # 其他内置键值对...
    },
    var.custom_metadata
  )
  
  # 其他实例模板配置...
}

3. 调用模块时传入自定义metadata #

注意修正示例中的Terraform语法错误（Terraform使用=而非:，字符串用双引号），调用方式如下：

module "my_first_app" {
  source = "./my_module"

  custom_metadata = {
    my-key       = "abc"
    another-key  = "def"
  }
}

module "my_second_app" {
  source = "./my_module"

  custom_metadata = {
    different-key = "ert"
  }
}

补充说明 #

• merge函数的顺序决定了覆盖优先级：后面的map会覆盖前面map中的相同键。如果不希望自定义值覆盖内置的api-key，可以调换顺序把var.custom_metadata放在前面、内置map放在后面，但通常允许覆盖的场景更灵活。
• 如果需要支持非字符串类型的metadata值，可将变量类型改为map(any)，但GCP的metadata值本质均为字符串，Terraform会自动完成类型转换，因此map(string)足以覆盖绝大多数场景。

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