Skip to content

Commit

Permalink
Update documentation to reflect module functionality
Browse files Browse the repository at this point in the history
Clarify that this module is used for accessing information on all stacks
Add link to docker_stack_task_info module for users looking for detailed info on a single stack

Fixes #690
  • Loading branch information
enpaul committed Oct 5, 2023
1 parent 2c633da commit 3c677b8
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions plugins/modules/docker_stack_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,24 @@
---
module: docker_stack_info
author: "Jose Angel Munoz (@imjoseangel)"
short_description: Return information on a docker stack
short_description: Return information on all docker stacks
description:
- Retrieve information on docker stacks using the C(docker stack) command
on the target node (see examples).
extends_documentation_fragment:
- community.docker.attributes
- community.docker.attributes.info_module
seealso:
- module: community.docker.docker_stack_task_info
description: >-
To retrieve detailed information about the services under a specific
stack use the community.docker.docker_stack_task_info module
'''

RETURN = '''
results:
description: |
List of dictionaries containing the list of stacks or tasks associated
to a stack name.
List of dictionaries containing the list of stacks on the target node
sample:
- {"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"}
returned: always
Expand Down

0 comments on commit 3c677b8

Please sign in to comment.