W3cubDocs

/Ansible

community.docker.docker – Run tasks in docker containers

Note

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

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.

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

Synopsis

  • Run commands or put/fetch files to an existing docker container.
  • Uses the Docker CLI to execute commands in the container. If you prefer to directly connect to the Docker daemon, use the community.docker.docker_api connection plugin.

Parameters

Parameter Choices/Defaults Configuration Comments
docker_extra_args
string
Default:
""
Extra arguments to pass to the docker command line
remote_addr
string
Default:
"inventory_hostname"
var: ansible_host
var: ansible_docker_host
The name of the container you want to access.
remote_user
string
var: ansible_user
var: ansible_docker_user
The user to execute as inside the container

Authors

  • Lorin Hochestein (!UNKNOWN)
  • Leendert Brouwer (!UNKNOWN)

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