docker-tidy/docs/content/_index.md

title
Documentation

Install

There are three installation options

Container

docker pull xoxys/docker-tidy
docker run -ti \
    -v /var/run/docker.sock:/var/run/docker.sock \
    xoxys/docker-tidy docker-tidy gc --help

Source

pip install git+https://github.com/xoxys/docker-tidy.git

Garbage Collector

Remove old docker containers and docker images.

docker-tidy gc will remove stopped containers and unused images that are older than "max age". Running containers, and images which are used by a container are never removed.

Maximum age can be specificied with any format supported by [pytimeparse].

Example:

docker-tidy gc --max-container-age 3days --max-image-age 30days

Prevent images from being removed

docker-tidy gc supports an image exclude list. If you have images that you'd like to keep around forever you can use the exclude list to prevent them from being removed.

    --exclude-image
        Never remove images with this tag. May be specified more than once.

Prevent containers and associated images from being removed

docker-tidy gc also supports a container exclude list based on labels. If there are stopped containers that you'd like to keep, then you can check the labels to prevent them from being removed.

    --exclude-container-label
        Never remove containers that have the label key=value. =value can be
        omitted and in that case only the key is checked. May be specified
        more than once.

Autostop

Stop containers that have been running for too long.

docker-tidy stop will docker stop containers where the container name starts with [--prefix]{.title-ref} and it has been running for longer than [--max-run-time]{.title-ref}.

Example:

docker-tidy stop --max-run-time 2days --prefix "projectprefix_"