Go 模板语法

模板分隔符与基本语法

Helm 使用 Go 的 text/template 包。所有模板指令写在双大括号 {{ }} 内。

# 基础输出
name: {{ .Values.appName }}

# 管道（Pipeline）：将左侧的值传给右侧的函数
name: {{ .Values.appName | upper }}           # 转大写
name: {{ .Values.appName | quote }}           # 加引号
name: {{ .Values.appName | trunc 63 | trimSuffix "-" }}  # 截断+去尾横线

# 去除空白行：{{- 去左侧空白，-}} 去右侧空白
{{- if .Values.enabled }}
key: value
{{- end }}

内置对象

Helm 在渲染模板时注入了多个内置对象，通过 . 访问。

# 常见内置对象用法
metadata:
  name: {{ .Release.Name }}-myapp
  namespace: {{ .Release.Namespace }}
  labels:
    app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
    helm.sh/chart: {{ printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" }}
spec:
  containers:
  - image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
    imagePullPolicy: {{ .Values.image.pullPolicy }}

控制流：if / else

# 基本 if/else
{{- if .Values.ingress.enabled }}
# 渲染 Ingress...
{{- end }}

# if/else if/else
type:
{{- if eq .Values.service.type "NodePort" }}
  NodePort
{{- else if eq .Values.service.type "LoadBalancer" }}
  LoadBalancer
{{- else }}
  ClusterIP
{{- end }}

# 逻辑运算符：and / or / not
{{- if and .Values.ingress.enabled .Values.ingress.tls }}
# 同时启用了 ingress 和 tls
{{- end }}

# 真值判断：以下值为 false（空字符串、0、nil、空 slice/map）
{{- if .Values.someValue }}   # someValue 非空/非零/非 nil 则执行

循环：range

# 遍历 slice（列表）
env:
{{- range .Values.envVars }}
  - name: {{ .name }}        # . 指向当前元素
    value: {{ .value | quote }}
{{- end }}

# 遍历 map（键值对），$key 和 $val 是变量绑定
annotations:
{{- range $key, $val := .Values.annotations }}
  {{ $key }}: {{ $val | quote }}
{{- end }}

# 使用 $index 获取索引
{{- range $index, $host := .Values.ingress.hosts }}
  # $index 从 0 开始
{{- end }}

with：作用域切换

# 不使用 with（繁琐）
image: {{ .Values.image.repository }}:{{ .Values.image.tag }}
pullPolicy: {{ .Values.image.pullPolicy }}

# 使用 with 切换作用域（. 变为 .Values.image）
{{- with .Values.image }}
image: {{ .repository }}:{{ .tag }}
pullPolicy: {{ .pullPolicy }}
{{- end }}

# with 块内需要访问父作用域，使用 $ 引用全局根对象
{{- with .Values.resources }}
resources:
  {{- toYaml . | nindent 2 }}
releaseName: {{ $.Release.Name }}  # $ 访问根对象
{{- end }}

define 与 include：模板复用

使用 define 定义命名模板，用 include 或 template 调用。

# 在 _helpers.tpl 中定义命名模板
{{- define "myapp.labels" -}}
app.kubernetes.io/name: {{ include "myapp.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

# 在其他模板文件中使用 include（支持管道，推荐）
metadata:
  labels:
    {{- include "myapp.labels" . | nindent 4 }}

# template 关键字（不支持管道，不推荐用于有缩进需求的场景）
{{ template "myapp.labels" . }}

实战：构建完整 Deployment 模板

# templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "myapp.fullname" . }}
  namespace: {{ .Release.Namespace }}
  labels:
    {{- include "myapp.labels" . | nindent 4 }}
spec:
  {{- if not .Values.autoscaling.enabled }}
  replicas: {{ .Values.replicaCount }}
  {{- end }}
  selector:
    matchLabels:
      {{- include "myapp.selectorLabels" . | nindent 6 }}
  template:
    metadata:
      labels:
        {{- include "myapp.selectorLabels" . | nindent 8 }}
      {{- with .Values.podAnnotations }}
      annotations:
        {{- toYaml . | nindent 8 }}
      {{- end }}
    spec:
      {{- with .Values.imagePullSecrets }}
      imagePullSecrets:
        {{- toYaml . | nindent 8 }}
      {{- end }}
      containers:
        - name: {{ .Chart.Name }}
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
          imagePullPolicy: {{ .Values.image.pullPolicy }}
          ports:
            - name: http
              containerPort: {{ .Values.service.port }}
              protocol: TCP
          {{- with .Values.resources }}
          resources:
            {{- toYaml . | nindent 12 }}
          {{- end }}
          {{- if .Values.envVars }}
          env:
            {{- range .Values.envVars }}
            - name: {{ .name | quote }}
              value: {{ .value | quote }}
            {{- end }}
          {{- end }}
      {{- with .Values.nodeSelector }}
      nodeSelector:
        {{- toYaml . | nindent 8 }}
      {{- end }}

常用模板函数速查