Helm 可选嵌套变量

Question

如何在值文件中创建一个可选块，然后在模板中引用它？

例如，假设我有一个如下所示的值文件：

# values.yaml
foo:
   bar: "something"

然后我有一个如下所示的 helm 模板：

{{ .Values.foo.bar }}

如果我想将值文件中的 foo.bar 设为可选怎么办？如果值中不存在 foo 键，则会引发错误。

我尝试添加为 if 条件。但是，如果缺少 foo 键，这仍然会失败：

{{ if .Values.foo.bar }}
{{ .Values.foo.bar }}
{{ end }}

非常感谢任何想法。

Answer 1

大多数图表会将父对象默认为values.yaml 中的空地图，因此它始终存在。

foo: {}

然后{{ if .Values.foo.bar }} 工作。

如果不可能，请测试两个键：

{{ if .Values.foo }}
{{ if .Values.foo.bar }}
{{ .Values.foo.bar }}
{{ end }}
{{ end }}

在这种情况下使用 and 函数不起作用，因为 and 评估所有参数，即使第一个参数是错误的。

如果您需要检查是否存在假值或空值，sprig 还包含 hasKey 函数：

{{ if hasKey .Values.foo "bar" }}

Answer 2

简单的解决方法

用括号()包裹每个可为空的级别。

{{ ((.Values.foo).bar) }}

或者

{{ if ((.Values.foo).bar) }}
{{ .Values.foo.bar }}
{{ end }}

它是如何工作的？

Helm 使用 go text/template 并从那里继承行为。

每对括号 () 可以被认为是一个pipeline。

来自文档 (https://pkg.go.dev/text/template#hdr-Actions)

它是：

默认的文本表示（与 fmt.Print 打印的相同）...

行为：

如果管道的值为空，不产生输出...空值为false，0，任意nil指针或接口值，任意长度为零的数组、切片、映射或字符串。

因此，通过用括号包裹每个可为空的级别，当它们被链接时，前驱的 nil 指针优雅地不向后继的生成任何输出等等，从而实现嵌套的可为空字段的解决方法。 p>

Answer 3

我成功使用的一种技术是使用一个变量来保存外部块的值，然后可以使用 default 和 Sprig 的 dict 帮助器等模板构造。

{{- $foo := .Values.foo | default dict -}}
Bar is {{ $foo.bar | default "not in the values file" }}

如果文件中没有foo，这将提供一个备用字典，因此始终定义$foo，您可以在其中查找$foo.bar。

Answer 4

使用with

查看with operator。这将当前范围限制在.Values.foo 的级别，如果缺少.foo，该块将被静默忽略：

{{- with .Values.foo }}
  {{- .bar }}
{{- end }}

Answer 5

在 sprig 中实现了一个名为 dig 的新函数，它确实解决了这个问题，请参阅此处 http://masterminds.github.io/sprig/dicts.html。

尚未发布，因此不太可能很快掌舵。

同时我修改了@Samuel 解决方案以模仿新的挖掘功能。

{{- define "dig" -}}
  {{- $mapToCheck := index . "map" -}}
  {{- $keyToFind := index . "key" -}}
  {{- $default := index . "default" -}}
  {{- $keySet := (splitList "." $keyToFind) -}}
  {{- $firstKey := first $keySet -}}
  {{- if index $mapToCheck $firstKey -}} {{/* The key was found */}}
    {{- if eq 1 (len $keySet) -}}{{/* The final key in the set implies we're done */}}
      {{- index $mapToCheck $firstKey -}}
    {{- else }}{{/* More keys to check, recurse */}}
      {{- include "dig" (dict "map" (index $mapToCheck $firstKey) "key" (join "." (rest $keySet)) "default" $default) }}
    {{- end }}
  {{- else }}{{/* The key was not found */}}
      {{- $default -}}
  {{- end }}
{{- end }}

你可以这样称呼它

$regKey := include "dig" (dict "map" .Values "key" "global.registryKey" "default" "") 

Answer 6

我四处寻找同一问题的答案，但找不到任何东西。看来你必须使用自定义函数，所以我写了一个。这是我想出的。它适用于我的用例，欢迎提供反馈/改进。

_helpers.tpl

{{- define "hasDeepKey" -}}
  {{- $mapToCheck := index . "mapToCheck" -}}
  {{- $keyToFind := index . "keyToFind" -}}
  {{- $keySet := (splitList "." $keyToFind) -}}
  {{- $firstKey := first $keySet -}}
  {{- if index $mapToCheck $firstKey -}}{{*/ The key was found */}}
    {{- if eq 1 (len $keySet) -}}{{*/ The final key in the set implies we're done */}}
true
    {{- else }}{{*/ More keys to check, recurse */}}
      {{- include "hasDeepKey" (dict "mapToCheck" (index $mapToCheck $firstKey) "keyToFind" (join "." (rest $keySet))) }}
    {{- end }}
  {{- else }}{{/* The key was not found */}}
false
  {{- end }}
{{- end }}

values.yaml:

    {{- if eq "true" (include "hasDeepKey" (dict "mapToCheck" .Values "keyToFind" "foo.bar")) }}
      bar: {{- .Values.foo.bar }}
    {{- end }}