罗罗编程学习记录
本页内容 展开查看

08.6.1 Helm Chart 结构与模板

所属:全栈开发面试题库 / 08 云原生与 DevOps / 08.6 Helm 与 Operator

覆盖范围

  • Chart 目录结构与 Chart.yaml
  • values.yaml 与模板渲染
  • 模板函数、管道、条件、范围循环
  • 依赖管理(requirements.yaml / Chart.yaml dependencies)
  • Helm 生命周期钩子与模板调试

高频题速览

编号 题目 难度 频率
08.6.1-001 Helm 是什么?解决了什么问题? 基础 ★★★★★
08.6.1-002 Chart 的目录结构是怎样的? 基础 ★★★★★
08.6.1-003 values.yaml 如何在模板中使用? 基础 ★★★★★
08.6.1-004 Helm 模板函数与管道怎么用? 进阶 ★★★★
08.6.1-005 Helm 的条件与循环怎么写? 进阶 ★★★★
08.6.1-006 Helm 依赖(subchart)怎么管理? 进阶 ★★★★
08.6.1-007 Helm 生命周期钩子(hooks)有哪些? 进阶 ★★★
08.6.1-008 如何调试 Helm 模板渲染? 基础 ★★★★
08.6.1-009 Helm 中如何避免敏感信息写在 values? 进阶 ★★★★
08.6.1-010 Helm 的 upgrade 与 rollback 机制? 进阶 ★★★★

08.6.1-001 Helm 是什么?解决了什么问题?

一句话结论

Helm 是 Kubernetes 的包管理器,把一组 YAML 模板化打包成 Chart,通过 values 定制参数,支持版本化、依赖管理、发布、升级与回滚,解决裸 YAML 在多环境复用与维护上的问题。

概念解释

  • Chart:一组 K8s 资源模板。
  • Release:Chart 安装到集群的一个实例。
  • values:自定义参数。
  • repo:Chart 仓库(如 Artifact Hub)。

原理流程

  1. helm install 读 Chart 与 values。
  2. 模板引擎渲染 YAML。
  3. kubectl apply 到集群。
  4. 记录 release 版本到 Secret。

代码 / 示例

helm repo add bitnami https://charts.bitnami.com/bitnami
helm install my-release bitnami/nginx --set replicaCount=3
helm list
helm upgrade my-release bitnami/nginx --set replicaCount=5
helm rollback my-release 1

常见误区

  • 误区:Helm 只是模板渲染工具;正解:Helm 还管理 release 生命周期(install/upgrade/rollback/uninstall),记录版本到 Secret。
  • 误区:Helm 必须联网;正解:可以 helm package 打成本地 tgz,离线安装。

追问

  • Q:Helm 2 与 Helm 3 区别? A:Helm 2 有 Tiller 服务端(已废弃),Helm 3 纯客户端,直接用 kubeconfig,更安全。
  • Q:Helm 与 Kustomize 怎么选? A:Helm 适合参数化复用、依赖管理;Kustomize 适合无模板的 overlay 差异管理。

08.6.1-002 Chart 的目录结构是怎样的?

一句话结论

标准 Chart 包含 Chart.yaml(元数据)、values.yaml(默认值)、templates/(模板目录)、charts/(子 Chart)、可选的 notes.txt 与 _helpers.tpl。

概念解释

  • Chart.yaml:Chart 名、版本、描述。
  • values.yaml:默认参数。
  • templates/:K8s 资源模板。
  • charts/:子 Chart 依赖。
  • templates/_helpers.tpl:可复用模板片段。
  • templates/NOTES.txt:安装后提示信息。

原理流程

  1. helm 读取 Chart.yaml 与 values.yaml。
  2. 遍历 templates/ 渲染所有 .yaml 文件。
  3. 合并子 Chart 的模板。
  4. 输出最终 K8s 资源清单。

代码 / 示例

mychart/
  Chart.yaml
  values.yaml
  charts/
  templates/
    deployment.yaml
    service.yaml
    _helpers.tpl
    NOTES.txt

常见误区

  • 误区:templates 下所有文件都会渲染;正解:以下划线开头的文件(如 _helpers.tpl)是模板片段,不直接渲染为 K8s 资源。
  • 误区:Chart.yaml 与 values.yaml 必须同名;正解:文件名固定,位置固定。

追问

  • Q:templates/tests/ 是什么? A:存放 helm test 用的测试 Pod,helm test 时执行。
  • Q:Chart 版本与 appVersion 区别? A:Chart 版本是 Chart 本身的版本,appVersion 是打包的应用版本。

08.6.1-003 values.yaml 如何在模板中使用?

一句话结论

模板中用 .Values.xxx 引用 values.yaml 的值,用户可通过 --set、-f values-prod.yaml、--set-file 覆盖默认值,优先级从高到低:--set > -f 多文件 > values.yaml。

概念解释

  • .Values:访问 values.yaml 的对象。
  • .Release:release 元数据(Name、Namespace、Revision)。
  • .Chart:Chart.yaml 元数据。
  • .Files:访问 Chart 内文件。
  • .Capabilities:集群版本与 API 能力。

原理流程

  1. helm 合并默认 values 与用户覆盖值。
  2. 模板渲染时 .Values 指向合并后的值。
  3. 用户传 -f 时,后传的文件覆盖前面的同名键。

代码 / 示例

# values.yaml
replicaCount: 3
image:
  repository: nginx
  tag: "1.25"
# templates/deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ .Release.Name }}
spec:
  replicas: {{ .Values.replicaCount }}
  template:
    spec:
      containers:
        - name: app
          image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
helm install myapp ./mychart -f values-prod.yaml --set replicaCount=5

常见误区

  • 误区:--set 可以覆盖嵌套值;正解:--set image.tag=1.26 可以覆盖嵌套,但复杂结构用 -f 文件更清晰。
  • 误区:values.yaml 里的敏感值会加密;正解:Helm 不加密 values,敏感值应外接 Secret 管理。

追问

  • Q:如何在模板里引用 subchart 的 values? A:.Values.subchart_name.key,subchart 的 values 放在顶层命名空间下。
  • Q:如何设置默认值? A:{{ .Values.foo | default "bar" }}。

08.6.1-004 Helm 模板函数与管道怎么用?

一句话结论

Helm 模板用 Go template 语法,函数通过管道 | 串联,如 {{ .Values.name | default "app" | upper | quote }},常用函数有 default、quote、include、toYaml、b64enc。

概念解释

  • 管道:{{ value | func1 | func2 }},前一个输出作为后一个输入。
  • default:设置默认值。
  • quote:加双引号。
  • toYaml:把对象转成 Yaml 块。
  • b64enc:Base64 编码(用于 Secret)。
  • include:引入 _helpers.tpl 中的命名模板。

原理流程

  1. 模板引擎解析 {{ ... }}。
  2. 按管道顺序执行函数。
  3. 输出替换到模板位置。

代码 / 示例

# templates/_helpers.tpl
{{- define "app.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end -}}

# templates/deployment.yaml
metadata:
  name: {{ include "app.name" . }}
  labels:
    {{- toYaml .Values.labels | nindent 4 }}

常见误区

  • 误区:{{ ... }} 与 {{- ... -}} 一样;正解:{{- 去掉前导空白,-}} 去掉尾部换行,避免渲染出空行。
  • 误区:include 与 template 一样;正解:include 可以被管道函数处理,template 不能,优先用 include。

追问

  • Q:如何循环? A:{{- range .Values.items }},配合 {{ . }} 访问当前元素。
  • Q:toYaml 配合 nindent 做什么? A:把 map 渲染成 Yaml 块并缩进 N 个空格。

08.6.1-005 Helm 的条件与循环怎么写?

一句话结论

条件用 {{ if }}、{{ else if }}、{{ else }},循环用 {{ range }};条件支持 eq、ne、and、or、not。

概念解释

  • if/else:条件分支。
  • range:遍历数组或 map。
  • with:改变当前作用域(.)。
  • eq/ne/lt/gt:比较运算符。

原理流程

  1. 模板按条件渲染对应块。
  2. range 遍历数组,每个元素渲染一次。
  3. with 把当前作用域设为指定对象,内部直接用 .。

代码 / 示例

{{- if .Values.ingress.enabled }}
apiVersion: networking.k8s.io/v1
kind: Ingress
...
{{- end }}

{{- range .Values.ingress.hosts }}
- host: {{ .host }}
  http:
    paths:
      {{- range .paths }}
      - path: {{ .path }}
      {{- end }}
{{- end }}

常见误区

  • 误区:range 内不能访问外层 values;正解:range 内 . 是当前元素,外层用 $.Values 访问根作用域。
  • 误区:if 里可以直接写布尔表达式;正解:用 {{ if eq .Values.replicas 3 }},不能写 {{ if .Values.replicas == 3 }}。

追问

  • Q:with 怎么用? A:{{- with .Values.env }} 进入块后 . 指向 env,省去重复写 .Values.env。
  • Q:如何在 range 里拿到索引? A:{{ range $i, $v := .Values.items }},$i 是索引。

08.6.1-006 Helm 依赖(subchart)怎么管理?

一句话结论

在 Chart.yaml 的 dependencies 字段声明子 Chart,Helm 自动下载到 charts/ 目录;子 Chart 有自己的 values 命名空间,父 Chart 可通过顶层 values 覆盖子 Chart 参数。

概念解释

  • dependencies:在 Chart.yaml 声明子 Chart 名、版本、仓库。
  • charts/:子 Chart 目录,helm dependency update 自动下载。
  • values 命名空间:子 Chart 的 values 在父 Chart 里以子 Chart 名为 key。

原理流程

  1. helm dependency update 按 Chart.yaml 下载子 Chart 到 charts/。
  2. 渲染时父 Chart 与子 Chart 模板合并。
  3. 子 Chart 的 values 从父 Chart values 中按命名空间读取。

代码 / 示例

# Chart.yaml
dependencies:
  - name: postgresql
    version: "13.0.0"
    repository: "https://charts.bitnami.com/bitnami"
helm dependency update
helm dependency build

常见误区

  • 误区:子 Chart 的 values 直接合并到顶层;正解:子 Chart 的 values 在父 Chart 里必须放在子 Chart 名对应的 key 下,如 postgresql.enabled: true。
  • 误区:子 Chart 可以覆盖父 Chart 的同名资源;正解:Helm 以资源名+命名空间为 key,同名资源会冲突,应避免。

追问

  • Q:如何停用子 Chart? A:在父 Chart values 里设 subchart_name.enabled: false。
  • Q:本地子 Chart 怎么引用? A:在 dependencies 里写 repository: "file://../my-subchart"。

08.6.1-007 Helm 生命周期钩子(hooks)有哪些?

一句话结论

Helm hook 通过注解 helm.sh/hook 标记,在 install/upgrade/rollback/delete 的特定阶段执行 Job 或 Pod,常见有 pre-install、post-install、pre-delete、post-delete、pre-upgrade、post-upgrade、crd-install。

概念解释

  • pre-install:install 前执行。
  • post-install:install 后执行。
  • pre-delete:delete 前执行。
  • pre-upgrade:upgrade 前执行。
  • post-upgrade:upgrade 后执行。
  • hook-delete-policy:hook 执行后何时删除(before-hook-creation/hook-succeeded/hook-failed)。

原理流程

  1. helm install 时先渲染所有资源。
  2. 带 hook 注解的资源按阶段顺序执行。
  3. 等 hook 成功后再执行主流程(如 apply 主资源)。

代码 / 示例

apiVersion: batch/v1
kind: Job
metadata:
  name: {{ .Release.Name }}-migrate
  annotations:
    "helm.sh/hook": pre-upgrade,post-install
    "helm.sh/hook-delete-policy": before-hook-creation,hook-succeeded
spec:
  template:
    spec:
      containers:
        - name: migrate
          image: {{ .Values.image }}
          command: ["./migrate"]
      restartPolicy: OnFailure

常见误区

  • 误区:hook 失败不影响 release;正解:默认 hook 失败会阻塞 release 流程,必须等 hook 成功。
  • 误区:hook Job 会一直存在;正解:按 hook-delete-policy 自动清理,默认不清理时会堆积。

追问

  • Q:数据库迁移用什么 hook? A:pre-upgrade(升级前先迁移 schema)或 post-install,用 Job 跑迁移脚本。
  • Q:hook 超时怎么办? A:设 activeDeadlineSeconds,避免 hook 卡住整个 release。

08.6.1-008 如何调试 Helm 模板渲染?

一句话结论

用 helm template 渲染不应用到集群,用 helm install --dry-run --debug 模拟安装,用 helm get values 看实际生效的值。

概念解释

  • helm template:本地渲染输出 YAML,不连集群。
  • --dry-run:模拟 install/upgrade,不实际 apply。
  • --debug:输出详细日志。
  • helm get manifest:查看已安装 release 的渲染结果。

原理流程

  1. 写好 Chart 与 values。
  2. helm template ./mychart -f values.yaml 看渲染结果。
  3. helm install --dry-run --debug 模拟完整流程。
  4. 发现错误后修模板,重复验证。

代码 / 示例

helm template myapp ./mychart -f values-prod.yaml
helm install myapp ./mychart --dry-run --debug -f values-prod.yaml
helm get manifest myapp
helm get values myapp

常见误区

  • 误区:helm template 不连集群就能发现所有问题;正解:template 不会校验 K8s API 版本是否存在、资源是否合法,dry-run 也不会真正 apply,最终还是要在集群里验证。
  • 误区:渲染错误就是模板语法错误;正解:也可能是 values 类型不对(如字符串写成数字)。

追问

  • Q:如何只看某个模板的渲染结果? A:helm template 输出全部,可 grep 关键字段。
  • Q:如何验证 Chart 格式? A:helm lint ./mychart 检查 Chart 结构与模板语法。

08.6.1-009 Helm 中如何避免敏感信息写在 values?

一句话结论

不要把密码、Token 直接写在 values.yaml;用 K8s Secret 外接(如 External Secrets Operator、Vault、Sealed Secrets),Helm 只引用 Secret 名,不存明文。

概念解释

  • 反模式:values.yaml 写 password,提交到 Git。
  • 正确做法:values 只写 Secret 引用名,Secret 由专门的密钥管理系统生成。
  • Sealed Secrets:把 Secret 加密成 SealedSecret,可安全提交 Git。
  • External Secrets Operator:从 Vault/云 KMS 同步到 K8s Secret。

原理流程

  1. 用户在 Vault 或云 KMS 存真实密码。
  2. External Secrets Operator 同步为 K8s Secret。
  3. Helm Chart 的 Deployment 引用 Secret 名,不写明文。

代码 / 示例

# values.yaml 不写明文
db:
  secretName: myapp-db-secret

# templates/deployment.yaml
env:
  - name: DB_PASSWORD
    valueFrom:
      secretKeyRef:
        name: {{ .Values.db.secretName }}
        key: password

常见误区

  • 误区:Helm 把 Secret 加密存储;正解:Helm release 存在 Secret 里,但 values 本身不加密,明文密码会进入 release 记录。
  • 误区:用 --set password=xxx 就安全;正解:--set 会出现在 shell history 与 helm list 记录里,不安全。

追问

  • Q:Sealed Secrets 怎么工作? A:用集群公钥加密,只有集群 controller 能解密,SealedSecret 可安全提交 Git。
  • Q:Helm 与 Vault 怎么集成? A:External Secrets Operator 或 Vault Agent Injector,注入 Sidecar 从 Vault 拉取密钥。

08.6.1-010 Helm 的 upgrade 与 rollback 机制?

一句话结论

helm upgrade 渲染新 Chart 并 apply,记录新 revision;helm rollback 把资源恢复到指定 revision 的渲染结果,revision 历史存在 Secret 里。

概念解释

  • revision:每次 install/upgrade/rollback 都生成一个新版本号。
  • 历史:存在 Secret(默认)或 ConfigMap(Helm 2)里。
  • rollback:按指定 revision 重新 apply 当时的渲染清单。
  • max-history:保留最近 N 个 revision。

原理流程

  1. helm upgrade:渲染新清单,apply 到集群,记录 revision。
  2. 发现问题:helm rollback 。
  3. helm 按旧 revision 清单重新 apply。

代码 / 示例

helm upgrade myapp ./mychart -f values-prod.yaml
helm history myapp
helm rollback myapp 2

常见误区

  • 误区:rollback 会回退数据库;正解:rollback 只回退 K8s 资源,数据库迁移需要单独处理(expand-contract)。
  • 误区:rollback 是秒级;正解:rollback 重新 apply 资源,Pod 重启需要时间,分钟级。

追问

  • Q:如何设置保留历史? A:helm install --history-max 10,避免 Secret 堆积。
  • Q:helm uninstall 会删除资源吗? A:默认删除所有 release 管理的资源,但带 hook 的资源按 hook-delete-policy 清理;PV/PVC 默认保留。

待整理清单

  • [ ] Helm Chart 仓库(ChartMuseum/OCI)
  • [ ] Helm 与 ArgoCD 集成
  • [ ] helm unittest 与 helm chart-testing
  • [ ] HPA/PDB/NetworkPolicy 模板化实践