mirror of
https://github.com/thegeeklab/docker-tidy.git
synced 2024-11-01 10:30:40 +00:00
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
---
|
|
title: Usage
|
|
---
|
|
|
|
<!-- spellchecker-disable -->
|
|
{{< toc >}}
|
|
<!-- spellchecker-enable -->
|
|
|
|
## 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 specified with any format supported by [dateparser](https://dateparser.readthedocs.io/en/latest/index.html#features).
|
|
|
|
**Example:**
|
|
|
|
```Shell
|
|
docker-tidy gc --max-container-age "3 days ago" --max-image-age "30 days ago"
|
|
```
|
|
|
|
### 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/or it has been running for longer than [\--max-run-time]{.title-ref}.
|
|
|
|
If no prefix is set, **all** containers matching the `max-run-time` will be stopped!
|
|
|
|
**Example:**
|
|
|
|
```Shell
|
|
docker-tidy stop --max-run-time "2 days ago" --prefix "projectprefix_"
|
|
```
|