Docs4dev
Docs
ansible / 2.10 / collections / community / docker / docker_containers_inventory.html

community.docker.docker_containers – Ansible dynamic inventory plugin for Docker containers.

Note

This plugin is part of the community.docker collection (version 1.1.0).

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

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

New in version 1.1.0: of community.docker

Synopsis

  • Reads inventories from the Docker API.
  • Uses a YAML configuration file that ends with docker.[yml|yaml].

Requirements

The below requirements are needed on the local controller node that executes this inventory.

  • 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-py must be used. Otherwise, it is recommended to install the docker Python 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

Parameters

Parameter Choices/Defaults Configuration Comments
add_legacy_groups
boolean
    Choices:
  • no ←
  • yes
Add the same groups as the docker inventory script does. These are the following:
<container id>: contains the container of this ID.
<container name>: contains the container that has this name.
<container short id>: contains the containers that have this short ID (first 13 letters of ID).
image_<image name>: contains the containers that have the image <image name>.
stack_<stack name>: contains the containers that belong to the stack <stack name>.
service_<service name>: contains the containers that belong to the service <service name>
<docker_host>: contains the containers which belong to the Docker daemon docker_host. Useful if you run this plugin against multiple Docker daemons.
running: contains all containers that are running.
stopped: contains all containers that are not running.
If this is not set to true, you should use keyed groups to add the containers to groups. See the examples for how to do that.
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_VERSION will 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_PATH is set, the file ca.pem from the directory specified in the environment variable DOCKER_CERT_PATH will 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_PATH is set, the file cert.pem from the directory specified in the environment variable DOCKER_CERT_PATH will 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_PATH is set, the file key.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_client_key, key_path
compose
dictionary
Default:
{}
Create vars from jinja2 expressions.
connection_type
string
    Choices:
  • ssh
  • docker-cli
  • docker-api ←
Which connection type to use the containers.
Default is to use SSH (ssh). For this, the options default_ip and private_ssh_port are used.
Alternatively, docker-cli selects the docker connection plugin, and docker-api selects the docker_api connection plugin.
debug
boolean
    Choices:
  • no ←
  • yes
Debug mode
default_ip
string
Default:
"127.0.0.1"
The IP address to assign to ansible_host when the container's SSH port is mapped to interface '0.0.0.0'.
Only used if connection_type is ssh.
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 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.

aliases: docker_url
groups
dictionary
Default:
{}
Add hosts to group based on Jinja2 conditionals.
keyed_groups
list / elements=string
Default:
[]
Add hosts to group based on the values of a variable.
plugin
string / required
    Choices:
  • community.docker.docker_containers
The name of this plugin, it should always be set to community.docker.docker_containers for this plugin to recognize it as it's own.
private_ssh_port
integer
Default:
22
The port containers use for SSH.
Only used if connection_type is ssh.
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.
strict
boolean
    Choices:
  • no ←
  • yes
If yes make invalid entries a fatal error, otherwise skip and continue.
Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default.
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_TIMEOUT will be used instead. If the environment variable is not set, the default value will be used.
tls
boolean
    Choices:
  • no ←
  • yes
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 yes 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.
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_HOSTNAME will be used instead. If the environment variable is not set, the default value will be used.
validate_certs
boolean
    Choices:
  • no ←
  • yes
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.

aliases: tls_verify
verbose_output
boolean
    Choices:
  • no ←
  • yes
Toggle to (not) include all available inspection metadata.
Note that all top-level keys will be transformed to the format docker_xxx. For example, HostConfig is converted to docker_hostconfig.
If this is false, these values can only be used during constructed, groups, and keyed_groups.
The docker inventory script always added these variables, so for compatibility set this to true.

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

# Minimal example using local Docker daemon
plugin: community.docker.docker_containers
docker_host: unix://var/run/docker.sock

# Minimal example using remote Docker daemon
plugin: community.docker.docker_containers
docker_host: tcp://my-docker-host:2375

# Example using remote Docker daemon with unverified TLS
plugin: community.docker.docker_containers
docker_host: tcp://my-docker-host:2376
tls: true

# Example using remote Docker daemon with verified TLS and client certificate verification
plugin: community.docker.docker_containers
docker_host: tcp://my-docker-host:2376
validate_certs: true
ca_cert: /somewhere/ca.pem
client_key: /somewhere/key.pem
client_cert: /somewhere/cert.pem

# Example using constructed features to create groups
plugin: community.docker.docker_containers
docker_host: tcp://my-docker-host:2375
strict: false
keyed_groups:
  # Add containers with primary network foo to a network_foo group
  - prefix: network
    key: 'docker_hostconfig.NetworkMode'
  # Add Linux hosts to an os_linux group
  - prefix: os
    key: docker_platform

Authors

  • Felix Fontein (@felixfontein)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/docker/docker_containers_inventory.html