docker-tidy/README.rst
2015-07-20 15:41:11 -07:00

55 lines
1.3 KiB
ReStructuredText

Docker Custodian
================
.. image:: https://travis-ci.org/Yelp/docker-custodian.svg
:target: https://travis-ci.org/Yelp/docker-custodian
Keep docker hosts tidy.
dcgc
----
Remove old docker containers and docker images.
``dcgc`` 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 <https://github.com/wroberts/pytimeparse>`_.
Example:
dcgc --max-container-age 3days --max-image-age 30days
Prevent images from being removed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
``dcgc`` 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.
--exclude-image-file
Path to a file which contains a list of images to exclude, one
image tag per line.
dcstop
------
Stop containers that have been running for too long.
``dcstop`` will ``docker stop`` containers where the container name starts
with `--prefix` and it has been running for longer than `--max-run-time`.
Example:
dcstop --max-run-time 2days --prefix "projectprefix_"