helm 语法

k8s
文章目录
  1. 1. 模版语法
    1. 1.1. 表达式
    2. 1.2. 变量
    3. 1.3. 函数&管道运算符
    4. 1.4. 流程控制语句
      1. 1.4.1. IF/ELSE
      2. 1.4.2. with
      3. 1.4.3. range
    5. 1.5. 子模版定义

想要快速的运行管理容器，helm就免不了，但是又不能总是用别人的charts，对于自己的项目肯定需要编写helm模板，所以就有必要学习helm的语法

模版语法

表达式

1
2
3
模版表达式： {{ 模版表达式 }}

模版表达式： {{- 模版表达式 -}} ， 表示去掉表达式输出结果前面和后面的空格，去掉前面空格可以这么写{{- 模版表达式 }}, 去掉后面空格 {{ 模版表达式 -}}

变量

默认情况点( . ), 代表全局作用域，用于引用全局对象。

例子：这里引用了全局作用域下的Values对象中的key属性。

1
{{ .Values.key }}

helm全局作用域中有两个重要的全局对象：Values和Release

Values代表的就是values.yaml定义的参数，通过.Values可以引用任意参数。

例子：

1
{{ .Values.replicaCount }}

引用嵌套对象例子，跟引用json嵌套对象类似

1
{{ .Values.image.repository }}

Release代表一次应用发布，下面是Release对象包含的属性字段：

Release.Name - release的名字，一般通过Chart.yaml定义，或者通过helm命令在安装应用的时候指定。
Release.Time - release安装时间
Release.Namespace - k8s名字空间
Release.Revision - release版本号，是一个递增值，每次更新都会加一
Release.IsUpgrade - true代表，当前release是一次更新.
Release.IsInstall - true代表，当前release是一次安装
例子:

1
{{ .Release.Name }}

除了系统自带的变量，我们自己也可以自定义模版变量。

变量名以$开始命名， 赋值运算符是 := (冒号+等号)

1
{{- $relname := .Release.Name -}}

引用自定义变量: 不需要 . 引用

1
{{ $relname }}

函数&管道运算符

调用函数的语法：

1
{{ functionName arg1 arg2... }}

例子:调用quote函数，将结果用“”引号包括起来。

1
{{ quote .Values.favorite.food }}

管道（pipelines）运算符 “|”

类似linux shell命令，通过管道 | 将多个命令串起来，处理模版输出的内容。

例子：

  1. 将.Values.favorite.food传递给quote函数处理，然后在输出结果。
1
{{ .Values.favorite.food | quote  }}
  1. 先将.Values.favorite.food的值传递给upper函数将字符转换成大写，然后专递给quote加上引号包括起来。
1
{{ .Values.favorite.food | upper | quote }}
  1. 如果.Values.favorite.food为空，则使用default定义的默认值
1
{{ .Values.favorite.food | default "默认值" }}
  1. 将.Values.favorite.food输出5次
1
{{ .Values.favorite.food | repeat 5 }}
  1. 对输出结果缩进2个空格
1
{{ .Values.favorite.food | nindent 2 }}

常用的关系运算符>、 >=、 <、!=、与或非在helm模版中都以函数的形式实现。

关系运算函数定义：

eq 相当于 =

ne 相当于 !=

lt 相当于 <=

gt 相当于 >=

and 相当于 &&

or 相当于 ||

not 相当于 !

例子:相当于 if (.Values.fooString && (.Values.fooString == “foo”))

1
2
3
{{ if and .Values.fooString (eq .Values.fooString "foo") }}
    {{ ... }}
{{ end }}

流程控制语句

IF/ELSE

语法:

1
2
3
4
5
6
7
8
9
10
11
12
13
{{ if 条件表达式 }}

#Do something

{{ else if 条件表达式 }}

#Do something else

{{ else }}

#Default case

{{ end }}

例子:

1
2
3
4
5
6
7
8
9
10
11
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
data:
  myvalue: "Hello World"
  drink: {{ .Values.favorite.drink | default "tea" | quote }}
  food: {{ .Values.favorite.food | upper | quote }}
  {{if eq .Values.favorite.drink "coffee"}}
    mug: true
  {{end}}

with

with主要就是用来修改 . 作用域的，默认 . 代表全局作用域，with语句可以修改.的含义.

语法:

1
2
3
{{ with 引用的对象 }}
这里可以使用 . (点)， 直接引用with指定的对象
{{ end }}

例子: .Values.favorite是一个object类型

1
2
3
4
{{- with .Values.favorite }}
drink: {{ .drink | default "tea" | quote }}   #相当于.Values.favorite.drink
food: {{ .food | upper | quote }}
{{- end }}

ps: 不能在with作用域内使用 . 引用全局对象, 如果非要在with里面引用全局对象，可以先在with外面将全局对象复制给一个变量，然后在with内部使用这个变量引用全局对象。

例子:

1
{{- $release:= .Release.Name -}}   #先将值保存起来

1
2
3
{{- with .Values.favorite }}
drink: {{ .drink | default "tea" | quote }}   #相当于.Values.favorite.drink
food: {{ .food | upper | quote }}
1
2
release: {{ $release }} #间接引用全局对象的值
{{- end }}

range

range主要用于循环遍历数组类型。

语法:

  1. 遍历map类型，用于遍历键值对象

  2. 变量$key代表对象的属性名，$val代表属性值

1
2
3
{{- range $key, $val := 键值对象 }}
{{ $key }}: {{ $val | quote }}
{{- end}}

语法：

1
2
3
4
5
{{- range 数组 }}

{{ . | title | quote }} # . (点)，引用数组元素值。

{{- end }}

例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
#values.yaml定义
 
#map类型
favorite:
  drink: coffee
  food: pizza
 
#数组类型
pizzaToppings:
  - mushrooms
  - cheese
  - peppers
  - onions
 
map类型遍历例子:
{{- range $key, $val := .Values.favorite }}
{{ $key }}: {{ $val | quote }}
{{- end}}
 
数组类型遍历例子:
{{- range .Values.pizzaToppings}}
{{ . | quote }}
{{- end}}

子模版定义

我们可以在_(下划线)开头的文件中定义子模版，方便后续复用。

helm create默认为我们创建了_helpers.tpl 公共库定义文件，可以直接在里面定义子模版，也可以新建一个，只要以下划线开头命名即可。

子模版语法:

1
2
3
4
5
定义模版
{{ define "模版名字" }} 模版内容 {{ end }}

引用模版:
{{ include "模版名字" 作用域}}

例子:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
#模版定义
{{- define "mychart.app" -}}
app_name: {{ .Chart.Name }}
app_version: "{{ .Chart.Version }}+{{ .Release.Time.Seconds }}"
{{- end -}}
 
apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}-configmap
  labels:
    {{ include "mychart.app" . | nindent 4 }} #引用mychart.app模版内容，并对输出结果缩进4个空格
data:
  myvalue: "Hello World"