hjacobs/kube-janitor

kube-janitor Docker镜像文档

概述

kube-janitor是一个用于自动清理Kubernetes资源的工具，它能够根据预设的TTL（生存时间）配置，自动识别并删除过期的Kubernetes资源，帮助维护集群整洁，避免资源堆积和浪费。

核心功能与特性

• TTL驱动的清理机制：基于资源上设置的TTL注解或全局配置，自动计算资源的过期时间并执行删除操作
• 多资源类型支持：支持Deployment、StatefulSet、DaemonSet、Pod、ConfigMap、Secret等多种Kubernetes资源类型
• 灵活的配置方式：可通过资源注解（如janitor/ttl）或全局配置文件定义TTL规则
• 命名空间过滤：支持按命名空间过滤需要清理的资源，可配置包含或排除特定命名空间
• 干运行模式：支持干运行（dry-run）模式，仅输出清理计划而不实际执行删除操作，便于测试和验证

使用场景

• 清理临时测试环境中创建的资源
• 自动删除不再需要的调试或演示资源
• 管理短期运行的任务型资源（如Job）的生命周期
• 防止集群中闲置资源长期占用资源

使用方法

基本部署（Docker Run）

bash
docker run -d \
  --name kube-janitor \
  -v ~/.kube/config:/root/.kube/config \
  hjacobs/kube-janitor:latest \
  --interval=30m \
  --dry-run=false

Kubernetes部署（推荐）

创建部署清单文件kube-janitor-deployment.yaml：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: kube-janitor
  namespace: kube-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: kube-janitor
  template:
    metadata:
      labels:
        app: kube-janitor
    spec:
      serviceAccountName: kube-janitor
      containers:
      - name: kube-janitor
        image: hjacobs/kube-janitor:latest
        args:
        - --interval=30m
        - --namespace=default,dev
        - --exclude-namespace=kube-system
        - --dry-run=false

创建服务账户和权限（RBAC配置）：

yaml
apiVersion: v1
kind: ServiceAccount
metadata:
  name: kube-janitor
  namespace: kube-system
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: kube-janitor
rules:
- apiGroups: ["*"]
  resources: ["*"]
  verbs: ["get", "list", "delete"]
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: kube-janitor
subjects:
- kind: ServiceAccount
  name: kube-janitor
  namespace: kube-system
roleRef:
  kind: ClusterRole
  name: kube-janitor
  apiGroup: rbac.authorization.k8s.io

应用部署：

bash
kubectl apply -f kube-janitor-deployment.yaml

配置说明

命令行参数

资源注解配置

在需要清理的Kubernetes资源上添加以下注解：

• janitor/ttl: 设置资源的生存时间（如24h表示24小时，7d表示7天）
• janitor/ignore: 设置为true可排除该资源不被清理

示例（为Deployment添加TTL注解）：

yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: test-deployment
  annotations:
    janitor/ttl: "48h"  # 48小时后自动清理
spec:
  replicas: 1
  template:
    spec:
      containers:
      - name: nginx
        image: nginx:latest

全局配置文件

通过--config参数指定配置文件，可定义全局TTL规则，示例：

yaml
rules:
- resources: ["Deployment", "StatefulSet"]
  ttl: "7d"
  namespaces: ["dev", "test"]
- resources: ["Pod"]
  ttl: "24h"
  annotations:
    "app": "temp"