projectsveltos/k8s-cleaner

Cleaner：Kubernetes资源清理控制器

概述

Cleaner是一款专为Kubernetes集群设计的控制器工具，核心功能是识别并处理集群中未使用或不健康的资源，从而帮助用户维护精简、高效的Kubernetes集群环境，减少资源浪费并提升集群整体运行稳定性。

核心功能和特性

• 资源识别：精准识别集群中未使用（如闲置Pod、过期ConfigMap）或不健康（如异常状态的Deployment、Node）的资源。
• 灵活调度：支持自定义Cron调度策略，可根据业务需求配置资源检查和处理的执行频率。
• 标签过滤：通过资源标签进行筛选，仅对符合标签规则的资源执行检查和操作，提高处理精度。
• Lua自定义规则：提供基于Lua脚本的选择条件定义，支持复杂业务场景下的资源识别逻辑。
• 资源处理能力：支持对识别出的资源执行删除或更新操作，实现自动化资源治理。
• 多渠道通知：集成Slack、Webex和***通知机制，实时反馈资源处理结果和集群状态。
• 集群操作自动化：支持自动化执行集群运维操作，降低人工干预成本。

使用场景和适用范围

• 集群资源优化：适用于需要定期清理无效资源的Kubernetes集群，解决资源利用率低的问题。
• 集群健康管理：可作为集群监控的补充工具，及时发现并处理不健康资源，保障服务稳定性。
• 自动化运维：适合DevOps团队或集群管理员，通过自动化资源治理简化日常运维流程。
• 成本控制：通过清理闲置资源，降低集群基础设施成本（如云资源费用）。

使用方法和配置说明

部署方式

Docker Run 基础示例

bash
docker run -d \
  --name cleaner \
  --restart=always \
  -e KUBECONFIG=/etc/kubeconfig \
  -e SCHEDULE="0 2 * * *" \  # 每日凌晨2点执行检查
  -e LABEL_FILTER="env=dev,app=temp" \  # 仅处理标签为env=dev且app=temp的资源
  -e NOTIFICATION_SLACK_WEBHOOK="https://hooks.slack.com/services/XXX/XXX/XXX" \  # Slack通知Webhook
  -v /path/to/your/kubeconfig:/etc/kubeconfig \  # 挂载Kubernetes配置文件
  -v /path/to/lua/scripts:/scripts \  # 挂载Lua规则脚本（如需）
  cleaner:latest

关键配置参数

资源处理策略配置

通过配置文件（如config.yaml）定义资源处理规则，示例：

yaml
resources:
  - type: "Pod"
    unusedThreshold: "72h"  # 闲置超过72小时的Pod将被处理
    action: "delete"  # 执行删除操作
  - type: "ConfigMap"
    unusedThreshold: "30d"  # 闲置超过30天的ConfigMap将被处理
    action: "archive"  # 执行归档操作（需额外配置归档存储）

注意事项

• 确保挂载的Kubernetes配置文件具有足够权限（如资源查看、删除权限）。
• 首次使用建议先以dry-run模式运行（添加-e DRY_RUN=true），验证规则有效性后再执行实际操作。
• Lua脚本需遵循Cleaner定义的输入输出规范，具体可参考官方文档的脚本模板。