Merge pull request #1784 from SamYaple/devel

Create OpenStack identity services module

cloud/openstack/os_keystone_service.py

@@ -0,0 +1,210 @@
+#!/usr/bin/python
+# Copyright 2016 Sam Yaple
+#
+# This module is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This software is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this software.  If not, see <http://www.gnu.org/licenses/>.
+
+try:
+    import shade
+    HAS_SHADE = True
+except ImportError:
+    HAS_SHADE = False
+
+from distutils.version import StrictVersion
+
+DOCUMENTATION = '''
+---
+module: os_keystone_service
+short_description: Manage OpenStack Identity services
+extends_documentation_fragment: openstack
+author: "Sam Yaple (@SamYaple)"
+version_added: "2.2"
+description:
+    - Create, update, or delete OpenStack Identity service. If a service
+      with the supplied name already exists, it will be updated with the
+      new description and enabled attributes.
+options:
+   name:
+     description:
+        - Name of the service
+     required: true
+   description:
+     description:
+        - Description of the service
+     required: false
+     default: None
+   enabled:
+     description:
+        - Is the service enabled
+     required: false
+     default: True
+   service_type:
+     description:
+        - The type of service
+     required: true
+   state:
+     description:
+       - Should the resource be present or absent.
+     choices: [present, absent]
+     default: present
+requirements:
+    - "python >= 2.6"
+    - "shade"
+'''
+
+EXAMPLES = '''
+# Create a service for glance
+- os_keystone_service:
+     cloud: mycloud
+     state: present
+     name: glance
+     service_type: image
+     description: OpenStack Image Service
+# Delete a service
+- os_keystone_service:
+     cloud: mycloud
+     state: absent
+     name: glance
+     service_type: image
+'''
+
+RETURN = '''
+service:
+    description: Dictionary describing the service.
+    returned: On success when I(state) is 'present'
+    type: dictionary
+    contains:
+        id:
+            description: Service ID.
+            type: string
+            sample: "3292f020780b4d5baf27ff7e1d224c44"
+        name:
+            description: Service name.
+            type: string
+            sample: "glance"
+        service_type:
+            description: Service type.
+            type: string
+            sample: "image"
+        description:
+            description: Service description.
+            type: string
+            sample: "OpenStack Image Service"
+        enabled:
+            description: Service status.
+            type: boolean
+            sample: True
+id:
+    description: The service ID.
+    returned: On success when I(state) is 'present'
+    type: string
+    sample: "3292f020780b4d5baf27ff7e1d224c44"
+'''
+
+
+def _needs_update(module, service):
+    if service.enabled != module.params['enabled']:
+        return True
+    if service.description is not None and \
+       service.description != module.params['description']:
+        return True
+    return False
+
+
+def _system_state_change(module, service):
+    state = module.params['state']
+    if state == 'absent' and service:
+        return True
+
+    if state == 'present':
+        if service is None:
+            return True
+        return _needs_update(module, service)
+
+    return False
+
+
+def main():
+    argument_spec = openstack_full_argument_spec(
+        description=dict(default=None),
+        enabled=dict(default=True, type='bool'),
+        name=dict(required=True),
+        service_type=dict(required=True),
+        state=dict(default='present', choices=['absent', 'present']),
+    )
+
+    module_kwargs = openstack_module_kwargs()
+    module = AnsibleModule(argument_spec,
+                           supports_check_mode=True,
+                           **module_kwargs)
+
+    if not HAS_SHADE:
+        module.fail_json(msg='shade is required for this module')
+    if StrictVersion(shade.__version__) < StrictVersion('1.6.0'):
+        module.fail_json(msg="To utilize this module, the installed version of"
+                             "the shade library MUST be >=1.6.0")
+
+    description = module.params['description']
+    enabled = module.params['enabled']
+    name = module.params['name']
+    state = module.params['state']
+    service_type = module.params['service_type']
+
+    try:
+        cloud = shade.operator_cloud(**module.params)
+
+        services = cloud.search_services(name_or_id=name,
+                                         filters=dict(type=service_type))
+
+        if len(services) > 1:
+            module.fail_json(msg='Service name %s and type %s are not unique' %
+                (name, service_type))
+        elif len(services) == 1:
+            service = services[0]
+        else:
+            service = None
+
+        if module.check_mode:
+            module.exit_json(changed=_system_state_change(module, service))
+
+        if state == 'present':
+            if service is None:
+                service = cloud.create_service(name=name,
+                    description=description, type=service_type, enabled=True)
+                changed = True
+            else:
+                if _needs_update(module, service):
+                    service = cloud.update_service(
+                        service.id, name=name, type=service_type, enabled=enabled,
+                        description=description)
+                    changed = True
+                else:
+                    changed = False
+            module.exit_json(changed=changed, service=service, id=service.id)
+
+        elif state == 'absent':
+            if service is None:
+                changed=False
+            else:
+                cloud.delete_service(service.id)
+                changed=True
+            module.exit_json(changed=changed)
+
+    except shade.OpenStackCloudException as e:
+        module.fail_json(msg=str(e))
+
+
+from ansible.module_utils.basic import *
+from ansible.module_utils.openstack import *
+if __name__ == '__main__':
+    main()