使用Helm时将K8s Deployment的annotations设为null是否会有异常？

将annotations: null提交给Kubernetes API服务器会直接导致请求失败，这属于无效的资源配置。

原因分析 #

Kubernetes规范中，metadata.annotations字段要求必须是键值对组成的map对象，null并非该字段的合法类型。当你提交包含annotations: null的Deployment时，API服务器会返回类型不匹配的错误，比如：

The Deployment "xxxx" is invalid: metadata.annotations: Invalid value: "null": expected map, got string

导致资源无法创建或更新。

模板修复方案 #

问题根源在于当.Values.podAnnotations未配置时，toYaml会将null值渲染为YAML的null。可以通过两种方式修复：

方式1：用with条件渲染（未配置时直接省略annotations字段）

{{- define "library-chart.deployment" -}}
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "library-chart.fullname" . }}
  annotations:
    {{- with .Values.podAnnotations }}
    {{- toYaml . | nindent 4 }}
    {{- end }}
  creationTimestamp: null
  labels:
    {{- include "library-chart.labels" . | nindent 4 }}
{{- end }}

方式2：设置默认空对象（未配置时渲染为annotations: {}）

{{- define "library-chart.deployment" -}}
apiVersion: apps/v1
kind: Deployment
metadata:
  name: {{ include "library-chart.fullname" . }}
  annotations:
    {{- toYaml (.Values.podAnnotations | default dict) | nindent 4 }}
  creationTimestamp: null
  labels:
    {{- include "library-chart.labels" . | nindent 4 }}
{{- end }}

两种方式生成的配置都是Kubernetes认可的合法格式，不会引发错误。

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