如何通过Terraform动态引用Grafana数据源UID至仪表盘配置？

问题原因 #

使用file()函数读取JSON文件时，Terraform只会原样读取文件内容，不会解析其中的${data.grafana_data_source.azure_monitor.uid}插值表达式，导致这段字符串被直接传给Grafana。而Grafana的UID规则不允许包含${}这类特殊字符，因此触发“非法UID”错误。

可行解决方案 #

方案1：用templatefile()渲染模板 #

templatefile()会解析文件中的Terraform插值语法，适合需要保留JSON文件结构的场景：

1. 修改你的VMDASHBOARD.json，将UID部分改为模板变量（注意JSON的字符串引号）：

{
  "uid": "${azure_monitor_uid}",
  // 其他仪表盘配置内容...
}

2. 更新Terraform代码，使用templatefile()传递变量并生成配置JSON：

data "grafana_data_source" "azure_monitor" {
  name = "grafana-azure-monitor-datasource"
}

resource "grafana_dashboard" "test" {
  folder      = grafana_folder.rule_folder.uid
  config_json = templatefile("${path.module}/VMDASHBOARD.json", {
    azure_monitor_uid = data.grafana_data_source.azure_monitor.uid
  })
}

方案2：用jsonencode()动态构建配置 #

如果仪表盘配置逻辑不复杂，可以直接在Terraform代码中用jsonencode()生成完整的仪表盘JSON，直接引用数据源UID：

data "grafana_data_source" "azure_monitor" {
  name = "grafana-azure-monitor-datasource"
}

resource "grafana_dashboard" "test" {
  folder = grafana_folder.rule_folder.uid
  config_json = jsonencode({
    uid = data.grafana_data_source.azure_monitor.uid
    title = "VM监控仪表盘"
    // 补充其他仪表盘必填配置，比如panels、timezone等
  })
}

方案3：用replace()替换占位符 #

如果不想改动读取文件的方式，可以在JSON中设置占位符，再用replace()替换为实际UID：

1. 修改VMDASHBOARD.json的UID部分：

{
  "uid": "__AZURE_MONITOR_UID__",
  // 其他仪表盘配置内容...
}

2. 更新Terraform代码：

data "grafana_data_source" "azure_monitor" {
  name = "grafana-azure-monitor-datasource"
}

resource "grafana_dashboard" "test" {
  folder      = grafana_folder.rule_folder.uid
  config_json = replace(
    file("${path.module}/VMDASHBOARD.json"),
    "__AZURE_MONITOR_UID__",
    data.grafana_data_source.azure_monitor.uid
  )
}

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