spotify/docker-gc

docker-gc

项目状态：inactive

Spotify已不再内部使用该项目。若您希望成为此项目的维护者，请创建issue并@提及官方团队。

概述

docker-gc是一个简单的Docker容器和镜像垃圾回收脚本，旨在清理无用资源以释放存储空间。它会移除退出超过一小时的容器、与剩余容器无关的镜像，还可选择清理未关联的卷（仅支持Docker >=1.9.0）。

核心功能

1. 容器清理：移除退出超一小时的容器。
2. 镜像清理：移除无关联容器的镜像，避免仅删除标签导致需重新拉取。
3. 卷清理：可选清理未关联容器的卷。
4. 排除规则：支持通过配置文件排除特定镜像、容器或卷。
5. 灵活配置：提供强制删除、保留最小镜像数、调整保留时长等选项。
6. 测试模式：Dry Run功能可验证操作不实际删除资源。

使用场景

• 定时维护：作为Cron任务定期清理Docker环境，释放存储空间。
• CI/CD环境：清理临时容器和镜像，避免空间耗尽影响构建。
• 开发环境：清理无用测试资源，保持环境整洁。

配置说明

排除规则

• 排除镜像：创建/etc/docker-gc-exclude（或通过EXCLUDE_FROM_GC指定路径），每行填写镜像名称模式/ID（如spotify/cassandra:latest）。
• 排除容器：创建/etc/docker-gc-exclude-containers（或EXCLUDE_CONTAINERS_FROM_GC），每行填写容器名称模式（如mariadb-data）。
• 排除卷：创建/etc/docker-gc-exclude-volumes（或EXCLUDE_VOLUMES_IDS_FILE），每行填写卷名称模式。

环境变量选项

• FORCE_IMAGE_REMOVAL=1：强制删除多标签关联的镜像。
• MINIMUM_IMAGES_TO_SAVE=N：保留每个仓库最新N个镜像（如MINIMUM_IMAGES_TO_SAVE=5）。
• FORCE_CONTAINER_REMOVAL=1：强制删除清理出错的容器。
• GRACE_PERIOD_SECONDS=86400：调整容器退出保留时长（如1天）。
• DRY_RUN=1：开启测试模式，仅输出日志不删除。
• REMOVE_VOLUMES=1：启用卷清理。
• VOLUME_DELETE_ONLY_DRIVER=driver_name：仅清理指定驱动的卷。

部署示例

Docker容器运行

需映射Docker socket和配置目录：

sh
# 基本清理
docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc:ro docker.xuanyuan.run/spotify/docker-gc

# 启用卷清理
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc -e REMOVE_VOLUMES=1 docker.xuanyuan.run/spotify/docker-gc

# 强制删除多标签镜像
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc -e FORCE_IMAGE_REMOVAL=1 docker.xuanyuan.run/spotify/docker-gc

# 测试模式
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc -e DRY_RUN=1 docker.xuanyuan.run/spotify/docker-gc

定时任务配置

安装Debian包后，创建/etc/cron.hourly/docker-gc：

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

赋予执行权限：sudo chmod +x /etc/cron.hourly/docker-gc，每小时自动运行。