diff --git a/README.md b/README.md index 63bf850..71692ac 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ [![Python Version](https://img.shields.io/pypi/pyversions/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) [![PyPi Status](https://img.shields.io/pypi/status/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) [![PyPi Release](https://img.shields.io/pypi/v/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) -[![Codecov](https://img.shields.io/codecov/c/github/xoxys/docker-tidy)](https://codecov.io/gh/xoxys/docker-tidy) [![License: MIT](https://img.shields.io/github/license/xoxys/docker-tidy)](LICENSE) This is a fork of [Yelp/docker-custodian](https://github.com/Yelp/docker-custodian). Keep docker hosts tidy. diff --git a/docs/config.yaml b/docs/config.yaml new file mode 100644 index 0000000..ca6d1fb --- /dev/null +++ b/docs/config.yaml @@ -0,0 +1,31 @@ +--- +baseURL: https://docker-tidy.geekdocs.de/ +title: docker-tidy +theme: hugo-geekdoc +pygmentsUseClasses: true +pygmentsCodeFences: true + +# Geekdoc configuration +disablePathToLower: true +enableGitInfo: true + +# Needed for mermaid/katex shortcodes +markup: + goldmark: + renderer: + unsafe: true + tableOfContents: + startLevel: 1 + +params: + geekdocMenuBundle: true + geekdocToC: 3 + + geekdocRepo: https://github.com/xoxys/docker-tidy + geekdocEditPath: edit/master/docs/content + + geekdocDateFormat: "Jan 2, 2006" + geekdocSearch: true + + geekdocLegalNotice: https://geeklabor.de/legal-notice/#impressum + geekdocPrivacyPolicy: https://geeklabor.de/legal-notice/#datenschutzerkl%C3%A4rung diff --git a/docs/content/_index.md b/docs/content/_index.md new file mode 100644 index 0000000..501e3f9 --- /dev/null +++ b/docs/content/_index.md @@ -0,0 +1,84 @@ +--- +title: Documentation +--- + +[![Build Status](https://img.shields.io/drone/build/xoxys/docker-tidy?logo=drone)](https://cloud.drone.io/xoxys/docker-tidy) +[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/docker-tidy) +[![Python Version](https://img.shields.io/pypi/pyversions/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) +[![PyPi Status](https://img.shields.io/pypi/status/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) +[![PyPi Release](https://img.shields.io/pypi/v/docker-tidy.svg)](https://pypi.org/project/docker-tidy/) +[![License: MIT](https://img.shields.io/github/license/xoxys/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_" +```