coco/docker-gc

docker-gc（Coco分支）

镜像概述

docker-gc是一个简单的Docker容器和镜像垃圾清理工具，为spotify/docker-gc的Coco分支版本。它能自动清理不再需要的容器和镜像，有效释放磁盘空间，适用于本地Docker环境、Kubernetes集群及CI/CD场景。

核心功能

• 清理退出时间超过1小时的容器（可通过GRACE_PERIOD_SECONDS调整）
• 删除不再被任何容器引用的镜像
• 支持排除特定镜像（通过排除文件或EXCLUDE_FROM_GC变量）
• 支持排除特定容器（通过排除文件或EXCLUDE_CONTAINERS_FROM_GC变量）
• 可配置清理间隔（适用于Kubernetes DaemonSet场景）
• 支持dry run模式（仅模拟清理操作，不实际删除）
• 支持强制删除多标签镜像或错误容器（通过FORCE_IMAGE_REMOVAL/FORCE_CONTAINER_REMOVAL）

使用场景

1. 本地Docker环境：作为cron任务定期清理无用容器和镜像
2. Kubernetes集群：通过DaemonSet在所有节点上周期性执行清理
3. CI/CD环境：清理构建过程中产生的临时容器和镜像
4. 资源受限环境：自动释放磁盘空间，避免存储不足问题

配置说明

排除镜像

创建排除文件（默认路径/etc/docker-gc-exclude），每行填写镜像名称模式或ID，例如：

spotify/cassandra:latest
redis:.*
9681260c3ad5

也可通过EXCLUDE_FROM_GC指定自定义路径：

sh
EXCLUDE_FROM_GC=/path/to/custom/exclude/file docker-gc

排除容器

创建排除文件（默认路径/etc/docker-gc-exclude-containers），每行填写容器名称模式，例如：

mariadb-data
drunk_goodall

通过EXCLUDE_CONTAINERS_FROM_GC指定自定义路径：

sh
EXCLUDE_CONTAINERS_FROM_GC=/path/to/custom/container/exclude/file docker-gc

调整清理Grace Period

默认清理退出超过1小时的容器，可通过GRACE_PERIOD_SECONDS修改：

sh
GRACE_PERIOD_SECONDS=86400 docker-gc # 清理退出超过24小时的容器

Dry Run模式

仅模拟清理操作，不实际删除资源：

sh
DRY_RUN=1 docker-gc

强制删除

• 强制删除多标签镜像：FORCE_IMAGE_REMOVAL=1 docker-gc
• 强制删除错误容器：FORCE_CONTAINER_REMOVAL=1 docker-gc

部署示例

Docker容器运行

sh
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /etc:/etc:ro \
  docker.xuanyuan.run/coco/docker-gc

Kubernetes DaemonSet示例

yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
  name: docker-gc
  namespace: kube-system
spec:
  selector:
    matchLabels:
      app: docker-gc
  template:
    metadata:
      labels:
        app: docker-gc
    spec:
      containers:
      - name: docker-gc
        image: docker.xuanyuan.run/coco/docker-gc
        env:
        - name: TIME_BETWEEN_RUNS
          value: "1h" # 每小时运行一次
        volumeMounts:
        - name: docker-sock
          mountPath: /var/run/docker.sock
        - name: etc-volume
          mountPath: /etc:ro
      volumes:
      - name: docker-sock
        hostPath:
          path: /var/run/docker.sock
      - name: etc-volume
        hostPath:
          path: /etc

Cron任务配置

在Linux系统中，创建/etc/cron.hourly/docker-gc文件：

bash
#!/bin/bash
/usr/sbin/docker-gc

赋予执行权限：chmod +x /etc/cron.hourly/docker-gc