Skip to content

Commit

Permalink
Mention new module in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
felixfontein committed Jan 14, 2024
1 parent 4dd6712 commit d4a5280
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ If you use the Ansible package and do not update collections independently, use
* Docker Compose:
- community.docker.docker_compose: manage Docker Compose files (legacy Docker Compose v1)
- community.docker.docker_compose_v2: manage Docker Compose files (Docker compose CLI plugin)
- community.docker.docker_compose_v2_pull: pull a Docker compose project
* Docker Swarm:
- community.docker.docker_config: manage configurations
- community.docker.docker_node: manage Docker Swarm nodes
Expand Down
12 changes: 9 additions & 3 deletions docs/docsite/rst/scenario_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,15 @@ Docker Compose
Docker Compose v2
.................

The :ansplugin:`community.docker.docker_compose_v2 module <community.docker.docker_compose_v2#module>`
allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm.
This module uses the Docker CLI "compose" plugin (``docker compose``), and thus needs access to the Docker CLI tool.
There are two modules for working with Docker compose projects:

community.docker.docker_compose_v2
The :ansplugin:`community.docker.docker_compose_v2 module <community.docker.docker_compose_v2#module>` allows you to use your existing Docker compose files to orchestrate containers on a single Docker daemon or on Swarm.

community.docker.docker_compose_v2_pull
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to pull Docker compose projects.

These modules use the Docker CLI "compose" plugin (``docker compose``), and thus needs access to the Docker CLI tool.
No further requirements next to to the CLI tool and its Docker Compose plugin are needed.

Docker Compose v1
Expand Down

0 comments on commit d4a5280

Please sign in to comment.