HCP Packer嵌套变量部分覆盖问题：默认值无法自动合并

解决方案 #

Packer的HCL变量系统默认不会自动合并嵌套对象的部分赋值——当你在vars文件中给cloud_init_details赋值时，相当于完全替换整个对象，而非仅覆盖指定字段。以下三种方法可以实现你要的部分覆盖需求：

方法1：拆分嵌套对象为独立顶层变量组 #

把嵌套层级拆成单独的变量，这样可以单独修改某一部分，未覆盖的字段自动沿用默认值：

# variables.pkr.hcl
variable "cloud_init_user_data" {
  type = object({
    cloud_init_template = string
    cloud_init_file_abspath = string
  })
  default = {
    cloud_init_template = "./deployments/ubuntu_2404_template_20241222/user-data.pkrtpl"
    cloud_init_file_abspath = "^$HOME^/.cache/packer_cache/downloads/user-data"
  }
}

variable "cloud_init_meta_data" {
  type = object({
    meta_data_file_abspath = string
  })
  default = {
    meta_data_file_abspath = "^$HOME^/.cache/packer_cache/downloads/meta-data"
  }
}

vars文件中只需覆盖需要修改的部分：

# vars.pkrvars.hcl
cloud_init_user_data = {
  cloud_init_template = "./deployments/ubuntu_2404_template_20241222/user-data.pkrtpl"
}

方法2：用局部值手动合并默认值与覆盖值 #

保留原嵌套变量结构，通过locals递归合并默认值和用户输入：

# variables.pkr.hcl
variable "cloud_init_details" {
  type = object({
    user_data = optional(object({
      cloud_init_template = optional(string)
      cloud_init_file_abspath = optional(string)
    }))
    meta_data = optional(object({
      meta_data_file_abspath = optional(string)
    }))
  })
  default = {}
}

# 定义局部值合并逻辑
locals {
  # 基础默认值
  default_cloud_init = {
    user_data = {
      cloud_init_template = "./deployments/ubuntu_2404_template_20241222/user-data.pkrtpl"
      cloud_init_file_abspath = "^$HOME^/.cache/packer_cache/downloads/user-data"
    }
    meta_data = {
      meta_data_file_abspath = "^$HOME^/.cache/packer_cache/downloads/meta-data"
    }
  }

  # 递归合并用户输入与默认值
  merged_cloud_init = merge(
    local.default_cloud_init,
    var.cloud_init_details,
    {
      user_data = merge(
        local.default_cloud_init.user_data,
        lookup(var.cloud_init_details, "user_data", {})
      ),
      meta_data = merge(
        local.default_cloud_init.meta_data,
        lookup(var.cloud_init_details, "meta_data", {})
      )
    }
  )
}

之后在Packer配置中使用local.merged_cloud_init代替var.cloud_init_details即可。

方法3：在嵌套类型定义中直接设置默认值（Packer v1.7+支持） #

如果你的Packer版本在v1.7及以上，可以在嵌套对象的类型定义中直接给每个字段设置默认值，用户只需提供要修改的部分：

# variables.pkr.hcl
variable "cloud_init_details" {
  type = object({
    user_data = object({
      cloud_init_template = string = "./deployments/ubuntu_2404_template_20241222/user-data.pkrtpl"
      cloud_init_file_abspath = string = "^$HOME^/.cache/packer_cache/downloads/user-data"
    }) = {}
    meta_data = object({
      meta_data_file_abspath = string = "^$HOME^/.cache/packer_cache/downloads/meta-data"
    }) = {}
  })
  default = {}
}

这种方式下，vars文件里的部分赋值会自动和类型定义中的默认值合并，无需额外逻辑。

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