community.docker.docker connection – Run tasks in docker containers
Note
This connection plugin is part of the community.docker collection (version 3.13.1).
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 |
Comments |
---|---|
Controls how long we can wait to access reading output from the container once execution started. Default: Configuration:
|
|
Extra arguments to pass to the docker command line. Default: Configuration:
|
|
Provide extra environment variables to set when running commands in the Docker container. This option can currently only be provided as Ansible variables due to limitations of ansible-core’s configuration manager. Configuration:
|
|
Whether commands should be run with extended privileges. Note that this allows command to potentially break out of the container. Use with care! Choices:
Configuration:
|
|
The name of the container you want to access. Default: Configuration:
|
|
The user to execute as inside the container. If Docker is too old to allow this (< 1.7), the one set by Docker itself will be used. Configuration:
|
|
The directory inside the container to run commands in. Requires Docker CLI version 18.06 or later. Configuration:
|