yelp/docker-custodian

Docker Custodian

镜像概述和主要用途

Docker Custodian是一款用于保持Docker主机整洁的工具，主要通过两个核心命令实现资源清理：dcgc（删除旧容器和未使用镜像）和dcstop（停止运行时间过长的容器）。它能够自动识别并清理不再需要的Docker资源，避免存储空间浪费和资源占用。

核心功能和特性

• 资源清理：通过dcgc命令删除旧的停止容器和未使用镜像
• 运行控制：通过dcstop命令停止运行时间超过指定阈值的容器
• 智能保留：自动保留运行中容器及被容器使用的镜像
• 灵活配置：支持通过标签和模式匹配排除特定容器和镜像
• 时间格式兼容：支持pytimeparse库兼容的多种时间格式（如3days、2weeks等）

安装方式

容器方式

bash
docker pull yelp/docker-custodian
docker run -ti \
    -v /var/run/docker.sock:/var/run/docker.sock \
    yelp/docker-custodian dcgc --help

Debian/Ubuntu包

首先构建包（需安装dh-virtualenv依赖）：

bash
dpkg-buildpackage -us -uc

然后安装生成的包：

bash
dpkg -i ../docker-custodian_*.deb

源码安装

bash
pip install git+https://github.com/Yelp/docker-custodian.git#egg=docker_custodian

使用方法

dcgc：删除旧容器和镜像

dcgc命令用于删除停止的容器和未使用的镜像，仅清理存在时间超过指定"最大年龄"的资源。运行中的容器和被容器使用的镜像不会被删除。

基本用法

最大年龄可使用pytimeparse支持的任意时间格式（如3days、12h、30m等）。

示例：

bash
dcgc --max-container-age 3days --max-image-age 30days

排除镜像配置

可通过以下参数指定永久保留的镜像：

• --exclude-image：指定不删除的镜像标签，可多次使用
• --exclude-image-file：指定包含排除镜像列表的文件路径，每行一个镜像标签

支持基本模式匹配，例如：

user/repositoryA:*          # 排除repositoryA的所有标签
user/repositoryB:?.?        # 排除repositoryB的x.x格式标签
user/repositoryC-*:tag      # 排除以repositoryC-开头的镜像的tag标签

排除容器及关联镜像配置

可通过标签排除特定停止容器（及其使用的镜像）：

• --exclude-container-label：指定不删除的容器标签（格式为key=value，可省略value仅检查key），可多次使用

支持基本模式匹配，例如：

foo*                        # 排除标签键以foo开头的容器
com.docker.compose.project=test*  # 排除项目名为test开头的compose容器
com.docker*=*bar*           # 排除标签值包含bar的docker相关容器

dcstop：停止运行过久的容器

dcstop命令用于停止运行时间超过指定时长的容器，仅针对名称以--prefix参数指定前缀开头的容器。

基本用法

示例：

bash
dcstop --max-run-time 2days --prefix "projectprefix_"

此命令将停止所有名称以"projectprefix_"开头且运行时间超过2天的容器。