community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose.
+community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1
Note
This module is part of the community.docker collection (version 3.6.0).
@@ -179,14 +186,15 @@ see ParametersSynopsis
-
-
Uses Docker Compose to start, shutdown and scale services. This module requires docker-compose < 2.0.0.
+Uses Docker Compose to start, shutdown and scale services. This module requires docker-compose < 2.0.0. Use the community.docker.docker_compose_v2 module for using the modern Docker compose CLI plugin.
Configuration can be read from a
docker-compose.ymlordocker-compose.yamlfile or inline using thedefinitionoption.See the examples for more details.
Supports check mode.
@@ -314,7 +322,7 @@ see
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.
Default: "unix://var/run/docker.sock"
Default: "unix:///var/run/docker.sock"
See Also
+See also
+-
+
- community.docker.docker_compose_v2
Manage multi-container Docker applications with Docker Compose CLI plugin.
+
+
Examples
+Examples
# Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the
# flask directory
@@ -793,7 +811,7 @@ see
-Return Values
+Return Values
Common return values are documented here, the following are the fields unique to this module:
+