nzwalker/docker-gc

docker-gc镜像说明

镜像概述

本镜像为spotify/docker-gc的分支版本，包含修复优化。它是一个简单的Docker垃圾清理脚本，用于自动移除过期容器和未被使用的镜像，避免因误删导致镜像标签丢失或重复拉取问题，适用于Docker环境的日常维护。

核心功能

• 清理过期容器：删除退出超过1小时的容器（可通过环境变量调整优雅期）。
• 清理未用镜像：移除与任何剩余容器无关联的镜像，保留正在使用的镜像标签。
• 排除规则支持：通过配置文件或环境变量排除特定镜像、容器。
• 灵活配置：支持强制删除多标签镜像、保留最小镜像数、强制删除容器、dry run测试等功能。

使用场景

• 定时任务：作为cron小时级任务定期清理Docker垃圾。
• 手动执行：需要临时清理Docker环境时手动运行。
• CI环境：清理构建过程中产生的临时镜像和容器。
• 容器化运行：通过Docker容器方式执行清理操作，无需本地安装脚本。

配置说明

排除镜像

创建/etc/docker-gc-exclude文件（或通过EXCLUDE_FROM_GC指定路径），每行填写镜像名称模式或ID，例如：

spotify/cassandra:latest
redis:.*
9681260c3ad5

排除容器

创建/etc/docker-gc-exclude-containers文件（或通过EXCLUDE_CONTAINERS_FROM_GC指定路径），每行填写容器名称模式，例如：

mariadb-data
drunk_goodall

环境变量配置

• FORCE_IMAGE_REMOVAL=1：强制删除多标签镜像。
• MINIMUM_IMAGES_TO_SAVE=1：保留每个仓库最新的N个镜像（如N=10）。
• FORCE_CONTAINER_REMOVAL=1：强制删除清理失败的容器。
• GRACE_PERIOD_SECONDS=86400：调整容器/镜像保留的优雅期（默认3600秒）。
• DRY_RUN=1：仅测试清理操作，不实际删除。

Docker部署示例

构建镜像

sh
docker build -t nzwalker/docker-gc .

运行容器

sh
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc:ro nzwalker/docker-gc

（挂载docker.sock以访问Docker服务，挂载/etc以读取排除配置文件）

带配置运行

sh
docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /etc:/etc:ro \
  -e GRACE_PERIOD_SECONDS=86400 \
  -e DRY_RUN=1 \
  nzwalker/docker-gc