如何用Kustomize给Deployment和CronJob添加相同Sidecar容器

一、避免重复编写Sidecar配置 #

方法1：用Kustomize Component封装可复用Sidecar #

创建独立的Component目录统一管理Sidecar配置，让Deployment和CronJob直接引用：

1. 新建组件目录及配置文件：

# components/sidecar-demo/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1alpha1
kind: Component
patches:
- target:
    kind: Deployment
    version: v1
  patch: |-
    - op: add
      path: /spec/template/spec/containers/-
      value:
        name: shared-sidecar
        image: your-sidecar-image:v1
        env:
        - name: SIDECAR_ENV
          value: "prod"
        volumeMounts:
        - name: shared-vol
          mountPath: /data
- target:
    kind: CronJob
    version: v1
  patch: |-
    - op: add
      path: /spec/jobTemplate/spec/template/spec/containers/-
      value:
        name: shared-sidecar
        image: your-sidecar-image:v1
        env:
        - name: SIDECAR_ENV
          value: "prod"
        volumeMounts:
        - name: shared-vol
          mountPath: /data

2. 在Deployment和CronJob的Kustomize配置中引用组件：

# deployment/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- your-deployment.yaml
components:
- ../components/sidecar-demo

# cronjob/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- your-cronjob.yaml
components:
- ../components/sidecar-demo

方法2：YAML锚点复用（单文件场景） #

如果Deployment和CronJob在同一YAML文件中，直接用YAML锚点复用配置：

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app-deploy
spec:
  template:
    spec:
      containers:
      - name: app-main
        image: app-image:v1
      - &shared-sidecar
        name: shared-sidecar
        image: your-sidecar-image:v1
        env:
        - name: SIDECAR_ENV
          value: "prod"
---
apiVersion: batch/v1
kind: CronJob
metadata:
  name: app-cron
spec:
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: cron-main
            image: cron-image:v1
          - *shared-sidecar

二、将Sidecar追加到容器列表尾部 #

核心是JSON Patch的路径写法：在容器数组路径末尾加-，表示将元素追加到数组最后，而非插入到头部。

示例Patch片段：

- op: add
  path: /spec/template/spec/containers/-  # 末尾的-是关键，指定追加到尾部
  value:
    name: shared-sidecar
    image: your-sidecar-image:v1
    # 其他Sidecar配置...

针对CronJob的路径则为：

path: /spec/jobTemplate/spec/template/spec/containers/-

补充：Helm模板场景的复用方案 #

如果用Helm管理资源，可将Sidecar抽为模板片段：

# templates/_sidecar.tpl
{{- define "shared.sidecar" -}}
- name: shared-sidecar
  image: {{ .Values.sidecar.image }}:{{ .Values.sidecar.tag }}
  env:
  - name: SIDECAR_ENV
    value: "{{ .Values.sidecar.env }}"
{{- end -}}

在Deployment和CronJob模板中引用：

# templates/deployment.yaml
spec:
  template:
    spec:
      containers:
      - name: app-main
        image: {{ .Values.app.image }}:{{ .Values.app.tag }}
      {{ include "shared.sidecar" . }}

# templates/cronjob.yaml
spec:
  jobTemplate:
    spec:
      template:
        spec:
          containers:
          - name: cron-main
            image: {{ .Values.cron.image }}:{{ .Values.cron.tag }}
          {{ include "shared.sidecar" . }}

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