2020-03-15 13:21:36 +01:00
|
|
|
---
|
|
|
|
|
title: Configuration
|
|
|
|
|
---
|
|
|
|
|
|
2020-03-15 13:46:12 +01:00
|
|
|
{{< toc >}}
|
|
|
|
|
|
2020-03-15 13:21:36 +01:00
|
|
|
*docker-tidy* comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs.
|
|
|
|
|
|
|
|
|
|
Changes can be made on different locations which will be processed in the following order (last wins):
|
|
|
|
|
|
|
|
|
|
* default config (build-in)
|
|
|
|
|
* global config file (path depends on your operating system)
|
|
|
|
|
* folder-based config file (.dockertidy.yml|.dockertidy.yaml|.dockertidy in current working dir)
|
|
|
|
|
* environment variables
|
|
|
|
|
* cli options
|
|
|
|
|
|
|
|
|
|
## Default settings
|
|
|
|
|
|
|
|
|
|
<!-- markdownlint-disable -->
|
|
|
|
|
{{< highlight YAML "linenos=table" >}}
|
|
|
|
|
---
|
|
|
|
|
# don't do anything
|
|
|
|
|
dry_run: False
|
2020-03-15 13:30:37 +01:00
|
|
|
http_timeout: 60
|
2020-03-15 13:21:36 +01:00
|
|
|
|
|
|
|
|
logging:
|
|
|
|
|
# possible options debug | info | warning | error | critical
|
|
|
|
|
level: "warning"
|
|
|
|
|
# you can enable json logging if a parsable output is required
|
|
|
|
|
json: False
|
|
|
|
|
|
2020-03-15 13:30:37 +01:00
|
|
|
gc:
|
|
|
|
|
max_container_age:
|
|
|
|
|
max_image_age:
|
|
|
|
|
dangling_volumes: false
|
|
|
|
|
exclude_images: []
|
|
|
|
|
exclude_container_labels: []
|
|
|
|
|
|
|
|
|
|
stop:
|
|
|
|
|
max_run_time:
|
|
|
|
|
prefix: []
|
2020-03-15 13:21:36 +01:00
|
|
|
{{< /highlight >}}
|
|
|
|
|
<!-- markdownlint-enable -->
|
|
|
|
|
|
|
|
|
|
## Environment Variables
|
|
|
|
|
|
|
|
|
|
<!-- markdownlint-disable -->
|
|
|
|
|
{{< highlight Shell "linenos=table" >}}
|
|
|
|
|
TIDY_CONFIG_FILE=
|
|
|
|
|
TIDY_DRY_RUN=False
|
|
|
|
|
TIDY_HTTP_TIMEOUT=60
|
|
|
|
|
TIDY_LOG_LEVEL=warning
|
|
|
|
|
TIDY_LOG_JSON=False
|
|
|
|
|
TIDY_GC_MAX_CONTAINER_AGE=
|
|
|
|
|
TIDY_GC_MAX_IMAGE_AGE=
|
|
|
|
|
TIDY_GC_DANGLING_VOLUMES=False
|
|
|
|
|
# comma-separated list
|
|
|
|
|
TIDY_GC_EXCLUDE_IMAGES=
|
|
|
|
|
# comma-separated list
|
|
|
|
|
TIDY_GC_EXCLUDE_CONTAINER_LABELS=
|
|
|
|
|
TIDY_STOP_MAX_RUN_TIME=
|
|
|
|
|
# comma-separated list
|
|
|
|
|
TIDY_STOP_PREFIX=
|
|
|
|
|
{{< /highlight >}}
|
|
|
|
|
<!-- markdownlint-enable -->
|
|
|
|
|
|
|
|
|
|
## CLI options
|
|
|
|
|
|
|
|
|
|
You can get all available cli options by running `docker-tidy --help`:
|
|
|
|
|
|
|
|
|
|
<!-- markdownlint-disable -->
|
|
|
|
|
{{< highlight Shell "linenos=table" >}}
|
|
|
|
|
$ docker-tidy --help
|
|
|
|
|
usage: docker-tidy [-h] [--dry-run] [-t HTTP_TIMEOUT] [-v] [-q] [--version]
|
|
|
|
|
{gc,stop} ...
|
|
|
|
|
|
|
|
|
|
Generate documentation from annotated Ansible roles using templates
|
|
|
|
|
|
|
|
|
|
positional arguments:
|
|
|
|
|
{gc,stop} sub-command help
|
|
|
|
|
gc Run docker garbage collector.
|
|
|
|
|
stop Stop containers that have been running for too long.
|
|
|
|
|
|
|
|
|
|
optional arguments:
|
|
|
|
|
-h, --help show this help message and exit
|
|
|
|
|
--dry-run Only log actions, don't stop anything.
|
|
|
|
|
-t HTTP_TIMEOUT, --timeout HTTP_TIMEOUT
|
|
|
|
|
HTTP timeout in seconds for making docker API calls.
|
|
|
|
|
-v increase log level
|
|
|
|
|
-q decrease log level
|
|
|
|
|
--version show program's version number and exit
|
|
|
|
|
{{< /highlight >}}
|
|
|
|
|
<!-- markdownlint-enable -->
|
