容器与云原生 / 系统课时

创建 Helm Chart

创建 Helm Chart

创建 Chart 的关键不是把 YAML 全部改成模板,而是把稳定结构保留为清单,把会随环境变化的部分提取成 Values。本节从脚手架开始,整理元数据、默认配置和模板,并用本地渲染验证结果。

学习目标

  • 说明 Chart.yaml、values.yaml 与 templates/ 的职责
  • 将一个最小 Deployment 清单改造成可配置模板
  • 使用 helm template 验证默认值与覆盖值是否正确生效

Chart 目录承担什么职责

Chart.yaml 描述 Chart 自身的名称、版本和类型;values.yaml 提供默认配置;templates/ 保存带 Go Template 表达式的 Kubernetes 资源模板。Helm 渲染时把 Values、Release 信息和 Chart 元数据注入模板,最终得到普通 Kubernetes YAML。

Helm Chart 从配置到清单的渲染链路

这三部分应保持边界清晰:应用结构放模板,环境差异放 Values,包自身信息放 Chart.yaml。如果把所有字段都参数化,模板会比原始清单更难维护。

从脚手架改造成最小 Chart

下面的脚本创建 demo-web Chart,移除默认模板,并写入一个最小可渲染的 Deployment。示例只依赖 Helm 客户端,不要求连接 Kubernetes 集群。

bash
helm create demo-web
rm -rf demo-web/templates/*

cat > demo-web/Chart.yaml <<'EOF'
apiVersion: v2
name: demo-web
description: Minimal demo chart
type: application
version: 0.1.0
appVersion: "1.27"
EOF

cat > demo-web/values.yaml <<'EOF'
replicaCount: 1
image:
  repository: nginx
  tag: "1.27"
EOF

cat > demo-web/templates/deployment.yaml <<'EOF'
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}
spec:
  replicas: {{ .Values.replicaCount }}
  selector:
    matchLabels:
      app.kubernetes.io/instance: {{ .Release.Name }}
  template:
    metadata:
      labels:
        app.kubernetes.io/instance: {{ .Release.Name }}
    spec:
      containers:
        - name: nginx
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
          ports:
            - containerPort: 80
EOF

helm template demo-release ./demo-web --set replicaCount=2

预期输出(保留关键字段):

text
Creating demo-web
---
# Source: demo-web/templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: demo-release
spec:
  replicas: 2
  ...
  template:
    ...
    spec:
      containers:
        - name: nginx
          image: "nginx:1.27"
          ports:
            - containerPort: 80

这里的 demo-release 来自 .Release.Name,而副本数来自 .Values.replicaCount。命令行的 --set replicaCount=2 覆盖了 values.yaml 中的默认值 1,因此渲染结果里出现 replicas: 2。

认识模板中的三个常用数据源

数据源 典型用途 本例
.Values 读取默认值及外部覆盖值 .Values.replicaCount
.Release 读取本次安装实例的信息 .Release.Name
.Chart 读取 Chart 元数据 .Chart.Name、.Chart.Version

version 表示 Chart 包版本,appVersion 只是应用版本元数据,Helm 不会自动把 appVersion 当作镜像标签。若希望两者关联,必须在模板中显式引用对应字段或在 Values 中统一管理。

只参数化真正会变化的字段

从普通 Kubernetes 清单迁移时,优先提取副本数、镜像、Service 类型、资源限制、域名和环境变量等部署差异。apiVersion、kind、选择器结构等长期稳定字段通常直接保留,更容易阅读和审查。

模板变量最终必须渲染成合法 YAML。字符串值可能包含特殊字符时,应根据字段语义使用模板函数做转义或引用;同一变量在 selector 与 Pod labels 中出现时,还要保证两边渲染结果完全一致,否则 Deployment 会因选择器不匹配而失效。

用覆盖值验证可配置性

本地渲染是创建 Chart 后最直接的检查方式。下面覆盖副本数和镜像标签,并只观察渲染结果,不向集群提交资源。

bash
helm template prod ./demo-web --set replicaCount=3 --set image.tag=1.27.5

预期结果(节选):

text
metadata:
  name: prod
spec:
  replicas: 3
  ...
  template:
    ...
    spec:
      containers:
        - name: nginx
          image: "nginx:1.27.5"

如果覆盖值没有出现在渲染结果中,应先检查 Values 路径是否与模板引用一致,再检查模板表达式是否位于正确的 YAML 层级。一个可维护的 Chart 应让读者能从 values.yaml 快速看出“哪些参数允许改变”,同时让 templates/ 保持接近原生 Kubernetes 清单的可读性。

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

目录与阅读设置

阅读设置

17

记录一个想法

创建 Helm Chart

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

登录哪都通