Updated on Kubernetes

Helm3模板-控制流程

模板函数和管道是通过转换信息并将其插入到 YAML 文件中的强大方法。但有时候需要添加⼀些比插入字符串更复杂的模板逻辑。这就需要使用到模板语⾔中提供的控制结构了。

控制流程为我们提供了控制模板生成流程的⼀种能力，Helm 的模板语⾔提供了以下几种流程控制：

  • if/else 条件块
  • with 指定范围
  • range 循环块

除此之外，它还提供了⼀些声明和使用命名模板段的操作：

  • define 在模板中声明⼀个新的命名模板
  • template 导入⼀个命名模板
  • block 声明了⼀种特殊的可填写的模板区域

关于 命名模板 的相关知识点，我们会在后⾯文章中详细讲解，这里我们暂时介绍 if/else 、 with 、 range 这3中控制流程的用法。更多的内容可以去Helm3官方文档中详细查看：点击查看

1、if/else条件

if/else 块是用于在模板中有条件地包含文本块的方法，条件块的基本结构如下：

{{ if PIPELINE }}
# Do something
{{ else if OTHER PIPELINE }}
# Do something else
{{ else }}
# Default case
{{ end }}

当然要使用条件块就得判断条件是否为真，如果值为下⾯的几种情况，则管道的结果为 false：

  • ⼀个布尔类型的 假
  • ⼀个数字 零
  • ⼀个 空 的字符串
  • ⼀个 nil （空或 null ）
  • ⼀个空的集合（ map 、 slice 、 tuple 、 dict 、 array ）

除了上⾯的这些情况外，其他所有条件都为 真 。

注：我们现在谈论的是管道而不是值。这样做的原因是要明确控制结构可以执行整个管道，而不仅仅是评估值。

同样还是以上⾯的 ConfigMap 模板文件为例，添加⼀个简单的条件判断，如果 python 被设置为django，则添加⼀个 web: true（tempaltes/configmap.yaml） ：

img

在上⾯的模板文件中我们增加了⼀个条件语句判断 {{ if eq .Values.course.python “django” }}web:true{{ end }} ，其中运算符 eq 是判断是否相等的操作，除此之外，还有 ne 、 lt 、 gt 、 and 、 or 等运算符都是 Helm 模板已经实现了的，直接使用即可。这里 {{ .Values.course.python }} 的值在 values.yaml 文件中默认被设置为了django，所以正常来说下⾯的条件语句判断为真，所以模板文件最终被渲染后会有 web: true 这样的的⼀个条目：

img

可以看到上⾯模板被渲染后出现了 web: true 的条目，如果我们在安装的时候覆盖下 python 的值呢，
比如我们改成 ai :

img

根据我们模板⽂件中的定义，如果 {{ .Values.course.python }} 的值为 django 的话就会新增 web:true 这样的⼀个条目，但是现在我们是不是通过参数 –set 将值设置为了 ai，所以这里条件判断为假，正常来说就不应该出现这个条⽬了，上⾯我们通过 debug 模式查看最终被渲染的值也没有出现这个条目，证明条件判断是正确的。

2、空格控制

上⾯的条件判断语句是在⼀整行中的，如果平时经常写代码的同学可能非常不习惯了，我们⼀般会将其格式化为更容易阅读的形式，比如：

{{ if eq .Values.course.python "django" }}
web: true
{{ end }}

img

这样的话看上去比之前要清晰很多了，我们通过模板引擎来渲染⼀下，会得到如下结果：

img

我们可以看到渲染出来会有多余的空行，这是因为当模板引擎运行时，它将⼀些值渲染过后，之前的指令被删除，但它之前所占的位置完全按原样保留剩余的空白了，所以就出现了多余的空行。 YAML 文件中的空格是非常严格的，所以对于空格的管理非常重要，⼀不小心就会导致你的 YAML 文件格式错误。

其实我们可以通过使用在模板标识 {{ 后⾯添加破折号和空格 {{- 来表示将空白左移，而在 }} 前面添加⼀个空格和破折号 -}} 表示应该删除右边的空格，另外需要注意的是换行符也是空格！使用这个语法，我们来修改我们上⾯的模板文件去掉多余的空格（templates/configmap.yaml）：

img

现在我们来查看上⾯模板渲染过后的样⼦：

img

是不是没有多余的空格了，但是我们需要谨慎使用 -}} ，如果我们在 if 条件后⾯增加 -}} ，渲染是会报错的：

img

因为 -}} 它删除了双方的换行符，显然这是不正确的。从Helm3开始、已经不支持 -}} 这种写法了、这样写是会报错的、请谨慎使用。

注：有关模板中空格控制的详细信息，请参阅官方 Go 模板文档：Official Go template documentation

3、with修改范围

接下来我们来看下 with 关键词的使用，它用来控制变量作用域。前面的文章中 {{ .Release.xxx}} 或者 {{ .Values.xxx }} 的写法就是表示对当前范围的引用， .Values 就是告诉模板在当前范围中查找 Values 对象的值。而 with 语句就可以来控制变量的作用域范围，其语法和⼀个简单的 if 语句比较类似：

{{ with PIPELINE }}
# restricted scope
{{ end }}

with 语句可以允许将当前范围 . 设置为特定的对象，比如前⾯⼀直使用的 .Values.course ，我们可以使用 with 来将 . 范围指向 .Values.course (templates/configmap.yaml)：

img

上面我们增加了⼀个 {{- with .Values.course }}xxx{{- end }} 的块，这样的话我们就可以在当前的块里面直接引用 .python 和 .k8s 了，而不需要进⾏限定了，这是因为该 with 声明将 . 指向了 .Values.course ，在 {{- end }} 后 . 就会复原其之前的作用范围了，我们可以使用模板引擎来渲染上面的模板查看是否符合预期结果。不过需要注意的是在 with 声明的范围内，此时将无法从父范围访问到其他对象了，比如上面的模板渲染的时候将会报错，因为显然 .Release 根本就不在当前的 mychart 范围内，当然如果我们最后两行交换下位置就正常了，因为 {{- end }} 之后范围就被重置了：

{{- with .Values.course }}
k8s: {{ .k8s | upper | quote }}
python: {{ .python | repeat 3 | quote }}
{{- end }}

img

4、range循环

如果大家对编程语⾔熟悉的话，几乎所有的编程语⾔都支持类似于 for 、 foreach 或者类似功能的循环机制，在 Helm 模板语言中，是使用 range 关键字来进行循环操作。我们在 values.yaml 文件中添加上⼀个 course 列表：

course:
  k8s: devops
  python: django
courselist:
- k8s
- python
- search
- golang

现在我们有⼀个 course 列表，修改 ConfigMap 模板文件来循环打印出该列表：

img

可以看到最下面我们使用了⼀个 range 函数，该函数将会遍历 {{ .Values.courselist }} 列表，循环内部我们使用的是⼀个 . ，这是因为当前的作用域就在当前循环内，这个 . 从列表的第⼀个元素⼀直遍历到最后⼀个元素，然后在遍历过程中使用了 title 和 quote 这两个函数，前⾯这个函数是将字符串⾸字母变成大写，后⾯就是加上双引号变成字符串，所以按照上面这个模板被渲染过后的结果为：

img

我们可以看到 courselist 按照我们的要求循环出来了。除了 list 或者 tuple，range 还可以用于遍历具有键和值的集合（如map 或 dict），这个就需要用到变量的概念了。

5、变量

前面我们已经学习了函数、管理以及控制流程的使用方法，我们知道编程语言中还有⼀个很重要的概念叫：变量，在 Helm 模板中，使用变量的场合不是特别多，但是在合适的时候使用变量可以很好的解决我们的问题。如下面的模板：

{{- with .Values.course }} 
k8s: {{ .k8s | upper | quote }} 
python: {{ .python | repeat 3 | quote }} 
release: {{ .Release.Name }}
{{- end }}

我们在 with 语句块内添加了⼀个 .Release.Name 对象，但这个模板是错误的，编译的时候会失败，这是因为 .Release.Name 不在该 with 语句块限制的作用范围之内，我们可以将该对象赋值给⼀个变量可以来解决这个问题：

img

我们可以看到我们在 with 语句上⾯增加了⼀句 {{- ParseError: KaTeX parse error: Expected ‘EOF’, got ‘}’ at position 31: ….Release.Name -}̲} ，其中releaseName 就是后面的对象的⼀个引用变量，它的形式就是 name ，赋值操作使用 := ，这样 with 语句块内部的name*，赋值操作使用:=，这样*with语句块内部的releaseName 变量仍然指向的是 .Release.Name ，同样，我们 DEBUG 下查看结果：

img

可以看到已经正常了，另外变量在 range 循环中也非常有用，我们可以在循环中用变量来同时捕获索引的值：

courselist:
  {{- range index,index,course := .Values.courselist }}
  - {{ ParseError: KaTeX parse error: Expected 'EOF', got '}' at position 7: index }̲}: {{course | title | quote }}
  {{- end }}

img

例如上⾯的这个列表，我们在 range 循环中使用 index 和index和course 两个变量来接收后⾯列表循环的索引和对应的值，最终可以得到如下结果：

img

我们可以看到 courselist 下⾯将索引和对应的值都打印出来了，实际上具有键和值的数据结构我们都可以使⽤ range 来循环获得⼆者的值，比如我们可以对 .Values.course 这个字典来进行循环：

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  {{- range key,key,value := .Values.course }}
  {{ ParseError: KaTeX parse error: Expected 'EOF', got '}' at position 5: key }̲}: {{value | quote }}
  {{- end }}

img

直接使用 range 循环，用变量 key 、key、value 来接收字段 .Values.course 的键和值。这就是变量在Helm 模板中的使用方法。

推荐文章