diff --git a/index.md b/index.md index 57e7d80..35511df 100644 --- a/index.md +++ b/index.md @@ -8,87 +8,124 @@ type: docs Setup docker-tidy garbage collector. Keep docker hosts small. * [Default Variables](#default-variables) - * [custodian_dangling_volumes](#custodian-dangling-volumes) - * [custodian_exclude_container_label](#custodian-exclude-container-label) - * [custodian_exclude_image](#custodian-exclude-image) - * [custodian_image](#custodian-image) - * [custodian_interval](#custodian-interval) - * [custodian_max_container_age](#custodian-max-container-age) - * [custodian_max_image_age](#custodian-max-image-age) + * [dockertidy_dangling_volumes](#dockertidy-dangling-volumes) + * [dockertidy_docker_socket_path](#dockertidy-docker-socket-path) + * [dockertidy_dry_run](#dockertidy-dry-run) + * [dockertidy_exclude_container_label](#dockertidy-exclude-container-label) + * [dockertidy_exclude_container_labels](#dockertidy-exclude-container-labels) + * [dockertidy_exclude_image](#dockertidy-exclude-image) + * [dockertidy_exclude_images](#dockertidy-exclude-images) + * [dockertidy_image](#dockertidy-image) + * [dockertidy_interval](#dockertidy-interval) + * [dockertidy_log_level](#dockertidy-log-level) + * [dockertidy_max_container_age](#dockertidy-max-container-age) + * [dockertidy_max_image_age](#dockertidy-max-image-age) * [Dependencies](#dependencies) --- ## Default Variables -### custodian_dangling_volumes +### dockertidy_dangling_volumes -Remove dangling volumes +Remove dangling volumes. #### Default value ```YAML -custodian_dangling_volumes: false +dockertidy_dangling_volumes: false ``` -### custodian_exclude_container_label - -List of labels to exclude+ +### dockertidy_docker_socket_path #### Default value ```YAML -custodian_exclude_container_label: [] +dockertidy_docker_socket_path: /var/run/docker.sock ``` -### custodian_exclude_image +### dockertidy_dry_run -List of images to exclude +Only log actions, don't cleanup anything. #### Default value ```YAML -custodian_exclude_image: [] +dockertidy_dry_run: false ``` -### custodian_image +### dockertidy_exclude_container_label -Docker image to use +Never remove containers with this label `key` or label `key=value`. + +### dockertidy_exclude_container_labels #### Default value ```YAML -custodian_image: toolhippie/docker-custodian:latest +dockertidy_exclude_container_labels: [] ``` -### custodian_interval +### dockertidy_exclude_image -Interval for the systemd timer +Never remove images with this tag. + +### dockertidy_exclude_images #### Default value ```YAML -custodian_interval: daily +dockertidy_exclude_images: [] ``` -### custodian_max_container_age +### dockertidy_image -Max container age +Docker image to use. #### Default value ```YAML -custodian_max_container_age: 3days +dockertidy_image: xoxys/docker-tidy:latest ``` -### custodian_max_image_age +### dockertidy_interval -Max image age +Interval for the systemd timer. #### Default value ```YAML -custodian_max_image_age: 3days +dockertidy_interval: daily +``` + +### dockertidy_log_level + +Current log level. + +#### Default value + +```YAML +dockertidy_log_level: warning +``` + +### dockertidy_max_container_age + +Maximum age for a container, containers older than this age will be removed. + +#### Default value + +```YAML +dockertidy_max_container_age: 5 days ago +``` + +### dockertidy_max_image_age + +Maxium age for an image, images older than this age will be removed. + +#### Default value + +```YAML +dockertidy_max_image_age: 3 days ago ``` ## Dependencies