CI/CD / 系统课时

用模板语法生成 Kubernetes YAML

用模板语法生成 Kubernetes YAML

Helm 模板的核心价值,是把重复的 Kubernetes YAML 变成由 values 驱动的资源定义。本课用一个 Deployment 与可选 Service 串起变量、条件、循环和常见函数,并通过实际渲染检查最终交给 Kubernetes 的 YAML。

学习目标

  • 使用 {{ .Values.* }}、内置对象和管道函数生成资源字段
  • 使用 if 与 range 控制资源是否生成以及列表如何展开
  • 在安装前用 helm template 检查模板的真实渲染结果

从固定 YAML 提取变量

假设 Chart 名为 demo-app。副本数、镜像、容器端口等会随环境变化,不应直接写死在模板中,可以集中放入 values.yaml:

yaml
replicaCount: 2

image:
  repository: nginx
  tag: "1.27"

containerPort: 80
service:
  enabled: true
  type: ClusterIP
  port: 80

env:
  - name: APP_ENV
    value: production
  - name: LOG_LEVEL
    value: info

这是配置文件示例,不单独产生控制台输出。它的生效行为由模板引用决定,稍后使用 helm template 验证。

模板中的 .Values 对应当前合并后的 values;.Release.Name 则由 Helm 在安装或渲染时提供。Deployment 可以写成:

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels:
      app: {{ .Release.Name }}
  template:
    metadata:
      labels:
        app: {{ .Release.Name }}
    spec:
      containers:
        - name: app
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          ports:
            - containerPort: {{ .Values.containerPort }}

这里是模板文件片段示例,依赖前面的 values.yaml 以及 Helm 渲染上下文。模板表达式最终会被替换成普通 YAML 值。

用条件决定是否生成资源

有些环境需要 Service,有些场景只需要 Deployment。可以让 service.enabled 决定整个资源是否出现:

yaml
{{- if .Values.service.enabled }}
apiVersion: v1
kind: Service
metadata:
  name: {{ .Release.Name }}
spec:
  type: {{ .Values.service.type }}
  selector:
    app: {{ .Release.Name }}
  ports:
    - port: {{ .Values.service.port }}
      targetPort: {{ .Values.containerPort }}
{{- end }}

这是 templates/service.yaml 的完整模板示例。{{- 和 -}} 会裁剪相邻空白,适合清理控制语句留下的多余空行。将 service.enabled 改为 false 后,该模板不会产生 Service 文档。

用循环展开重复结构

环境变量、端口或挂载项通常是列表。与其固定写若干项,可以使用 range 遍历 values。下面把环境变量加入 Deployment 的容器定义中:

yaml
          env:
{{- range .Values.env }}
            - name: {{ .name }}
              value: {{ .value | quote }}
{{- end }}

这是片段示例,需要放在前述 Deployment 的容器对象中。进入 range 后,. 代表当前列表元素,因此 .name 和 .value 分别读取当前环境变量的字段。quote 会把值渲染成带引号的字符串,降低 YAML 类型推断造成歧义的风险。

Helm values 经模板控制生成 Kubernetes 资源的数据流

渲染后再判断模板是否正确

模板文件看起来正确,不代表最终 YAML 一定正确。应直接渲染 Chart,观察 Helm 真正生成的资源:

bash
helm template demo ./demo-app

预期输出的关键部分如下;Helm 版本可能增加 # Source: 等注释,因此应关注资源字段而不是注释文本:

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: demo
spec:
  replicas: 2
  selector:
    matchLabels:
      app: demo
---
apiVersion: v1
kind: Service
metadata:
  name: demo
spec:
  type: ClusterIP

如果还希望让 Helm 检查模板执行过程中能够发现的问题,可以加入 --debug。需要注意,helm template 主要验证本地模板渲染,并不等同于 Kubernetes API Server 接受这些资源。

模板设计时应优先让 values.yaml 表达环境差异,让模板表达资源结构和必要的控制逻辑。变量、条件和循环足以覆盖大量 Chart 场景;当模板开始堆积复杂业务判断时,通常意味着 values 结构或 Chart 边界需要重新设计。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用模板语法生成 Kubernetes YAML

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通