trajano/periodic-prune

Docker Periodic Prune

镜像概述与主要用途

Docker Periodic Prune是一个用于定期清理Docker资源的容器，通过运行shell脚本自动执行Docker资源清理操作。它能够帮助用户自动释放因停止的容器、未使用的镜像而占用的磁盘空间，特别适用于本地开发和测试环境，避免手动清理的繁琐。

核心功能与特性

• 定期自动清理：脚本每小时执行一次清理操作
• 多维度清理策略：
  • 清理停止超过30分钟的容器（默认值，可通过CONTAINER_UNTIL环境变量自定义），执行命令：docker container prune -f
  • 清理未使用超过2小时的镜像（默认值，可通过IMAGE_UNTIL环境变量自定义），执行命令：docker image prune -f
  • 清理未使用超过2天的所有镜像（默认值，可通过IMAGE_ALL_UNTIL环境变量自定义），执行命令：docker image prune -f --all
• 通过Docker socket操作：直接与Docker守护进程通信，无需在容器内安装完整Docker客户端

使用场景与适用范围

• 本地开发环境：自动清理测试过程中产生的临时容器和镜像
• 测试环境：定期释放磁盘空间，避免存储空间耗尽
• 任何需要自动管理Docker资源的场景，减少手动维护成本

使用方法与配置说明

基本运行命令

bash
docker run -d --restart=always -v /var/run/docker.sock:/var/run/docker.sock --name periodic-prune trajano/periodic-prune

参数说明：

• -d：后台运行容器
• --restart=always：容器退出时自动重启
• -v /var/run/docker.sock:/var/run/docker.sock：挂载Docker socket，使容器能够与Docker守护进程通信

环境变量配置

可通过环境变量自定义清理时间阈值：

示例：自定义清理阈值

bash
docker run -d --restart=always \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -e CONTAINER_UNTIL="1小时" \
  -e IMAGE_UNTIL="4小时" \
  -e IMAGE_ALL_UNTIL="1天" \
  --name periodic-prune trajano/periodic-prune

Docker Compose配置示例

yaml
version: '3'
services:
  periodic-prune:
    image: trajano/periodic-prune
    restart: always
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - CONTAINER_UNTIL=30分钟
      - IMAGE_UNTIL=2小时
      - IMAGE_ALL_UNTIL=2天
    container_name: periodic-prune

开发者笔记

本地测试

bash
docker run -v /var/run/docker.sock:/var/run/docker.sock:ro $(docker build -q .) /prune

说明：挂载Docker socket为只读模式，构建本地镜像后运行清理脚本进行测试。