community.docker.docker_prune module – Allows to prune various docker objects
Note
This module is part of the community.docker collection (version 2.7.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.docker.docker_prune
.
Synopsis
Allows to run
docker container prune
,docker image prune
,docker network prune
anddocker 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 |
---|---|
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 Default: |
|
Whether to prune the builder cache. Requires version 3.3.0 of the Docker SDK for Python or newer. Choices:
|
|
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 |
|
Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable |
|
Path to the client’s TLS key file. If the value is not specified in the task and the environment variable |
|
Whether to prune containers. Choices:
|
|
A dictionary of filter values used for selecting containers to delete. For example, See the docker documentation for more information on possible filters. |
|
Debug mode Choices:
|
|
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, If the value is not specified in the task, the value of environment variable Default: |
|
Whether to prune images. Choices:
|
|
A dictionary of filter values used for selecting images to delete. For example, See the docker documentation for more information on possible filters. |
|
Whether to prune networks. Choices:
|
|
A dictionary of filter values used for selecting networks to delete. See the docker documentation for more information on possible filters. |
|
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 |
|
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 Default: |
|
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 If the value is not specified in the task, the value of environment variable Choices:
|
|
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 The current default value is |
|
For SSH transports, use the Requires Docker SDK for Python 4.4.0 or newer. Choices:
|
|
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 Choices:
|
|
Whether to prune volumes. Choices:
|
|
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
andDOCKER_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 theDOCKER_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 |
---|---|
Amount of reclaimed disk space from builder cache pruning in bytes. Returned: builder_cache is Sample: |
|
List of IDs of deleted containers. Returned: containers is Sample: |
|
Amount of reclaimed disk space from container pruning in bytes. Returned: containers is Sample: |
|
List of IDs of deleted images. Returned: images is Sample: |
|
Amount of reclaimed disk space from image pruning in bytes. Returned: images is Sample: |
|
List of IDs of deleted networks. Returned: networks is Sample: |
|
List of IDs of deleted volumes. Returned: volumes is Sample: |
|
Amount of reclaimed disk space from volumes pruning in bytes. Returned: volumes is Sample: |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication