如何在Terraform中为YAML模板传入block_device_mappings变量

你当前使用philips-labs的Terraform AWS GitHub Runner模块中的multi-runner模块，现有YAML配置模板和Terraform变量定义，需要将block_device_mappings变量传入YAML模板，以下是两种实现方案，其中templatefile渲染方案为最优选择：

方案一：使用Terraform templatefile函数（最优） #

该方案利用Terraform原生的模板渲染能力，直接将变量注入YAML模板，自动处理复杂类型的序列化，避免格式错误。

步骤1：修改YAML模板的变量引用 #

将模板中的block_device_mappings: ${block_device_mappings}替换为：

block_device_mappings: ${yamlencode(block_device_mappings)}

注：yamlencode会把Terraform的list(object)类型变量自动转换成符合YAML语法的数组结构，确保配置格式正确。

步骤2：更新local中的配置加载逻辑 #

把原来用file加载YAML的代码，替换为templatefile并传入变量：

locals {
  # 加载并渲染YAML配置模板，注入block_device_mappings变量
  multi_runner_config = { 
    for c in fileset("${path.module}/templates/runner-configs", "*.yaml") : 
    trimsuffix(c, ".yaml") => yamldecode(templatefile("${path.module}/templates/runner-configs/${c}", {
      block_device_mappings = var.block_device_mappings
    })) 
  }
}

方案优势 #

• 语法直观，直接在模板中声明变量引用，便于维护
• 自动处理复杂数据类型的YAML序列化，无需手动拼接字符串
• 支持模板中注入多个变量，扩展性强

方案二：加载YAML后合并变量（备选） #

如果不想修改模板文件，可以先加载原始YAML配置，再通过merge函数将变量合并到对应位置：

locals {
  # 加载原始YAML配置
  raw_multi_runner_config = { 
    for c in fileset("${path.module}/templates/runner-configs", "*.yaml") : 
    trimsuffix(c, ".yaml") => yamldecode(file("${path.module}/templates/runner-configs/${c}")) 
  }

  # 合并block_device_mappings变量到runner_config中
  multi_runner_config = {
    for k, v in local.raw_multi_runner_config :
    k => merge(v, {
      runner_config = merge(v.runner_config, {
        block_device_mappings = var.block_device_mappings
      })
    })
  }
}

方案局限性 #

• 需要嵌套使用merge函数，层级较深时可读性差
• 会覆盖YAML模板中原本的block_device_mappings配置（如果存在）
• 无法直接在模板中看到变量注入的逻辑，维护成本较高

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