community.docker.docker_prune module – Allows to prune various docker objects

Note

This module is part of the community.docker collection (version 2.7.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.docker.

To use it in a playbook, specify: community.docker.docker_prune.

Synopsis

  • Allows to run docker container prune, docker image prune, docker network prune and docker volume prune via the Docker API.

Requirements

The below requirements are needed on the host that executes this module.

  • Docker API >= 1.25

  • Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). This module does not work with docker-py.

  • Docker SDK for Python >= 2.1.0

  • Python >= 2.7

Parameters

Parameter

Comments

api_version

aliases: docker_api_version

string

The version of the Docker API running on the Docker Host.

Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon.

If the value is not specified in the task, the value of environment variable DOCKER_API_VERSION will be used instead. If the environment variable is not set, the default value will be used.

Default: “auto”

builder_cache

boolean

Whether to prune the builder cache.

Requires version 3.3.0 of the Docker SDK for Python or newer.

Choices:

  • no ← (default)

  • yes

ca_cert

aliases: tls_ca_cert, cacert_path

path

Use a CA certificate when performing server verification by providing the path to a CA certificate file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file ca.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

client_cert

aliases: tls_client_cert, cert_path

path

Path to the client’s TLS certificate file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file cert.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

client_key

aliases: tls_client_key, key_path

path

Path to the client’s TLS key file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file key.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

containers

boolean

Whether to prune containers.

Choices:

  • no ← (default)

  • yes

containers_filters

dictionary

A dictionary of filter values used for selecting containers to delete.

For example, until: 24h.

See the docker documentation for more information on possible filters.

debug

boolean

Debug mode

Choices:

  • no ← (default)

  • yes

docker_host

aliases: docker_url

string

The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, tcp://192.0.2.23:2376. If TLS is used to encrypt the connection, the module will automatically replace tcp in the connection URL with https.

If the value is not specified in the task, the value of environment variable DOCKER_HOST will be used instead. If the environment variable is not set, the default value will be used.

Default: “unix://var/run/docker.sock”

images

boolean

Whether to prune images.

Choices:

  • no ← (default)

  • yes

images_filters

dictionary

A dictionary of filter values used for selecting images to delete.

For example, dangling: true.

See the docker documentation for more information on possible filters.

networks

boolean

Whether to prune networks.

Choices:

  • no ← (default)

  • yes

networks_filters

dictionary

A dictionary of filter values used for selecting networks to delete.

See the docker documentation for more information on possible filters.

ssl_version

string

Provide a valid SSL version number. Default value determined by ssl.py module.

If the value is not specified in the task, the value of environment variable DOCKER_SSL_VERSION will be used instead.

timeout

integer

The maximum amount of time in seconds to wait on a response from the API.

If the value is not specified in the task, the value of environment variable DOCKER_TIMEOUT will be used instead. If the environment variable is not set, the default value will be used.

Default: 60

tls

boolean

Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to true as well, it will take precedence.

If the value is not specified in the task, the value of environment variable DOCKER_TLS will be used instead. If the environment variable is not set, the default value will be used.

Choices:

  • no ← (default)

  • yes

tls_hostname

string

When verifying the authenticity of the Docker Host server, provide the expected name of the server.

If the value is not specified in the task, the value of environment variable DOCKER_TLS_HOSTNAME will be used instead. If the environment variable is not set, the default value will be used.

The current default value is localhost. This default is deprecated and will change in community.docker 2.0.0 to be a value computed from docker_host. Explicitly specify localhost to make sure this value will still be used, and to disable the deprecation message which will be shown otherwise.

use_ssh_client

boolean

added in 1.5.0 of community.docker

For SSH transports, use the ssh CLI tool instead of paramiko.

Requires Docker SDK for Python 4.4.0 or newer.

Choices:

  • no ← (default)

  • yes

validate_certs

aliases: tls_verify

boolean

Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.

If the value is not specified in the task, the value of environment variable DOCKER_TLS_VERIFY will be used instead. If the environment variable is not set, the default value will be used.

Choices:

  • no ← (default)

  • yes

volumes

boolean

Whether to prune volumes.

Choices:

  • no ← (default)

  • yes

volumes_filters

dictionary

A dictionary of filter values used for selecting volumes to delete.

See the docker documentation for more information on possible filters.

Notes

Note

  • Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.

  • When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing docker[tls] with ansible.builtin.pip.

  • Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use $HOME/.docker/config.json if the DOCKER_CONFIG environment variable is not specified, and use $DOCKER_CONFIG/config.json otherwise.

  • This module uses the Docker SDK for Python to communicate with the Docker daemon.

Examples

- name: Prune containers older than 24h
  community.docker.docker_prune:
    containers: true
    containers_filters:
      # only consider containers created more than 24 hours ago
      until: 24h

- name: Prune everything
  community.docker.docker_prune:
    containers: true
    images: true
    networks: true
    volumes: true
    builder_cache: true

- name: Prune everything (including non-dangling images)
  community.docker.docker_prune:
    containers: true
    images: true
    images_filters:
      dangling: false
    networks: true
    volumes: true
    builder_cache: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

builder_cache_space_reclaimed

integer

Amount of reclaimed disk space from builder cache pruning in bytes.

Returned: builder_cache is true

Sample: 0

containers

list / elements=string

List of IDs of deleted containers.

Returned: containers is true

Sample: []

containers_space_reclaimed

integer

Amount of reclaimed disk space from container pruning in bytes.

Returned: containers is true

Sample: 0

images

list / elements=string

List of IDs of deleted images.

Returned: images is true

Sample: []

images_space_reclaimed

integer

Amount of reclaimed disk space from image pruning in bytes.

Returned: images is true

Sample: 0

networks

list / elements=string

List of IDs of deleted networks.

Returned: networks is true

Sample: []

volumes

list / elements=string

List of IDs of deleted volumes.

Returned: volumes is true

Sample: []

volumes_space_reclaimed

integer

Amount of reclaimed disk space from volumes pruning in bytes.

Returned: volumes is true

Sample: 0

Authors

  • Felix Fontein (@felixfontein)