mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-26 22:51:23 -07:00
Merge pull request #2043 from chrishoffman/rabbitmq
Rabbitmq Module Updates
This commit is contained in:
commit
af3402fe35
4 changed files with 114 additions and 86 deletions
|
@ -20,7 +20,7 @@
|
||||||
- restart rabbitmq
|
- restart rabbitmq
|
||||||
|
|
||||||
- name: add users
|
- name: add users
|
||||||
rabbitmq_user: user=$item password=changeme tags=monitoring,$item vhost="/" configure_priv=".*" write_priv=".*" read_priv=".*" state=present
|
rabbitmq_user: user=$item password=changeme tags=administrator,$item vhost=/ configure_priv=.* write_priv=.* read_priv=.* state=present
|
||||||
with_items:
|
with_items:
|
||||||
- user1
|
- user1
|
||||||
- user2
|
- user2
|
||||||
|
@ -34,4 +34,3 @@
|
||||||
handlers:
|
handlers:
|
||||||
- name: restart rabbitmq
|
- name: restart rabbitmq
|
||||||
service: name=rabbitmq-server state=restarted
|
service: name=rabbitmq-server state=restarted
|
||||||
|
|
||||||
|
|
|
@ -54,22 +54,23 @@ examples:
|
||||||
class RabbitMqPlugins(object):
|
class RabbitMqPlugins(object):
|
||||||
def __init__(self, module):
|
def __init__(self, module):
|
||||||
self.module = module
|
self.module = module
|
||||||
|
self._rabbitmq_plugins = module.get_bin_path('rabbitmq-plugins', True)
|
||||||
|
|
||||||
def _exec(self, args):
|
def _exec(self, args, run_in_check_mode=False):
|
||||||
cmd = ["rabbitmq-plugins"]
|
if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):
|
||||||
|
cmd = [self._rabbitmq_plugins]
|
||||||
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
|
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
|
||||||
return out.splitlines()
|
return out.splitlines()
|
||||||
|
return list()
|
||||||
|
|
||||||
def get_all(self):
|
def get_all(self):
|
||||||
return self._exec(["list", "-E", "-m"])
|
return self._exec(['list', '-E', '-m'], True)
|
||||||
|
|
||||||
def enable(self, name):
|
def enable(self, name):
|
||||||
if not self.module.check_mode:
|
self._exec(['enable', name])
|
||||||
self._exec(["enable", name])
|
|
||||||
|
|
||||||
def disable(self, name):
|
def disable(self, name):
|
||||||
if not self.module.check_mode:
|
self._exec(['disable', name])
|
||||||
self._exec(["disable", name])
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
arg_spec = dict(
|
arg_spec = dict(
|
||||||
|
|
|
@ -82,7 +82,7 @@ options:
|
||||||
default: present
|
default: present
|
||||||
choices: [present, absent]
|
choices: [present, absent]
|
||||||
examples:
|
examples:
|
||||||
- code: rabbitmq_user user=joe password=changeme vhost="/" configure_priv=".*" read_priv=".*" write_priv=".*" state=present
|
- code: rabbitmq_user user=joe password=changeme vhost=/ configure_priv=.* read_priv=.* write_priv=.* state=present
|
||||||
description: Add user to server and assign full access control
|
description: Add user to server and assign full access control
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
@ -92,7 +92,7 @@ class RabbitMqUser(object):
|
||||||
self.username = username
|
self.username = username
|
||||||
self.password = password
|
self.password = password
|
||||||
if tags is None:
|
if tags is None:
|
||||||
self.tags = []
|
self.tags = list()
|
||||||
else:
|
else:
|
||||||
self.tags = tags.split(',')
|
self.tags = tags.split(',')
|
||||||
|
|
||||||
|
@ -106,14 +106,17 @@ class RabbitMqUser(object):
|
||||||
|
|
||||||
self._tags = None
|
self._tags = None
|
||||||
self._permissions = None
|
self._permissions = None
|
||||||
|
self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)
|
||||||
|
|
||||||
def _exec(self, args):
|
def _exec(self, args, run_in_check_mode=False):
|
||||||
cmd = ["rabbitmqctl", "-q"]
|
if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):
|
||||||
|
cmd = [self._rabbitmqctl, '-q']
|
||||||
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
|
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
|
||||||
return out.splitlines()
|
return out.splitlines()
|
||||||
|
return list()
|
||||||
|
|
||||||
def get(self):
|
def get(self):
|
||||||
users = self._exec(["list_users"])
|
users = self._exec(['list_users'], True)
|
||||||
|
|
||||||
for user_tag in users:
|
for user_tag in users:
|
||||||
user, tags = user_tag.split('\t')
|
user, tags = user_tag.split('\t')
|
||||||
|
@ -125,16 +128,14 @@ class RabbitMqUser(object):
|
||||||
if tags != '':
|
if tags != '':
|
||||||
self._tags = tags.split(',')
|
self._tags = tags.split(',')
|
||||||
else:
|
else:
|
||||||
self._tags = []
|
self._tags = list()
|
||||||
|
|
||||||
self._permissions = self._get_permissions()
|
self._permissions = self._get_permissions()
|
||||||
|
|
||||||
return True
|
return True
|
||||||
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
def _get_permissions(self):
|
def _get_permissions(self):
|
||||||
perms_out = self._exec(["list_user_permissions", self.username])
|
perms_out = self._exec(['list_user_permissions', self.username], True)
|
||||||
|
|
||||||
for perm in perms_out:
|
for perm in perms_out:
|
||||||
vhost, configure_priv, write_priv, read_priv = perm.split('\t')
|
vhost, configure_priv, write_priv, read_priv = perm.split('\t')
|
||||||
|
@ -144,21 +145,16 @@ class RabbitMqUser(object):
|
||||||
return dict()
|
return dict()
|
||||||
|
|
||||||
def add(self):
|
def add(self):
|
||||||
if not self.module.check_mode:
|
self._exec(['add_user', self.username, self.password])
|
||||||
self._exec(["add_user", self.username, self.password])
|
|
||||||
|
|
||||||
|
|
||||||
def delete(self):
|
def delete(self):
|
||||||
if not self.module.check_mode:
|
self._exec(['delete_user', self.username])
|
||||||
self._exec(["delete_user", self.username])
|
|
||||||
|
|
||||||
def set_tags(self):
|
def set_tags(self):
|
||||||
if not self.module.check_mode:
|
self._exec(['set_user_tags', self.username] + self.tags)
|
||||||
self._exec(["set_user_tags", self.username] + self.tags)
|
|
||||||
|
|
||||||
def set_permissions(self):
|
def set_permissions(self):
|
||||||
if not self.module.check_mode:
|
cmd = ['set_permissions']
|
||||||
cmd = ["set_permissions"]
|
|
||||||
cmd.append('-p')
|
cmd.append('-p')
|
||||||
cmd.append(self.permissions['vhost'])
|
cmd.append(self.permissions['vhost'])
|
||||||
cmd.append(self.username)
|
cmd.append(self.username)
|
||||||
|
@ -168,18 +164,7 @@ class RabbitMqUser(object):
|
||||||
self._exec(cmd)
|
self._exec(cmd)
|
||||||
|
|
||||||
def has_tags_modifications(self):
|
def has_tags_modifications(self):
|
||||||
if (not self._tags and len(self.tags) > 0) or (not self.tags and len(self._tags) > 0):
|
return set(self.tags) != set(self._tags)
|
||||||
return True
|
|
||||||
else:
|
|
||||||
for tag in self._tags:
|
|
||||||
if tag not in self.tags:
|
|
||||||
return True
|
|
||||||
|
|
||||||
for tag in self.tags:
|
|
||||||
if tag not in self._tags:
|
|
||||||
return True
|
|
||||||
|
|
||||||
return False
|
|
||||||
|
|
||||||
def has_permissions_modifications(self):
|
def has_permissions_modifications(self):
|
||||||
return self._permissions != self.permissions
|
return self._permissions != self.permissions
|
||||||
|
@ -238,7 +223,7 @@ def main():
|
||||||
rabbitmq_user.set_permissions()
|
rabbitmq_user.set_permissions()
|
||||||
changed = True
|
changed = True
|
||||||
|
|
||||||
module.exit_json(changed=changed)
|
module.exit_json(changed=changed, user=username, state=state)
|
||||||
|
|
||||||
# this is magic, see lib/ansible/module_common.py
|
# this is magic, see lib/ansible/module_common.py
|
||||||
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
||||||
|
|
|
@ -31,62 +31,105 @@ options:
|
||||||
- The name of the vhost to manage
|
- The name of the vhost to manage
|
||||||
required: true
|
required: true
|
||||||
default: null
|
default: null
|
||||||
|
aliases: [vhost]
|
||||||
|
tracing:
|
||||||
|
description:
|
||||||
|
Enable/disable tracing for a vhost
|
||||||
|
default: no
|
||||||
|
choices: [yes, no]
|
||||||
|
aliases: [trace]
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- The state of vhost
|
- The state of vhost
|
||||||
required: true
|
default: present
|
||||||
default: null
|
choices: [present, absent]
|
||||||
choices: [ "present", "absent" ]
|
|
||||||
examples:
|
examples:
|
||||||
- code: "rabbitmq_vhost: name=/test state=present"
|
- code: 'rabbitmq_vhost: name=/test state=present'
|
||||||
description: Ensure that the vhost /test exists.
|
description: Ensure that the vhost /test exists.
|
||||||
author: Matt Cordial
|
author: Matt Cordial
|
||||||
'''
|
'''
|
||||||
|
|
||||||
|
class RabbitMqVhost(object):
|
||||||
|
def __init__(self, module, name, tracing):
|
||||||
|
self.module = module
|
||||||
|
self.name = name
|
||||||
|
self.tracing = tracing
|
||||||
|
|
||||||
|
self._tracing = False
|
||||||
|
self._rabbitmqctl = module.get_bin_path('rabbitmqctl', True)
|
||||||
|
|
||||||
|
def _exec(self, args, run_in_check_mode=False):
|
||||||
|
if not self.module.check_mode or (self.module.check_mode and run_in_check_mode):
|
||||||
|
cmd = [self._rabbitmqctl, '-q']
|
||||||
|
rc, out, err = self.module.run_command(cmd + args, check_rc=True)
|
||||||
|
return out.splitlines()
|
||||||
|
return list()
|
||||||
|
|
||||||
|
def get(self):
|
||||||
|
vhosts = self._exec(['list_vhosts', 'name', 'tracing'], True)
|
||||||
|
|
||||||
|
for vhost in vhosts:
|
||||||
|
name, tracing = vhost.split('\t')
|
||||||
|
if name == self.name:
|
||||||
|
self._tracing = self.module.boolean(tracing)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def add(self):
|
||||||
|
return self._exec(['add_vhost', self.name])
|
||||||
|
|
||||||
|
def delete(self):
|
||||||
|
return self._exec(['delete_vhost', self.name])
|
||||||
|
|
||||||
|
def set_tracing(self):
|
||||||
|
if self.tracing != self._tracing:
|
||||||
|
if self.tracing:
|
||||||
|
self._enable_tracing()
|
||||||
|
else:
|
||||||
|
self._disable_tracing()
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _enable_tracing(self):
|
||||||
|
return self._exec(['trace_on', '-p', self.name])
|
||||||
|
|
||||||
|
def _disable_tracing(self):
|
||||||
|
return self._exec(['trace_off', '-p', self.name])
|
||||||
|
|
||||||
|
|
||||||
def main():
|
def main():
|
||||||
arg_spec = dict(
|
arg_spec = dict(
|
||||||
name=dict(required=True),
|
name=dict(required=True, aliases=['vhost']),
|
||||||
state=dict(required=False, choices=['present', 'absent'])
|
tracing=dict(default='off', choices=BOOLEANS, aliases=['trace']),
|
||||||
|
state=dict(default='present', choices=['present', 'absent'])
|
||||||
)
|
)
|
||||||
|
|
||||||
module = AnsibleModule(argument_spec=arg_spec)
|
module = AnsibleModule(
|
||||||
|
argument_spec=arg_spec,
|
||||||
|
supports_check_mode=True
|
||||||
|
)
|
||||||
|
|
||||||
name = module.params['name']
|
name = module.params['name']
|
||||||
|
tracing = module.boolean(module.params['tracing'])
|
||||||
state = module.params['state']
|
state = module.params['state']
|
||||||
|
|
||||||
RABBITMQCTL = module.get_bin_path('rabbitmqctl', True)
|
rabbitmq_vhost = RabbitMqVhost(module, name, tracing)
|
||||||
|
|
||||||
present = False
|
changed = False
|
||||||
rc, out, err = module.run_command('%s list_vhosts' % RABBITMQCTL)
|
if rabbitmq_vhost.get():
|
||||||
for line in out.splitlines():
|
if state == 'absent':
|
||||||
if line.strip() == name:
|
rabbitmq_vhost.delete()
|
||||||
present = True
|
changed = True
|
||||||
break
|
|
||||||
|
|
||||||
if state == 'present' and present:
|
|
||||||
module.exit_json(changed=False, name=name, state=state)
|
|
||||||
|
|
||||||
if state == 'present' and not present:
|
|
||||||
rc, out, err = module.run_command('%s add_vhost %s' % (RABBITMQCTL, name))
|
|
||||||
if '...done' in out:
|
|
||||||
module.exit_json(changed=True, name=name, state=state)
|
|
||||||
else:
|
else:
|
||||||
module.fail_json(msg=out, name=name, state=state)
|
if rabbitmq_vhost.set_tracing():
|
||||||
|
changed = True
|
||||||
|
elif state == 'present':
|
||||||
|
rabbitmq_vhost.add()
|
||||||
|
rabbitmq_vhost.set_tracing()
|
||||||
|
changed = True
|
||||||
|
|
||||||
if state == 'absent' and not present:
|
module.exit_json(changed=changed, name=name, state=state)
|
||||||
module.exit_json(changed=False, name=name, state=state)
|
|
||||||
|
|
||||||
if state == 'absent' and present:
|
|
||||||
rc, out, err = module.run_command('%s delete_vhost %s' % (RABBITMQCTL, name))
|
|
||||||
if '...done' in out:
|
|
||||||
module.exit_json(changed=True, name=name, state=state)
|
|
||||||
else:
|
|
||||||
module.fail_json(msg=out, name=name, state=state)
|
|
||||||
|
|
||||||
module.exit_json(changed=False, name=name, state=state)
|
|
||||||
|
|
||||||
# this is magic, see lib/ansible/module_common.py
|
# this is magic, see lib/ansible/module_common.py
|
||||||
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
#<<INCLUDE_ANSIBLE_MODULE_COMMON>>
|
||||||
|
|
||||||
main()
|
main()
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue