docker_volume – Manage Docker volumes¶
New in version 2.4.
Synopsis¶
- Create/remove Docker volumes.
- Performs largely the same function as the “docker volume” CLI subcommand.
Requirements¶
The below requirements are needed on the host that executes this module.
- Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6, docker-pymust be used. Otherwise, it is recommended to install thedockerPython module. Note that both modules should not be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.
- Docker SDK for Python >= 1.10.0 (use docker-py for Python 2.6)
- The docker server >= 1.9.0
Parameters¶
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| api_version 
                    string
                                                                 | Default: "auto" | 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_VERSIONwill be used instead. If the environment variable is not set, the default value will be used.aliases: docker_api_version | 
| ca_cert 
                    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_PATHis set, the fileca.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used.aliases: tls_ca_cert, cacert_path | |
| client_cert 
                    path
                                                                 | Path to the client's TLS certificate file. If the value is not specified in the task and the environment variable  DOCKER_CERT_PATHis set, the filecert.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used.aliases: tls_client_cert, cert_path | |
| client_key 
                    path
                                                                 | Path to the client's TLS key file. If the value is not specified in the task and the environment variable  DOCKER_CERT_PATHis set, the filekey.pemfrom the directory specified in the environment variableDOCKER_CERT_PATHwill be used.aliases: tls_client_key, key_path | |
| debug 
                    boolean
                                                                 | 
 | Debug mode | 
| docker_host 
                    string
                                                                 | Default: "unix://var/run/docker.sock" | 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 replacetcpin the connection URL withhttps.If the value is not specified in the task, the value of environment variable  DOCKER_HOSTwill be used instead. If the environment variable is not set, the default value will be used.aliases: docker_url | 
| driver 
                    string
                                                                 | Default: "local" | Specify the type of volume. Docker provides the  localdriver, but 3rd party drivers can also be used. | 
| driver_options 
                    dictionary
                                                                 | Dictionary of volume settings. Consult docker docs for valid options and values: https://docs.docker.com/engine/reference/commandline/volume_create/#driver-specific-options | |
| force 
                    boolean
                                                                 | 
 | With state  presentcauses the volume to be deleted and recreated if the volume already exist and the driver, driver options or labels differ. This will cause any data in the existing volume to be lost.Deprecated. Will be removed in Ansible 2.12. Set recreate to  options-changedinstead for the same behavior of setting force toyes. | 
| labels 
                    dictionary
                                                                 | Dictionary of label key/values to set for the volume | |
| recreate 
                    string
                                                                 added in 2.8 | 
 | Controls when a volume will be recreated when state is  present. Please note that recreating an existing volume will cause **any data in the existing volume to be lost!** The volume will be deleted and a new volume with the same name will be created.The value  alwaysforces the volume to be always recreated.The value  nevermakes sure the volume will not be recreated.The value  options-changedmakes sure the volume will be recreated if the volume already exist and the driver, driver options or labels differ. | 
| 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_VERSIONwill be used instead. | |
| state 
                    string
                                                                 | 
 | absentdeletes the volume.presentcreates the volume, if it does not already exist. | 
| timeout 
                    integer
                                                                 | Default: 60 | 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_TIMEOUTwill be used instead. If the environment variable is not set, the default value will be used. | 
| 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  yesas well, it will take precedence.If the value is not specified in the task, the value of environment variable  DOCKER_TLSwill be used instead. If the environment variable is not set, the default value will be used. | 
| tls_hostname 
                    string
                                                                 | Default: "localhost" | 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_HOSTNAMEwill be used instead. If the environment variable is not set, the default value will be used. | 
| validate_certs 
                    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_VERIFYwill be used instead. If the environment variable is not set, the default value will be used.aliases: tls_verify | 
| volume_name 
                    string
                                             / required                     | Name of the volume to operate on. aliases: name | 
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_VERIFYandDOCKER_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 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.jsonif theDOCKER_CONFIGenvironment variable is not specified, and use$DOCKER_CONFIG/config.jsonotherwise.
Examples¶
- name: Create a volume
  docker_volume:
    name: volume_one
- name: Remove a volume
  docker_volume:
    name: volume_one
    state: absent
- name: Create a volume with options
  docker_volume:
    name: volume_two
    driver_options:
      type: btrfs
      device: /dev/sda2
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Status¶
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors¶
- Alex Grönholm (@agronholm)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
