kube-cleanup-operator 镜像文档

镜像概述

kube-cleanup-operator 是一个专为 Kubernetes 集群设计的自动化资源清理操作器（Operator）。它通过持续监控集群资源，识别并自动删除不再需要的对象（如完成的 Job、过期的 Pod、闲置的 PVC 等），旨在减少手动维护成本，防止资源泄露，提升集群资源利用率。该镜像源自 quay.io/lwolf/kube-cleanup-operator 仓库，适用于需要自动化集群资源管理的各类 Kubernetes 环境。

核心功能与特性

• 多资源类型支持：可清理多种 Kubernetes 资源，包括但不限于：
  • 已完成（Completed）或失败（Failed）的 Job
  • 超出存活时间的闲置 Pod
  • 长期未使用的 PersistentVolumeClaim（PVC）
  • 不再被引用的 ConfigMap 和 Secret
• 自定义清理策略：支持通过环境变量配置资源保留时间、排除特定命名空间或标签的资源。
• 自动化运行：部署后自动启动监控与清理流程，无需人工干预。
• 安全可控：基于 RBAC 权限模型，仅获取必要的资源操作权限，降低安全风险。

使用场景与适用范围

• 生产集群维护：自动清理批处理任务（如 CI/CD Job）完成后的残留资源，避免资源浪费。
• 开发/测试环境：清理临时测试产生的 Pod、PVC 等资源，保持集群环境整洁。
• 资源受限场景：在资源紧张的集群中，通过及时清理无效资源释放 CPU、内存和存储资源。

使用方法与配置说明

前提条件

• Kubernetes 集群（版本建议 1.16+，具体以镜像支持版本为准）
• kubectl 命令行工具已配置集群访问权限
• 集群管理员权限（用于部署 RBAC 规则和 Operator）

部署步骤

1. 获取部署配置文件

从项目***渠道（如 GitHub 仓库）获取部署清单，示例命令：

bash
# 假设***部署文件位于 GitHub 仓库
curl -O [***]

2. 配置清理策略（可选）

编辑下载的 deployment.yaml，通过环境变量调整清理规则，例如：

yaml
spec:
  template:
    spec:
      containers:
      - name: kube-cleanup-operator
        image: quay.io/lwolf/kube-cleanup-operator:latest
        env:
        - name: JOB_TTL
          value: "2h"  # Job 完成后保留 2 小时
        - name: POD_EXPIRY
          value: "12h" # Pod 存活超过 12 小时后清理
        - name: EXCLUDE_NAMESPACES
          value: "kube-system,default" # 排除 kube-system 和 default 命名空间

3. 部署到 Kubernetes 集群

bash
kubectl apply -f deployment.yaml

关键配置参数

以下为常用环境变量配置（通过 Deployment 的 env 字段设置）：

验证部署状态

1. 检查 Operator Pod 是否运行：

bash
kubectl get pods -n kube-cleanup-operator # 假设部署在 kube-cleanup-operator 命名空间

2. 查看清理日志：

bash
kubectl logs -l app=kube-cleanup-operator -n kube-cleanup-operator -f

注意事项

• 测试验证：首次部署建议先在测试集群验证，通过调整 LOG_LEVEL=debug 观察清理行为，避免误删关键资源。
• 权限配置：确保 Operator 的 ServiceAccount 拥有足够权限（如 get、list、delete 目标资源的权限）。
• 参数调优：根据集群实际资源使用情况调整 TTL 参数，避免过度清理影响正常业务。