Helm Chart語法概要

目錄

• 1、概述
• 2、調試
• 3、內置對象
• 4、Values
• 5、管道與函數
• 6、流程控制
  • 6.1 if
  • 6.2 with
  • 6.3 range
• 7、變量
• 8、命名模板
• 9、開發Chart的流程

1、概述

前面分別寫到了 JenkinsPipeline語法概要 和 Dockerfile語法概要，最近又重新拾起了Helm Chart，剛好回憶一下其語法 ~

Helm是k8s中的一個包管理工具，可以用來部署k8s資源。在Helm中最核心的就是模板，即模板化的k8s manifests文件

它本質上就是一個Go的template模板。Helm在Go template模板的基礎上，還會增加很多東西。如一些自定義的元數據信息、擴展的庫以及一些類似於編程形式的工作流，例如條件語句、管道等等。這些東西都會使得模板變得更加豐富

有了模板，怎么把配置融入進去，用的就是values.yaml文件

2、調試

Helm也提供了--dry-run --debug調試參數，幫助驗證模板正確性。在執行helm install時候帶上這兩個參數就可以把對應的values值和渲染的資源清單打印出來，而不會真正的去部署一個release

比如來調試創建的一個chart包：

# helm install web --dry-run /root/mychart

3、內置對象

使用 {{.Release.Name}}將release的名稱插入到模板中。這里的Release就是Helm的內置對象，下面是一些常用的內置對象

Release.Name	release 名稱
Release.Name	release 名字
Release.Namespace	release 命名空間
Release.Service	release 服務的名稱
Release.Revision	release 修訂版本號，從1開始累加

4、Values

Values對象是為Chart模板提供值，這個對象的值有4個來源

• chart包中的values.yaml文件

• 父chart包的values.yaml文件

• 通過helm install或者helm upgrade的 -f或者 --values參數傳入的自定義的yaml文件

• 通過 --set 參數傳入的值

chart的values.yaml提供的值可以被用戶提供的values文件覆蓋，而該文件同樣可以被 --set提供的參數所覆蓋

編輯mychart/values.yaml文件，將默認的值全部清空，然后添加一個副本數

# cat values.yaml 
replicas: 3
image: "nginx"
imageTag: "1.17"

# cat templates/deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}-deployment
spec:
  replicas: {{ .Values.replicas }}
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - image: {{ .Values.image }}:{{ .Values.imageTag }}
        name: nginx

查看渲染結果：

# helm install --dry-run web ../mychart/

values文件也可以包含結構化內容，例如

# cat values.yaml 
...
label:
  project: ms
  app: nginx

# cat templates/deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}-deployment 
spec:
  replicas: {{ .Values.replicas }} 
  selector:
    matchLabels:
      project: {{ .Values.label.project }}
      app: {{ .Values.label.app }}
  template:
    metadata:
      labels:
        project: {{ .Values.label.project }}
        app: {{ .Values.label.app }}
    spec:
      containers:
      - image: {{ .Values.image }}:{{ .Values.imageTag }} 
        name: nginx

查看渲染結果：

# helm install --dry-run web ../mychart/

5、管道與函數

前面講的相關模塊，其實就是將值傳給模板引擎進行渲染，模板引擎還支持對拿到數據進行二次處理

例如從.Values中讀取的值變成字符串，可以使用quote函數實現

# vi templates/deployment.yaml
app: {{ quote .Values.label.app }}
# helm install --dry-run web ../mychart/ 
        project: ms
        app: "nginx"

quote .Values.label.app將后面的值作為參數傳遞給quote函數

模板函數調用語法為：functionName arg1 arg2...

另外還會經常使用一個default函數，該函數允許在模板中指定默認值，以防止該值被忽略掉

例如忘記定義，執行helm install會因為缺少字段無法創建資源，這時就可以定義一個默認值

# cat values.yaml 
replicas: 2
# cat templates/deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
- name: {{ .Values.name | default "nginx" }}

其他常用函數

• 縮進：{{ .Values.resources | indent 12 }}

• 大寫：{{ upper .Values.resources }}

• 首字母大寫：{{ title .Values.resources }}

6、流程控制

流程控制是為模板提供了一種能力，滿足更復雜的數據邏輯處理

Helm模板語言提供以下流程控制語句

• if/else 條件塊
• with 指定范圍
• range 循環塊

6.1 if

if/else塊是用於在模板中有條件地包含文本塊的方法，條件塊的基本結構如下

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

示例

# cat values.yaml 
devops: k8

# cat templates/deployment.yaml 
...
  template:
    metadata:
      labels:
        app: nginx
        {{ if eq .Values.devops "k8s" }}
        devops: 123
        {{ else }}
        devops: 456
        {{ end }}

在上面條件語句使用了eq運算符判斷是否相等，除此之外，還支持ne、 lt、 gt、 and、 or等運算符

通過模板引擎來渲染一下，會得到如下結果

# helm install --dry-run web ../mychart/ 
...
      labels:
        app: nginx

        devops: 456
       

可以看到渲染出來會有多余的空行，這是因為當模板引擎運行時，會將控制指令刪除，所有之前占的位置也就空白了，需要使用{{- if ...}}的方式消除此空行

# cat templates/deploymemt.yaml
...
        env:
        {{- if eq .Values.env.hello "world" }}
          - name: hello
            value: 123
        {{- end }}

現在就沒有多余的空格了，如果使用-}}需謹慎，比如上面模板文件中

# cat templates/deploymemt.yaml
...
       env:
        {{- if eq .Values.env.hello "world" -}}
           - hello: true
        {{- end }}

這會渲染成：

        env:- hello: true

因為-}}它刪除了雙方的換行符

條件判斷就是判斷條件是否為真，如果值為以下幾種情況則為false

• 一個布爾類型的 假

• 一個數字 零

• 一個 空的字符串

• 一個 nil（空或 null）

• 一個空的集合（ map、 slice、 tuple、 dict、 array）

除了上面的這些情況外，其他所有條件都為 真

例如，判斷一個空的數組

# cat values.yaml 
resources: {}
  # limits:
  #   cpu: 100m
  #   memory: 128Mi
  # requests:
  #   cpu: 100m
  #   memory: 128Mi

# cat templates/deploymemt.yaml
...
    spec:
      containers:
      - image: nginx:1.16
        name: nginx
        {{- if .Values.resources }}
        resources:
{{ toYaml .Values.resources | indent 10 }}
        {{- end }}

例如，判斷一個布爾值

# cat values.yaml 
service:
  type: ClusterIP
  port: 80

ingress:
  enabled: true 
  host: example.ssgeek.com

# cat templates/ingress.yaml 
{{- if .Values.ingress.enabled -}}
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: {{ .Release.Name }}-ingress
spec:
  rules:
  - host: {{ .Values.ingress.host }}
    http:
      paths:
      - path: /
        backend:
          serviceName: {{ .Release.Name }}
          servicePort: {{ .Values.service.port }}
{{ end }}

6.2 with

with ：控制變量作用域

之前的 {{.Release.xxx}}或者 {{.Values.xxx}}，其中的 .就是表示對當前范圍的引用， .Values就是告訴模板在當前范圍中查找 Values對象的值。而 with語句就可以來控制變量的作用域范圍，其語法和一個簡單的 if語句比較類似

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

with語句可以允許將當前范圍 .設置為特定的對象，比如前面一直使用的 .Values.label，可以使用 with來將 .范圍指向 .Values.label

# cat values.yaml 
...
replicas: 3
label:
  project: ms
  app: nginx

# cat templates/deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}-deployment
spec:
  replicas: 1
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      {{- with .Values.nodeSelector }}
      nodeSelector:
        team: {{ .team }}
        gpu: {{ .gpu }}
      {{- end }}
      containers:
      - image: nginx:1.16
        name: nginx

優化后

      {{- with .Values.nodeSelector }}
      nodeSelector:
        {{- toYaml . | nindent 8 }}
      {{- end }}

上面增加了一個{{- with .Values.label }} xxx {{- end }}的一個塊，這樣的話就可以在當前的塊里面直接引用 .team和 .gpu了

with是一個循環構造。使用Values.nodeSelector中的值：將其轉換為Yaml

toYaml之后的點是循環中.Values.nodeSelector的當前值

6.3 range

在Helm模板語言中，使用 range關鍵字來進行循環操作

在 values.yaml文件中添加上一個變量列表

# cat values.yaml 
test:
  - 1
  - 2
  - 3

循環打印該列表

apiVersion: v1
kind: ConfigMap
metadata:
  name: {{ .Release.Name }}
data:
  test: |
  {{- range .Values.test }}
    {{ . }}
  {{- end }}

循環內部使用的是一個 .，這是因為當前的作用域就在當前循環內，這個 .引用的當前讀取的元素

7、變量

這是語言中基本的概念：變量，在模板中，使用變量的場合不多，但可以看到如何使用它來簡化代碼，並更好地利用with和range，舉例如下

例子1：獲取列表鍵值

# cat ../values.yaml
env:
  NAME: "gateway"
  JAVA_OPTS: "-Xmx1G"
  
# cat deployment.yaml 
...
		env:
		{{- range $k, $v := .Values.env }}
           - name: {{ $k }}
             value: {{ $v | quote }}
        {{- end }}

結果如下

    env:
       - name: JAVA_OPTS
         value: "-Xmx1G"
       - name: NAME
         value: "gateway"

上面在 range循環中使用 $key和 $value兩個變量來接收后面列表循環的鍵和值

例子2：with中不能使用內置對象

with語句塊內不能再 .Release.Name對象，否則報錯

可以將該對象賦值給一個變量可以來解決這個問題

apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}-deployment
spec:
  replicas: {{ .Values.replicas }}
  template:
    metadata:
      labels:
        project: {{ .Values.label.project }}
        app: {{ quote .Values.label.app }}
      {{- with .Values.label }}
        project: {{ .project }}
        app: {{ .app }}
        release: {{ .Release.Name }}
      {{- end }}

上面會出錯

      {{- $releaseName := .Release.Name -}}
      {{- with .Values.label }}
        project: {{ .project }}
        app: {{ .app }}
        release: {{ $releaseName }}
        # 或者可以使用$符號,引入全局命名空間
        release: {{ $.Release.Name }}
      {{- end }}

可以看到在 with語句上面增加了一句 {{-$releaseName:=.Release.Name-}}，其中 $releaseName就是后面的對象的一個引用變量，它的形式就是 $name，賦值操作使用 :=，這樣 with語句塊內部的 $releaseName變量仍然指向的是 .Release.Name

8、命名模板

命名模板：使用define定義，template引入，在templates目錄中默認下划線_開頭的文件為公共模板(_helpers.tpl)

# cat _helpers.tpl
{{- define "demo.fullname" -}}
{{- .Chart.Name -}}-{{ .Release.Name }}
{{- end -}}

# cat deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ template "demo.fullname" . }}
...

template指令是將一個模板包含在另一個模板中的方法。但是，template函數不能用於Go模板管道。為了解決該問題，增加include功能

# cat _helpers.tpl
{{- define "demo.labels" -}}
app: {{ template "demo.fullname" . }}
chart: "{{ .Chart.Name }}-{{ .Chart.Version }}"
release: "{{ .Release.Name }}"
{{- end -}}

# cat deployment.yaml 
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "demo.fullname" . }}
  labels:
    {{- include "demo.labels" . | nindent 4 }}
...

上面包含一個名為 demo.labels 的模板，然后將值 . 傳遞給模板，最后將該模板的輸出傳遞給 nindent 函數

9、開發Chart的流程

先創建模板

helm create demo

修改Chart.yaml，Values.yaml，添加常用的變量

在templates目錄下創建部署鏡像所需要的yaml文件，並變量引用yaml里經常變動的字段

更多內容可以參考官方文檔

See you ~

關注公眾號加群，更多原創干貨與你分享 ~