首页 > 解决方案 > 使用字典拆分和范围的 Helm 模板缩进错误

问题描述

我正在尝试设置在我的 helm 图表中拥有动态数量的 volume 和 volumeMounts 的能力。这是我的 deployment.yaml 的外观:

    volumeMounts:
    {{- if .Values.deployment.hostPath }} {{ $dict := split ":" .Values.deployment.hostPath }} {{ range $idx, $val := $dict }} {{ $mnt := split "," $val }}
    - mountPath: {{ $mnt._1 }}
      name: {{ $mnt._0 }}
    {{ end }}
    {{ end }}
  volumes:
  {{- if .Values.deployment.hostPath }} {{ $dict := split ":" .Values.deployment.hostPath }} {{ range $idx, $val := $dict }} {{ $mnt := split "," $val }}
  - name: {{ $mnt._0 }}
    hostPath:
      path: {{ $mnt._2 }}
      {{- if $mnt._3 }}
      type: {{ $mnt._3 }}
      {{ end }}
  {{ end }}
  {{ end }}

在 values.yaml 我有这样的东西:

Deployment:
  hostPath: test-host-path,/path/on/pod,/path/on/node,Directory

我正在做的是检查是否为 hostPath 定义了任何内容。如果有我创建一个字典,用':'分割项目。在第一个示例中,只有一个值字符串,因为 : 分隔符不存在。然后它执行一个循环范围(如果有多组值由':'分隔),然后它用逗号分割一组值。

因此,对于第一个示例,使用 helm install 可以正常工作:

values.yaml -->   hostPath: test-host-path,/path/on/pod,/path/on/node,Directory
        volumeMounts:
        - mountPath: /path/on/pod
          name: test-host-path

      volumes:
      - name: test-host-path
        hostPath:
          path: /path/on/node
          type: Directory

类型字段是可选的,所以我有一个块来检查它是否已定义,如果没有,它不会在 yaml 中呈现它。所以在我的下一个例子中,当我在最后一个逗号之后没有任何价值时,它也可以工作:

values.yaml -->   hostPath: test-host-path,/path/on/pod,/path/on/node,
        volumeMounts:
        - mountPath: /path/on/pod
          name: test-host-path

      volumes:
      - name: test-host-path
        hostPath:
          path: /path/on/node

但是现在,如果我尝试添加第二组数据,以“:”分隔,则在 helm install 时会失败:

Deployment:
  hostPath: test-host-path,/path/on/pod,/path/on/node,Directory:test-host-path-two,/path/on/pod/two,/path/on/node/two,Directory

Error: YAML parse error on chart/templates/deployment.yaml: error converting YAML to JSON: yaml: line 152: found a tab character that violates indentation
helm.go:94: [debug] error converting YAML to JSON: yaml: line 152: found a tab character that violates indentation

当然它提到了一个标签,但我不太清楚问题是什么。我已经使用相同的代码(dict、range、split)来填充配置映射中的多个条目,所以我认为它可以工作。但显然我在这里遗漏了一些东西。任何帮助,将不胜感激。

标签: kubernetesyamlkubernetes-helmgo-templateshelm3

解决方案


制表符可能潜入的位置并不完全明显。确实跳出的一件事是模板中存在一些额外的空白;例如,{{ range }}循环开始后有一个空格,可能会导致事情出错。

如果您遇到空格或缩进问题,要检查的一件好事是helm template输出;Helm 3 将打印“错误转换 YAML”,如您所示,如果它真的是错误的,但添加一个helm template --debug选项无论如何都会打印它。

其他有用的经验法则是在一行中只放置一个模板构造;在大括号内放置一个-“燕子空白”标记,但不要关闭大括号;并且通常将模板构造放在第一列。这些规则会让你得到类似的东西

    volumeMounts:
{{- if .Values.deployment.hostPath }}
{{- $dict := split ":" .Values.deployment.hostPath }}
{{- range $idx, $val := $dict }}
{{- $mnt := split "," $val }}
    - mountPath: {{ $mnt._1 }}
      name: {{ $mnt._0 }}
{{- end }}
{{- end }}
  volumes:
{{- if .Values.deployment.hostPath }}
{{- $dict := split ":" .Values.deployment.hostPath }}
{{- range $idx, $val := $dict }}
{{- $mnt := split "," $val }}
  - name: {{ $mnt._0 }}
    hostPath:
      path: {{ $mnt._2 }}
{{- if $mnt._3 }}
      type: {{ $mnt._3 }}
{{- end }}
{{- end }}
{{- end }}

您应该能够通过检查这个布局来判断缩进是正确的。在第一个示例中,例如,在 之前有一个换行符和空格- mountPath:,在 last 之后有一个换行符{{- end }},但应该清楚模板代码行之间没有杂散的换行符或空格。


推荐阅读