community.docker.docker_containers – Ansible dynamic inventory plugin for Docker containers.
community.docker.docker_containers – Ansible dynamic inventory plugin for Docker containers.
Note
This plugin is part of the community.docker collection (version 1.2.2).
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 thedocker
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 |
|
Add the same groups as the
If this is not set to | |
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
| |
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
| ||
client_cert path |
Path to the client's TLS certificate file. If the value is not specified in the task and the environment variable
| ||
client_key path |
Path to the client's TLS key file. If the value is not specified in the task and the environment variable
| ||
compose dictionary |
Default: {} |
Create vars from jinja2 expressions. | |
connection_type string |
|
Which connection type to use the containers. Default is to use SSH ( Alternatively, | |
debug boolean |
|
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 | |
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, If the value is not specified in the task, the value of environment variable
| |
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. | |
leading_separator boolean added in 2.11 of ansible.builtin |
|
Use in conjunction with keyed_groups. By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. This is because the default prefix is "" and the default separator is "_". Set this option to False to omit the leading underscore (or other separator) if no prefix is given. If the group name is derived from a mapping the separator is still used to concatenate the items. To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. | |
plugin string / required |
|
The name of this plugin, it should always be set to | |
private_ssh_port integer |
Default: 22 |
The port containers use for SSH. Only used if connection_type is | |
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 | ||
strict boolean |
|
If 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 | |
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 If the value is not specified in the task, the value of environment variable | |
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 | |
use_extra_vars boolean added in 2.11 of ansible.builtin |
|
ini entries: [inventory_plugins]use_extra_vars = no
env:ANSIBLE_INVENTORY_USE_EXTRA_VARS |
Merge extra vars into the available variables for composition (highest precedence). |
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
| |
verbose_output boolean |
|
Toggle to (not) include all available inspection metadata. Note that all top-level keys will be transformed to the format If this is The |
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
# 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/docker/docker_containers_inventory.html