如何在Helm模板或YAML资源文件使用valueFrom时给生成值加引号

报错根本原因 #

YAML语法规范中@、#、&、|等属于保留指示符，当字符串以这类字符开头时，YAML解析器会将其识别为特殊语法标记，而非普通字符串，就会抛出「无法识别的token」类报错。
你示例中使用secretKeyRef引用Secret的场景本身不会触发该报错，只有当你直接在env的value字段中渲染包含特殊开头字符的字符串时才会出现这个问题。

最优解决方法 #

直接使用Helm内置的quote模板函数处理需要渲染的字符串值即可，该函数会在模板渲染阶段自动给输出的字符串外层加上双引号，完全符合你的预期效果。

操作示例 #

原来的模板写法：

- name: BASIC_AUTH_USER
  value: {{ .Values.basicAuth.password }}

修改为套入quote函数：

- name: BASIC_AUTH_USER
  value: {{ .Values.basicAuth.password | quote }}

如果你的密码是通过其他模板函数获取的，同样直接在末尾套quote即可：

value: {{ include "custom.get-password" . | quote }}

常见疑问解答 #

• 会不会和密码本身包含的引号冲突？
  不会。quote添加的是YAML语法层面的外层引号，YAML解析器读取配置时会自动剥离这层引号，最终注入到容器的密码和你存在Values、Secret中的原始值完全一致，不会额外增加字符。
• 如果是批量渲染env列表怎么办？
  直接用toYaml函数处理整个env数组，它会自动识别所有需要加引号的字符串并自动处理，无需逐个配置：

env: {{ .Values.container.env | toYaml | nindent 10 }}

• 还有哪些场景可以用这个方法？
  所有以YAML保留字符开头的字符串渲染场景都适用，除了@外，#、*、{、[、>等开头的字符串都可以用quote统一规避解析错误。

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