From 78801088ae2f88adeadf9528c8d1e3594b5836cf Mon Sep 17 00:00:00 2001 From: Ethan Paul <24588726+enpaul@users.noreply.github.com> Date: Sat, 7 Oct 2023 08:04:59 -0400 Subject: [PATCH] Update `docker_stack_info` module documentation to clarify functionality (#693) * 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 --- plugins/modules/docker_stack_info.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/plugins/modules/docker_stack_info.py b/plugins/modules/docker_stack_info.py index bf3bfbdb..5085055d 100644 --- a/plugins/modules/docker_stack_info.py +++ b/plugins/modules/docker_stack_info.py @@ -13,20 +13,24 @@ DOCUMENTATION = ''' --- 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 M(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