mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
8b0896a43d
* Add docker_stack_task_info with tests
* Change link
* Change ln
* Fix Documentation
* Small doc changes
* Remove node for RH
(cherry picked from commit 107e956565)
95 lines
2.3 KiB
Python
95 lines
2.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2020 Jose Angel Munoz (@imjoseangel)
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: docker_stack_task_info
|
|
author: "Jose Angel Munoz (@imjoseangel)"
|
|
short_description: Return information of the tasks on a docker stack
|
|
description:
|
|
- Retrieve information on docker stacks tasks using the C(docker stack) command
|
|
on the target node (see examples).
|
|
options:
|
|
name:
|
|
description:
|
|
- Stack name.
|
|
type: str
|
|
required: yes
|
|
version_added: "1.1.0"
|
|
'''
|
|
|
|
RETURN = '''
|
|
results:
|
|
description: |
|
|
List of dictionaries containing the list of tasks associated
|
|
to a stack name.
|
|
sample: >
|
|
[{"CurrentState":"Running","DesiredState":"Running","Error":"","ID":"7wqv6m02ugkw","Image":"busybox","Name":"test_stack.1","Node":"swarm","Ports":""}]
|
|
returned: always
|
|
type: list
|
|
elements: dict
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Shows stack info
|
|
community.general.docker_stack_task_info:
|
|
name: test_stack
|
|
register: result
|
|
|
|
- name: Show results
|
|
ansible.builtin.debug:
|
|
var: result.results
|
|
'''
|
|
|
|
import json
|
|
from ansible.module_utils.basic import AnsibleModule
|
|
|
|
|
|
def docker_stack_task(module, stack_name):
|
|
docker_bin = module.get_bin_path('docker', required=True)
|
|
rc, out, err = module.run_command(
|
|
[docker_bin, "stack", "ps", stack_name, "--format={{json .}}"])
|
|
|
|
return rc, out.strip(), err.strip()
|
|
|
|
|
|
def main():
|
|
module = AnsibleModule(
|
|
argument_spec={
|
|
'name': dict(type='str', required=True)
|
|
},
|
|
supports_check_mode=False
|
|
)
|
|
|
|
name = module.params['name']
|
|
|
|
rc, out, err = docker_stack_task(module, name)
|
|
|
|
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()
|