1b38b7c500
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: I727ed95ee480bb644b5a533f6a9526973677064c
95 lines
2.3 KiB
Python
95 lines
2.3 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: group_assignment
|
|
short_description: Associate OpenStack Identity users and groups
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Add and remove users from groups
|
|
options:
|
|
user:
|
|
description:
|
|
- Name or id for the user
|
|
required: true
|
|
type: str
|
|
group:
|
|
description:
|
|
- Name or id for the group.
|
|
required: true
|
|
type: str
|
|
state:
|
|
description:
|
|
- Should the user be present or absent in the group
|
|
choices: [present, absent]
|
|
default: present
|
|
type: str
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Add the demo user to the demo group
|
|
- openstack.cloud.group_assignment:
|
|
cloud: mycloud
|
|
user: demo
|
|
group: demo
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class IdentityGroupAssignment(OpenStackModule):
|
|
argument_spec = dict(
|
|
user=dict(required=True),
|
|
group=dict(required=True),
|
|
state=dict(default='present', choices=['absent', 'present']),
|
|
)
|
|
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def _system_state_change(self, state, in_group):
|
|
if state == 'present' and not in_group:
|
|
return True
|
|
if state == 'absent' and in_group:
|
|
return True
|
|
return False
|
|
|
|
def run(self):
|
|
user = self.params['user']
|
|
group = self.params['group']
|
|
state = self.params['state']
|
|
|
|
in_group = self.conn.is_user_in_group(user, group)
|
|
|
|
if self.ansible.check_mode:
|
|
self.exit_json(changed=self._system_state_change(state, in_group))
|
|
|
|
changed = False
|
|
if state == 'present':
|
|
if not in_group:
|
|
self.conn.add_user_to_group(user, group)
|
|
changed = True
|
|
|
|
elif state == 'absent':
|
|
if in_group:
|
|
self.conn.remove_user_from_group(user, group)
|
|
changed = True
|
|
|
|
self.exit_json(changed=changed)
|
|
|
|
|
|
def main():
|
|
module = IdentityGroupAssignment()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|