community.docker.docker_containers – Ansible dynamic inventory plugin for Docker containers.¶
This plugin is part of the community.docker collection (version 1.9.1).
To install it use:
ansible-galaxy collection install community.docker.
To use it in a playbook, specify:
New in version 1.1.0: of community.docker
Reads inventories from the Docker API.
Uses a YAML configuration file that ends with
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-pymust be used. Otherwise, it is recommended to install the
dockerPython 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
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
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
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
DOCKER_CONFIGenvironment variable is not specified, and use
This module uses the Docker SDK for Python to communicate with the Docker daemon.
# 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 # Example using SSH connection with an explicit fallback for when port 22 hasn't been # exported: use container name as ansible_ssh_host and 22 as ansible_ssh_port plugin: community.docker.docker_containers connection_type: ssh compose: ansible_ssh_host: ansible_ssh_host | default(docker_name[1:], true) ansible_ssh_port: ansible_ssh_port | default(22, true)