如何在consul-template中转义$符号并阻止变量解析？

错误原因 #

原配置中，Consul-Template（基于Go模板）的引号转义方式不正确，导致生成的script.sh里出现单引号不匹配问题。嵌套的单引号未正确转义，使得Shell解析时无法找到闭合的单引号，触发unexpected EOF while looking for matching ''`错误。

解决方法 #

根据需求选择以下方案：

方案1：保留$NOMAD_ALLOC_DIR作为环境变量（运行时自动替换） #

调整Consul-Template配置，正确转义嵌套单引号：

template {
  destination = "local/script.sh"
  data        = <<-EOH
    cmd='bash -c '\''source "$NOMAD_ALLOC_DIR/creds.env"; backup'\'''
  EOH
}

生成的script.sh内容为：

cmd='bash -c '\''source "$NOMAD_ALLOC_DIR/creds.env"; backup'\'''

Shell执行时会自动将$NOMAD_ALLOC_DIR替换为对应环境变量值。

方案2：将$NOMAD_ALLOC_DIR作为字面量字符串（不做变量替换） #

若需让$NOMAD_ALLOC_DIR原样保留在脚本中，需额外转义$符号：

template {
  destination = "local/script.sh"
  data        = <<-EOH
    cmd='bash -c '\''source "\$NOMAD_ALLOC_DIR/creds.env"; backup'\'''
  EOH
}

生成的script.sh内容为：

cmd='bash -c '\''source "\$NOMAD_ALLOC_DIR/creds.env"; backup'\'''

此时Shell不会解析$NOMAD_ALLOC_DIR，而是将其作为字面量字符串处理。

原理说明 #

在Go模板的单引号字符串中，'\''是插入单个单引号的标准写法：

• 第一个'：闭合当前单引号字符串
• \'：输出一个单引号
• 最后一个'：重新开启单引号字符串

通过这种方式，能确保生成的Shell脚本中引号完全匹配，避免语法错误。

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