ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 20:08:41 +00:00
Code Packages Projects Releases Wiki Activity

Update docker_stack_info module documentation to clarify functionality (#693)

Browse Source 
* Update documentation to reflect module functionality

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

* Remove trailing whitespace, add trailing period.

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
Ethan Paul 2023-10-07 08:04:59 -04:00 committed by GitHub
parent 2c633dadeb
commit 78801088ae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/modules/docker_stack_info.py
View File

@ -13,20 +13,24 @@ DOCUMENTATION = '''
--- ---
module: docker_stack_info module: docker_stack_info
author: "Jose Angel Munoz (@imjoseangel)" author: "Jose Angel Munoz (@imjoseangel)"
short_description: Return information on a docker stack short_description: Return information on all docker stacks
description: description:
- Retrieve information on docker stacks using the C(docker stack) command - Retrieve information on docker stacks using the C(docker stack) command
on the target node (see examples). on the target node (see examples).
extends_documentation_fragment: extends_documentation_fragment:
- community.docker.attributes - community.docker.attributes
- community.docker.attributes.info_module - 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 M(community.docker.docker_stack_task_info) module.
''' '''
RETURN = ''' RETURN = '''
results: results:
description: | description: |
List of dictionaries containing the list of stacks or tasks associated List of dictionaries containing the list of stacks on the target node
to a stack name.
sample: sample:
- {"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"} - {"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"}
returned: always returned: always