otherguy/k8s-controller-sidecars

Kubernetes自定义控制器 - Sidecar关闭

概述

这是一个自定义Kubernetes控制器，用于监控运行中的Pod，当"主"应用容器退出且仅Sidecar容器未终止时，向Sidecar容器发送SIGTERM信号以终止它们。该控制器最初从https://github.com/nrmitchi/k8s-controller-sidecars分叉而来，旨在解决Kubernetes的https://github.com/kubernetes/kubernetes/issues/25908中描述的Sidecar容器无法随主容器退出而自动关闭的问题。

核心功能

• 监控Kubernetes集群中的Pod状态，追踪容器运行情况
• 通过Pod注解识别指定的Sidecar容器名称
• 检测主应用容器是否已退出
• 当主容器退出且仅Sidecar容器未终止时，向Sidecar容器发送SIGTERM信号以优雅终止

使用场景

适用于Kubernetes环境中包含Sidecar容器的Pod，特别是以下场景：

• CronJob或Job类型的工作负载，主容器完成任务后需要关闭Sidecar容器（如日志收集、监控代理等）
• 任何需要在主应用容器结束后清理Sidecar容器的场景，避免Sidecar容器长时间运行占用资源

使用方法

1. 部署控制器

将控制器部署到Kubernetes集群中：

sh
kubectl apply -f manifest.yml

2. 配置Pod注解

在Pod的元数据中添加otherguy.io/sidecars注解，值为逗号分隔的Sidecar容器名称列表。

示例

以下是一个包含Sidecar容器的CronJob示例，注解指定了名为logging的Sidecar容器：

yaml
---
apiVersion: batch/v1beta1
kind: CronJob
metadata:
  name: test-job
spec:
  schedule: "* * * * *"
  jobTemplate:
    spec:
      template:
        metadata:
          annotations:
            otherguy.io/sidecars: logging
        spec:
          restartPolicy: Never
          containers:
            - name: test-job
              image: docker.xuanyuan.run/ubuntu:latest
              command: ["sleep", "5"]
            - name: logging
              image: docker.xuanyuan.run/fluentd

在上述示例中，test-job为主应用容器，运行5秒后退出；logging为Sidecar容器。控制器将监控到主容器退出后，向logging容器发送SIGTERM信号，使其终止。