community.docker.docker_compose_v2_run module – Run command in a new container of a Compose service
Note
This module 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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.docker.docker_compose_v2_run
.
New in community.docker 3.13.0
Synopsis
Uses Docker Compose to run a command in a new container for a service.
This encapsulates
docker compose run
.
Requirements
The below requirements are needed on the host that executes this module.
Docker CLI with Docker compose plugin 2.18.0 or later
PyYAML if
definition
is used
Parameters
Parameter |
Comments |
---|---|
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by this collection and the docker daemon. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
Linux capabilities to add to the container. |
|
Linux capabilities to drop from the container. |
|
The directory to run the command in. |
|
If set to This can be useful if environment files with Choices:
|
|
Automatically remove th econtainer when it exits. Corresponds to the Choices:
|
|
The Docker CLI context to use. Mutually exclusive with |
|
Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable |
|
Path to the client’s TLS key file. If the value is not specified in the task and the environment variable |
|
Compose file describing one or more services, networks and volumes. Mutually exclusive with If provided, PyYAML must be available to this module, and Note that a temporary directory will be created and deleted afterwards when using this option. |
|
Whether to run the command synchronously ( If set to Choices:
|
|
Path to the Docker CLI. If not provided, will search for Docker CLI on the |
|
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 Mutually exclusive with |
|
Override the entrypoint of the container image. |
|
Dictionary of environment variables with their respective values to be passed to the command ran inside the container. Values which might be parsed as numbers, booleans or other types by the YAML parser must be quoted (for example Please note that if you are passing values in with Jinja2 templates, like |
|
By default environment files are loaded from a
The path is relative to the |
|
List of Compose file names relative to Files are loaded and merged in the order given. Mutually exclusive with |
|
Whether to keep STDIN open even if not attached. Choices:
|
|
Add or override labels to the container. |
|
Assign a name to the container. |
|
Do not start linked services. Choices:
|
|
List of profiles to enable when starting services. Equivalent to |
|
Provide a project name. If not provided, the project name is taken from the basename of Required when |
|
Path to a directory containing a Compose file ( If Mutually exclusive with |
|
Publish a container’s port(s) to the host. |
|
Remove containers for services not defined in the Compose file. Choices:
|
|
The service to run the command in. |
|
Run command with all service’s ports enabled and mapped to the host. Choices:
|
|
Set the stdin of the command directly to the specified value. Can only be used if |
|
Strip empty lines from the end of stdout/stderr in result. Choices:
|
|
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if If the value is not specified in the task, the value of environment variable Choices:
|
|
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 |
|
Whether to allocate a TTY. Choices:
|
|
Use the service’s network Choices:
|
|
If specified, the user to execute this command with. |
|
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 Choices:
|
|
Bind mount one or more volumes. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Action groups: community.docker.docker, docker |
Use |
|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
If you need to evaluate environment variables of the container in
command
orargv
, you need to pass the command through a shell, likecommand=/bin/sh -c "echo $ENV_VARIABLE"
.The Docker compose CLI plugin has no stable output format (see for example https://github.com/docker/compose/issues/10872), and for the main operations also no machine friendly output format. The module tries to accomodate this with various version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin. Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions will change over time. New releases of the Docker compose CLI plugin can break this module at any time.
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_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.This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.
See Also
See also
- community.docker.docker_compose_v2
Manage multi-container Docker applications with Docker Compose CLI plugin.
Examples
- name: Run a simple command (command)
community.docker.docker_compose_v2_run:
service: foo
command: /bin/bash -c "ls -lah"
chdir: /root
register: result
- name: Print stdout
ansible.builtin.debug:
var: result.stdout
- name: Run a simple command (argv)
community.docker.docker_compose_v2_run:
service: foo
argv:
- /bin/bash
- "-c"
- "ls -lah > /dev/stderr"
chdir: /root
register: result
- name: Print stderr lines
ansible.builtin.debug:
var: result.stderr_lines
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The ID of the created container. Returned: success and |
|
The standard error output of the container command. Returned: success and |
|
The standard output of the container command. Returned: success and |