如何创建可指定目标的Kustomize通用Sidecar组件

核心思路 #

把Sidecar的基础配置做成无目标绑定的通用组件/补丁，将「选择哪些Deployment注入」的逻辑完全放到环境Overlay中，既保证组件复用性，又能灵活适配不同环境的注入需求。

实现步骤 #

1. 定义通用Sidecar补丁（或组件） #

创建独立的Sidecar配置文件，只包含需要追加到Deployment的内容，不指定任何目标选择器：

方式A：通用补丁文件（轻量无组件依赖）

创建patches/sidecar-auth-proxy.yaml：

apiVersion: apps/v1
kind: Deployment
spec:
  template:
    spec:
      # 追加Sidecar容器
      containers:
      - name: auth-proxy
        image: auth-proxy:base # 基础镜像，由Overlay覆盖为环境专属版本
        ports:
        - containerPort: 8080
          name: proxy
        env:
        - name: UPSTREAM_SERVICE_PORT
          value: "8000" # 业务应用端口，可根据需求调整
        volumeMounts:
        - name: auth-config
          mountPath: /etc/auth-proxy
      # 追加Sidecar所需卷
      volumes:
      - name: auth-config
        configMap:
          name: auth-proxy-config # 配置名由Overlay定义为环境专属

方式B：可复用组件（适合复杂Sidecar配置）

如果Sidecar需要关联更多资源（比如ServiceAccount、Role），可以封装成Component：
创建components/sidecar-auth-proxy/kustomization.yaml：

patches:
- path: sidecar-patch.yaml
# 这里不写任何target配置，完全由Overlay决定作用范围

创建components/sidecar-auth-proxy/sidecar-patch.yaml，内容和上面的通用补丁一致。

2. 在环境Overlay中指定注入目标 #

在overlays/dev/kustomization.yaml中，通过target字段批量选择需要注入Sidecar的Deployment，同时引用通用补丁/组件：

resources:
- ../../base/deployments # 引入所有基础Deployment
- ../../base/services

# 引入通用Sidecar配置（如果用组件方式）
components:
- ../../components/sidecar-auth-proxy

# 批量给带特定标签的Deployment注入Sidecar
patches:
- path: ../../patches/sidecar-auth-proxy.yaml # 如果用补丁文件方式，替换为组件则不需要这行
  target:
    kind: Deployment
    labelSelector: "inject-sidecar=true" # 给需要注入的Deployment打这个标签

# 环境专属配置：覆盖Sidecar镜像、配置名
configMapGenerator:
- name: auth-proxy-config
  literals:
  - proxy-url=https://dev-auth.example.com
  - log-level=debug

images:
- name: auth-proxy:base
  newName: auth-proxy:dev-v3
  newTag: latest

3. 给目标Deployment打标签 #

在基础Deployment的metadata.labels中添加inject-sidecar=true，或者在Overlay中通过补丁给特定Deployment追加标签：

# overlays/dev/patch-add-sidecar-label.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: user-api
  labels:
    inject-sidecar: true

然后在overlays/dev/kustomization.yaml中添加这个补丁：

patches:
- path: patch-add-sidecar-label.yaml

关键优化点 #

• 解耦目标选择与Sidecar配置：组件/补丁只负责Sidecar的功能配置，目标选择完全由环境Overlay控制，组件可以在多个环境复用。
• 批量注入减少重复配置：通过标签批量匹配Deployment，避免逐个指定名称，维护更高效。
• 环境差异化适配：利用Kustomize的images、configMapGenerator功能，在Overlay中覆盖Sidecar的镜像、配置等参数，无需修改通用组件。
• 安全的增量更新：使用Strategic Merge Patch模式，只会给Deployment追加Sidecar容器和卷，不会覆盖原有业务应用的配置。

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