meltwater/docker-cleanup

Docker Cleanup镜像说明

镜像概述

本镜像用于定期清理Docker环境中退出的容器、未被运行中容器使用的镜像及卷。基于https://github.com/tutumcloud/image-cleanup%E5%92%8Chttps://github.com/chadoe/docker-cleanup-volumes%E9%A1%B9%E7%9B%AE%E4%BF%AE%E6%94%B9%EF%BC%8C%E4%BF%AE%E5%A4%8D%E4%BA%86%E9%83%A8%E5%88%86%E5%B0%8F%E9%97%AE%E9%A2%98%E3%80%82

警告：该脚本会删除所有退出的容器、仅数据容器及未使用的镜像（除非手动排除）。若将/var/lib/docker挂载到容器内，会清理所有未使用的卷，若与系统或Docker版本不兼容，可能会删除运行中容器的卷，请谨慎使用。

核心功能

1. 定期清理退出的容器
2. 移除未被运行中容器使用的镜像
3. 清理未使用的卷（需挂载/var/lib/docker）
4. 支持自定义保留规则（指定不清理的镜像、容器）
5. 可配置清理周期和延迟时间

使用场景

• 集群节点：处理大量容器启停产生的冗余资源
• Jenkins构建slave：清理持续构建生成的SNAPSHOT镜像及未使用的容器
• 本地开发环境：定期释放磁盘空间，避免资源堆积

配置说明

通过docker run -e设置环境变量可覆盖默认参数：

• CLEAN_PERIOD=1800：清理周期（秒），默认30分钟
• DELAY_TIME=1800：清理前等待时间（秒），默认30分钟
• KEEP_IMAGES：不清理的镜像列表，如"ubuntu:trusty,ubuntu:latest"
• KEEP_CONTAINERS：不清理的退出/停止容器对应的镜像列表
• KEEP_CONTAINERS_NAMED：不清理的退出/停止容器名称列表
• LOOP=true：是否循环执行清理（true/false），默认true
• DEBUG=0：是否开启调试输出（1为开启）
• DOCKER_API_VERSION=1.20：Docker API版本，可根据主机版本调整

注意：KEEP_IMAGES、KEEP_CONTAINERS、KEEP_CONTAINERS_NAMED使用bash shell前缀匹配（非正则），如需保留所有镜像，可设置为*:*。

部署示例

命令行部署

bash
docker run \
  -v /var/run/docker.sock:/var/run/docker.sock:rw \
  -v /var/lib/docker:/var/lib/docker:rw \
  meltwater/docker-cleanup:latest

Systemd配置（适用于CoreOS/Fleet）

创建/etc/systemd/system/docker-cleanup.service文件：

ini
[Unit]
Description=清理退出容器及未使用镜像/卷
After=docker.service
Requires=docker.service

[Install]
WantedBy=multi-user.target

[Service]
Environment=IMAGE=meltwater/docker-cleanup:latest NAME=docker-cleanup
TimeoutStartSec=600
KillMode=none
Restart=always
RestartSec=15

ExecStartPre=-/usr/bin/docker kill $NAME
ExecStartPre=-/usr/bin/docker rm $NAME
ExecStartPre=-/bin/sh -c 'if ! docker images | tr -s " " : | grep "^${IMAGE}:"; then docker pull "${IMAGE}"; fi'
ExecStart=/usr/bin/docker run \
    -v /var/run/docker.sock:/var/run/docker.sock:rw \
    -v /var/lib/docker:/var/lib/docker:rw \
    --name=${NAME} \
    $IMAGE

ExecStop=/usr/bin/docker stop $NAME

[X-Fleet]
Global=true

Puppet Hiera配置（使用garethr-docker模块）

yaml
classes:
  - docker::run_instance

docker::run_instance:
  'cleanup':
    image: 'meltwater/docker-cleanup:latest'
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:rw"
      - "/var/lib/docker:/var/lib/docker:rw"

Kubernetes部署（DaemonSet）

bash
kubectl create -f contrib/k8s-daemonset.yml