mirror of
https://github.com/thegeeklab/docker-tidy.git
synced 2024-11-18 02:20:40 +00:00
85 lines
2.5 KiB
Markdown
85 lines
2.5 KiB
Markdown
|
---
|
||
|
|
title: Documentation
|
||
|
|
---
|
||
|
|
|
||
|
|
[](https://cloud.drone.io/xoxys/docker-tidy)
|
||
|
|
[](https://hub.docker.com/r/xoxys/docker-tidy)
|
||
|
|
[](https://pypi.org/project/docker-tidy/)
|
||
|
|
[](https://pypi.org/project/docker-tidy/)
|
||
|
|
[](https://pypi.org/project/docker-tidy/)
|
||
|
|
[](LICENSE)
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
There are three installation options
|
||
|
|
|
||
|
|
### Container
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
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
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
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:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
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.
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
--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.
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
--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:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
docker-tidy stop --max-run-time 2days --prefix "projectprefix_"
|
||
|
|
```
|