ninech/openshift-job-cleaner

ninech/openshift-job-cleaner 镜像说明

镜像概述

该镜像为OpenShift集群提供作业生命周期管理服务，可自动删除超过指定保留时间的作业（Job），支持灵活的命名空间过滤和状态差异化策略，帮助集群管理员高效维护资源秩序。

核心功能

• 按命名空间设置黑名单，排除无需清理的系统或业务命名空间
• 区分成功与失败作业的最大保留时间（单位：分钟）
• 通过CronJob实现定期自动执行清理任务
• 支持自定义配置文件路径及Kubernetes认证参数
• 可选集成Sentry日志监控系统

使用场景

• OpenShift集群管理员需要定期清理过期作业以释放CPU、内存等资源
• 针对不同业务命名空间设置差异化的作业保留策略
• 自动化管理作业生命周期，减少手动操作成本

配置说明

应用配置

通过YAML配置文件（默认路径：/opt/ocj/ocj.yml）设置以下参数：

• blacklist：无需清理的命名空间列表
• default：全局默认策略，包含success.max_age（成功作业保留时间）和failure.max_age（失败作业保留时间）
• 支持为特定命名空间设置单独的保留策略

示例配置参考：example config

容器配置

环境变量

• SENTRY_DSN：Sentry日志监控的DSN地址（可选）
• OJC_CONFIG_PATH：配置文件路径（默认：/opt/ocj/ocj.yml）
• KUBERNETES_*：Kubernetes集群连接参数（通常由OpenShift自动注入）

Secrets

容器需挂载以下Kubernetes ServiceAccount Secrets（OpenShift自动处理）：

• /var/run/secrets/kubernetes.io/serviceaccount/token：认证令牌
• /var/run/secrets/kubernetes.io/serviceaccount/ca.crt：证书授权文件

日志

使用logrus日志框架，默认集成Sentry监控，可通过修改main.go扩展其他日志系统。

部署示例

1. 创建项目与基础资源

bash
oc new-project cleaner
oc create -f openshift/openshift-job-cleaner.list.yml

该命令创建ServiceAccount、ConfigMap和CronJob资源。

2. 授予集群权限

为ServiceAccount赋予集群级编辑权限（结合黑名单排除无需访问的命名空间）：

bash
oc adm policy add-cluster-role-to-user edit system:serviceaccount:cleaner:openshift-job-cleaner

3. 一次性执行清理任务

bash
oc project cleaner
oc create -f openshift/openshift-job-cleaner.job.yml