Helm模板中如何合并值到指定位置？优化Deployment标签配置

当前问题 #

在开发Helm Deployment模板时，如果完全通过values.yaml控制配置，通常会写出这样的模板：

kind: Deployment
apiVersion: apps/v1
metadata:
{{ toYaml .Values.deployment.metadata | indent 2 }}
spec:
{{ toYaml .Values.deployment.spec | indent 2 }}

对应的values.yaml需要重复配置标签三次：

deployment:
  metadata:
    labels:
      appName: foo
  spec:
    selector: 
      matchLabels:
        appName: foo
    template:
      metadata:
        labels:
          appName: foo
      spec:
        <template spec goes in here, e.g. containers, etc>

标签需要在metadata.labels、spec.selector.matchLabels、spec.template.metadata.labels三处重复定义，冗余且容易出错。

需求目标 #

希望在values.yaml中仅定义一次标签，由模板自动将标签注入上述三个位置，同时保留values中其他配置（如spec.replicas、strategy等）的完整性，无需在模板中显式引用这些字段。

期望的values.yaml示例：

deployment:
  name: myDeployment
  labels:
    appName: myDeployment
    otherLabel: foo
  annotations: 
    some.annotation: gets-added-to-metadata-annotations
  spec:
    replicas: 2
    strategy: 
      type: Recreate
    template: 
      spec:
        affinity:
          <affinity settings goes here>
        containers:
           <container spec goes here>

解决方案 #

利用Helm的mergeOverwrite函数，先构建一个包含标签自动注入的基础Deployment结构，再将values中的配置合并进去，实现标签自动填充+其他配置保留的效果。

最终模板代码 #

{{- $baseDeployment := dict
  "kind" "Deployment"
  "apiVersion" "apps/v1"
  "metadata" (dict
    "name" .Values.deployment.name
    "labels" .Values.deployment.labels
    "annotations" .Values.deployment.annotations
  )
  "spec" (dict
    "selector" (dict "matchLabels" .Values.deployment.labels)
    "template" (dict
      "metadata" (dict "labels" .Values.deployment.labels)
      "spec" .Values.deployment.spec.template.spec
    )
  )
-}}
{{- $finalDeployment := mergeOverwrite $baseDeployment .Values.deployment -}}
{{ toYaml $finalDeployment | nindent 0 }}

说明 #

1. 先定义$baseDeployment基础结构：将.Values.deployment.labels自动填充到三个必须的标签位置，同时引入values中的name、annotations以及template.spec配置。
2. 通过mergeOverwrite将.Values.deployment的内容合并到基础结构：values中额外的配置（如spec.replicas、strategy）会自动覆盖或补充到基础结构中，无需在模板中逐个声明。
3. 如果values中对某个标签位置有额外配置（比如在metadata.labels中添加更多标签），mergeOverwrite会自动合并这些配置，不会覆盖原有标签。

这样既实现了标签的一次定义自动复用，又保留了values.yaml对Deployment其他配置的完全控制，无需重复代码。

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