Emphasize that docker_compose requires docker-compose < 2.0.0. (#217)

This commit is contained in:
Felix Fontein 2021-10-05 07:30:41 +02:00 committed by GitHub
parent 1b4b45628c
commit a9b238ee81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -17,7 +17,7 @@ short_description: Manage multi-container Docker applications with Docker Compos
author: "Chris Houseknecht (@chouseknecht)"
description:
- Uses Docker Compose to start, shutdown and scale services.
- Uses Docker Compose to start, shutdown and scale services. B(This module requires docker-compose < 2.0.0.)
- Configuration can be read from a C(docker-compose.yml) or C(docker-compose.yaml) file or inline using the I(definition) option.
- See the examples for more details.
- Supports check mode.
@ -176,7 +176,7 @@ extends_documentation_fragment:
requirements:
- "L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 1.8.0 (use L(docker-py,https://pypi.org/project/docker-py/) for Python 2.6)"
- "docker-compose >= 1.7.0"
- "docker-compose >= 1.7.0, < 2.0.0"
- "Docker API >= 1.20"
- "PyYAML >= 3.11"
'''