mirror of
https://github.com/ansible-collections/community.docker.git
synced 2025-12-16 20:08:41 +00:00
78801088ae
* 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>
93 lines
2.4 KiB
Python
93 lines
2.4 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2020 Jose Angel Munoz (@imjoseangel)
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: docker_stack_info
|
|
author: "Jose Angel Munoz (@imjoseangel)"
|
|
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 on the target node
|
|
sample:
|
|
- {"name":"grafana","namespace":"default","orchestrator":"Kubernetes","services":"2"}
|
|
returned: always
|
|
type: list
|
|
elements: dict
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Shows stack info
|
|
community.docker.docker_stack_info:
|
|
register: result
|
|
|
|
- name: Show results
|
|
ansible.builtin.debug:
|
|
var: result.results
|
|
'''
|
|
|
|
import json
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def docker_stack_list(module):
|
|
docker_bin = module.get_bin_path('docker', required=True)
|
|
rc, out, err = module.run_command(
|
|
[docker_bin, "stack", "ls", "--format={{json .}}"])
|
|
|
|
return rc, out.strip(), err.strip()
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec={
|
|
},
|
|
supports_check_mode=True
|
|
)
|
|
|
|
rc, out, err = docker_stack_list(module)
|
|
|
|
if rc != 0:
|
|
module.fail_json(msg="Error running docker stack. {0}".format(err),
|
|
rc=rc, stdout=out, stderr=err)
|
|
else:
|
|
if out:
|
|
ret = list(
|
|
json.loads(outitem)
|
|
for outitem in out.splitlines())
|
|
|
|
else:
|
|
ret = []
|
|
|
|
module.exit_json(changed=False,
|
|
rc=rc,
|
|
stdout=out,
|
|
stderr=err,
|
|
results=ret)
|
|
|
|
|
|
if __name__ == "__main__":
|
|
main()
|