如何定义values.yaml配置项以强制用户安装Helm chart时覆写

核心实现逻辑 #

通过Helm内置的校验函数配合values.yaml的占位声明实现，不给必填项设置默认值，在模板渲染阶段校验配置是否传入，未传入则直接终止安装流程。

具体操作步骤 #

1. 在values.yaml中声明必填项 #

不要给必填项设置有效默认值，可设为null或者标注明确的占位标识，同时加注释说明是必填项：

# values.yaml 示例
# 【必填】数据库连接密码，安装时必须自定义传入
dbPassword: null
# 【必填】外部服务调用地址，安装时必须自定义传入
externalServiceUrl: "REQUIRED"

2. 模板中增加校验逻辑 #

有两种常用的校验方式，可按需选择：

方式1：使用required函数（单值校验）

直接在引用该配置的模板位置用required函数包裹，传入自定义错误提示：

# templates/db-secret.yaml 示例
apiVersion: v1
kind: Secret
metadata:
  name: db-secret
type: Opaque
data:
  password: {{ required "配置项 dbPassword 为必填项，请在安装时通过 --set dbPassword=xxx 或自定义values文件传入" .Values.dbPassword | b64enc }}

当用户未传入该配置时，Helm会直接抛出上述错误信息，终止安装。

方式2：统一批量校验（多值集中校验）

如果有多个必填项，可在templates目录下新建专门的校验文件check-required-values.yaml，统一做前置校验，该文件不会生成实际的Kubernetes资源，只会执行校验逻辑：

# templates/check-required-values.yaml 示例
{{- if not .Values.dbPassword }}
{{- fail "缺少必填配置项：dbPassword，安装时必须传入" }}
{{- end }}
{{- if not .Values.externalServiceUrl }}
{{- fail "缺少必填配置项：externalServiceUrl，安装时必须传入" }}
{{- end }}

注意事项 #

• 不要给必填项设置空字符串等默认值，否则会绕过校验逻辑
• 错误提示建议明确说明配置传入方式，降低使用者的理解成本
• 可在values.yaml的必填项处增加清晰的注释说明，方便使用者快速识别必填配置

内容的提问来源于stack exchange，提问作者Fritz Duchardt