Skip to content

Commit 69a2af6

Browse files
committed
docker_compose_v2_build: reference in other docs
1 parent 7247b63 commit 69a2af6

File tree

3 files changed

+15
-2
lines changed

3 files changed

+15
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ If you use the Ansible package and do not update collections independently, use
100100
- community.docker.docker_volume_info: retrieve information on Docker volumes
101101
* Docker Compose:
102102
- community.docker.docker_compose_v2: manage Docker Compose files (Docker compose CLI plugin)
103+
- community.docker.docker_compose_v2_build: build images for a Docker compose project
103104
- community.docker.docker_compose_v2_exec: run command in a container of a Compose service
104105
- community.docker.docker_compose_v2_pull: pull a Docker compose project
105106
- community.docker.docker_compose_v2_run: run command in a new container of a Compose service

docs/docsite/rst/scenario_guide.rst

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,13 +258,22 @@ Docker Compose
258258
Docker Compose v2
259259
.................
260260

261-
There are two modules for working with Docker compose projects:
261+
There are five modules for working with Docker compose projects:
262262

263263
community.docker.docker_compose_v2
264264
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.
265265

266+
community.docker.docker_compose_v2_build
267+
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to build images for Docker compose projects.
268+
269+
community.docker.docker_compose_v2_exec
270+
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to run command in a container of a Compose service.
271+
266272
community.docker.docker_compose_v2_pull
267-
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to pull Docker compose projects.
273+
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to pull images for Docker compose projects.
274+
275+
community.docker.docker_compose_v2_run
276+
The :ansplugin:`community.docker.docker_compose_v2_pull module <community.docker.docker_compose_v2_pull#module>` allows you to run command in a new container of a Compose service.
268277

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

plugins/modules/docker_compose_v2.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,10 @@
174174
- Felix Fontein (@felixfontein)
175175
176176
seealso:
177+
- module: community.docker.docker_compose_v2_build
178+
- module: community.docker.docker_compose_v2_exec
177179
- module: community.docker.docker_compose_v2_pull
180+
- module: community.docker.docker_compose_v2_run
178181
"""
179182

180183
EXAMPLES = r"""

0 commit comments

Comments
 (0)