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 4.1.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. 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
api_version aliases: docker_api_version string	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 `DOCKER_API_VERSION` will be used instead. If the environment variable is not set, the default value will be used. Default: `"auto"`
argv list / elements=string	The command to execute. Since this is a list of arguments, no quoting is needed. `argv` or `command` are mutually exclusive.
build boolean	Build image before starting container. Note that building can insert information into `stdout` or `stderr`. Choices: `false` ← (default) `true`
ca_path aliases: ca_cert, tls_ca_cert, cacert_path 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 `DOCKER_CERT_PATH` is set, the file `ca.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used.
cap_add list / elements=string	Linux capabilities to add to the container.
cap_drop list / elements=string	Linux capabilities to drop from the container.
chdir string	The directory to run the command in.
check_files_existing boolean added in community.docker 3.9.0	If set to `false`, the module will not check whether one of the files `compose.yaml`, `compose.yml`, `docker-compose.yaml`, or `docker-compose.yml` exists in `project_src` if `files` is not provided. This can be useful if environment files with `COMPOSE_FILE` are used to configure a different filename. The module currently does not check for `COMPOSE_FILE` in environment files or the current environment. Choices: `false` `true` ← (default)
cleanup boolean	Automatically remove th econtainer when it exits. Corresponds to the `--rm` option of `docker compose run`. Choices: `false` ← (default) `true`
cli_context string	The Docker CLI context to use. Mutually exclusive with `docker_host`.
client_cert aliases: tls_client_cert, cert_path path	Path to the client’s TLS certificate file. If the value is not specified in the task and the environment variable `DOCKER_CERT_PATH` is set, the file `cert.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used.
client_key aliases: tls_client_key, key_path path	Path to the client’s TLS key file. If the value is not specified in the task and the environment variable `DOCKER_CERT_PATH` is set, the file `key.pem` from the directory specified in the environment variable `DOCKER_CERT_PATH` will be used.
command string	The command to execute. `argv` or `command` are mutually exclusive.
definition dictionary added in community.docker 3.9.0	Compose file describing one or more services, networks and volumes. Mutually exclusive with `project_src` and `files`. One of `project_src` and `definition` must be provided. If provided, PyYAML must be available to this module, and `project_name` must be specified. Note that a temporary directory will be created and deleted afterwards when using this option.
detach boolean	Whether to run the command synchronously (`detach=false`, default) or asynchronously (`detach=true`). If set to `true`, `stdin` cannot be provided, and the return values `stdout`, `stderr`, and `rc` are not returned. Instead, the return value `container_id` is provided. Choices: `false` ← (default) `true`
docker_cli path	Path to the Docker CLI. If not provided, will search for Docker CLI on the `PATH`.
docker_host aliases: docker_url string	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, `tcp://192.0.2.23:2376`. If TLS is used to encrypt the connection, the module will automatically replace `tcp` in the connection URL with `https`. If the value is not specified in the task, the value of environment variable `DOCKER_HOST` will be used instead. If the environment variable is not set, the default value will be used. Mutually exclusive with `cli_context`. If neither `docker_host` nor `cli_context` are provided, the value `unix:///var/run/docker.sock` is used.
entrypoint string	Override the entrypoint of the container image.
env dictionary	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 `"true"`) in order to avoid data loss. Please note that if you are passing values in with Jinja2 templates, like `"{{ value }}"`, you need to add `\| string` to prevent Ansible to convert strings such as `"true"` back to booleans. The correct way is to use `"{{ value \| string }}"`.
env_files list / elements=path	By default environment files are loaded from a `.env` file located directly under the `project_src` directory. `env_files` can be used to specify the path of one or multiple custom environment files instead. The path is relative to the `project_src` directory.
files list / elements=path added in community.docker 3.7.0	List of Compose file names relative to `project_src` to be used instead of the main Compose file (`compose.yml`, `compose.yaml`, `docker-compose.yml`, or `docker-compose.yaml`). Files are loaded and merged in the order given. Mutually exclusive with `definition`.
interactive boolean	Whether to keep STDIN open even if not attached. Choices: `false` `true` ← (default)
labels list / elements=string	Add or override labels to the container.
name string	Assign a name to the container.
no_deps boolean	Do not start linked services. Choices: `false` ← (default) `true`
profiles list / elements=string	List of profiles to enable when starting services. Equivalent to `docker compose --profile`.
project_name string	Provide a project name. If not provided, the project name is taken from the basename of `project_src`. Required when `definition` is provided.
project_src path	Path to a directory containing a Compose file (`compose.yml`, `compose.yaml`, `docker-compose.yml`, or `docker-compose.yaml`). If `files` is provided, will look for these files in this directory instead. Mutually exclusive with `definition`. One of `project_src` and `definition` must be provided.
publish list / elements=string	Publish a container’s port(s) to the host.
quiet_pull boolean	Pull without printing progress information. Note that pulling can insert information into `stdout` or `stderr`. Choices: `false` ← (default) `true`
remove_orphans boolean	Remove containers for services not defined in the Compose file. Choices: `false` ← (default) `true`
service string / required	The service to run the command in.
service_ports boolean	Run command with all service’s ports enabled and mapped to the host. Choices: `false` ← (default) `true`
stdin string	Set the stdin of the command directly to the specified value. Can only be used if `detach=false`.
stdin_add_newline boolean	If set to `true`, appends a newline to `stdin`. Choices: `false` `true` ← (default)
strip_empty_ends boolean	Strip empty lines from the end of stdout/stderr in result. Choices: `false` `true` ← (default)
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 `true` as well, it will take precedence. If the value is not specified in the task, the value of environment variable `DOCKER_TLS` will be used instead. If the environment variable is not set, the default value will be used. Choices: `false` ← (default) `true`
tls_hostname string	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 `DOCKER_TLS_HOSTNAME` will be used instead. If the environment variable is not set, the default value will be used.
tty boolean	Whether to allocate a TTY. Choices: `false` `true` ← (default)
use_aliases boolean	Use the service’s network `useAliases` in the network(s) the container connects to. Choices: `false` ← (default) `true`
user string	If specified, the user to execute this command with.
validate_certs aliases: tls_verify 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 `DOCKER_TLS_VERIFY` will be used instead. If the environment variable is not set, the default value will be used. Choices: `false` ← (default) `true`
volumes list / elements=string	Bind mount one or more volumes.

Attributes 

Attribute	Support	Description
action_group	Action groups: community.docker.docker, docker	Use `group/docker` or `group/community.docker.docker` in `module_defaults` to set defaults for this module.
check_mode	Support: none	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Notes 

Note

If you need to evaluate environment variables of the container in command or argv, you need to pass the command through a shell, like command=/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 and 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.
This module does not use the Docker SDK for Python to communicate with the Docker daemon. It directly calls the Docker CLI program.

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
container_id string	The ID of the created container. Returned: success and `detach=true`
rc integer	The exit code of the command. Returned: success and `detach=false` Sample: `0`
stderr string	The standard error output of the container command. Returned: success and `detach=false`
stdout string	The standard output of the container command. Returned: success and `detach=false`

Authors

Felix Fontein (@felixfontein)

community.docker.docker_compose_v2_run module – Run command in a new container of a Compose service

Synopsis 

Requirements 

Parameters 

Attributes 

Notes 

See Also 

Examples 

Return Values 

Authors

Collection links