2020-05-12 10:20:09 -05:00
|
|
|
#!/usr/bin/python
|
|
|
|
|
|
|
|
# Copyright: (c) 2017, VEXXHOST, Inc.
|
|
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
|
|
---
|
|
|
|
module: endpoint
|
|
|
|
short_description: Manage OpenStack Identity service endpoints
|
2020-06-17 12:35:09 -05:00
|
|
|
author: OpenStack Ansible SIG
|
2020-05-12 10:20:09 -05:00
|
|
|
description:
|
|
|
|
- Create, update, or delete OpenStack Identity service endpoints. If a
|
|
|
|
service with the same combination of I(service), I(interface) and I(region)
|
|
|
|
exist, the I(url) and I(state) (C(present) or C(absent)) will be updated.
|
|
|
|
options:
|
|
|
|
service:
|
|
|
|
description:
|
|
|
|
- Name or id of the service.
|
|
|
|
required: true
|
|
|
|
type: str
|
|
|
|
endpoint_interface:
|
|
|
|
description:
|
|
|
|
- Interface of the service.
|
|
|
|
choices: [admin, public, internal]
|
|
|
|
required: true
|
|
|
|
type: str
|
|
|
|
url:
|
|
|
|
description:
|
|
|
|
- URL of the service.
|
|
|
|
required: true
|
|
|
|
type: str
|
|
|
|
region:
|
|
|
|
description:
|
|
|
|
- Region that the service belongs to. Note that I(region_name) is used for authentication.
|
|
|
|
type: str
|
|
|
|
enabled:
|
|
|
|
description:
|
|
|
|
- Is the service enabled.
|
|
|
|
default: True
|
|
|
|
type: bool
|
|
|
|
state:
|
|
|
|
description:
|
|
|
|
- Should the resource be C(present) or C(absent).
|
|
|
|
choices: [present, absent]
|
|
|
|
default: present
|
|
|
|
type: str
|
|
|
|
requirements:
|
|
|
|
- "python >= 3.6"
|
|
|
|
- "openstacksdk >= 0.13.0"
|
|
|
|
|
|
|
|
extends_documentation_fragment:
|
|
|
|
- openstack.cloud.openstack
|
|
|
|
'''
|
|
|
|
|
|
|
|
EXAMPLES = '''
|
|
|
|
- name: Create a service for glance
|
|
|
|
openstack.cloud.endpoint:
|
|
|
|
cloud: mycloud
|
|
|
|
service: glance
|
|
|
|
endpoint_interface: public
|
|
|
|
url: http://controller:9292
|
|
|
|
region: RegionOne
|
|
|
|
state: present
|
|
|
|
|
|
|
|
- name: Delete a service for nova
|
|
|
|
openstack.cloud.endpoint:
|
|
|
|
cloud: mycloud
|
|
|
|
service: nova
|
|
|
|
endpoint_interface: public
|
|
|
|
region: RegionOne
|
|
|
|
state: absent
|
|
|
|
'''
|
|
|
|
|
|
|
|
RETURN = '''
|
|
|
|
endpoint:
|
|
|
|
description: Dictionary describing the endpoint.
|
|
|
|
returned: On success when I(state) is C(present)
|
|
|
|
type: complex
|
|
|
|
contains:
|
|
|
|
id:
|
|
|
|
description: Endpoint ID.
|
|
|
|
type: str
|
|
|
|
sample: 3292f020780b4d5baf27ff7e1d224c44
|
|
|
|
region:
|
|
|
|
description: Region Name.
|
|
|
|
type: str
|
|
|
|
sample: RegionOne
|
|
|
|
service_id:
|
|
|
|
description: Service ID.
|
|
|
|
type: str
|
|
|
|
sample: b91f1318f735494a825a55388ee118f3
|
|
|
|
interface:
|
|
|
|
description: Endpoint Interface.
|
|
|
|
type: str
|
|
|
|
sample: public
|
|
|
|
url:
|
|
|
|
description: Service URL.
|
|
|
|
type: str
|
|
|
|
sample: http://controller:9292
|
|
|
|
enabled:
|
|
|
|
description: Service status.
|
|
|
|
type: bool
|
|
|
|
sample: True
|
|
|
|
'''
|
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
class IdentityEndpointModule(OpenStackModule):
|
|
|
|
argument_spec = dict(
|
2020-05-12 10:20:09 -05:00
|
|
|
service=dict(type='str', required=True),
|
|
|
|
endpoint_interface=dict(type='str', required=True, choices=['admin', 'public', 'internal']),
|
|
|
|
url=dict(type='str', required=True),
|
|
|
|
region=dict(type='str'),
|
|
|
|
enabled=dict(type='bool', default=True),
|
|
|
|
state=dict(type='str', default='present', choices=['absent', 'present']),
|
|
|
|
)
|
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
module_kwargs = dict(
|
|
|
|
supports_check_mode=True
|
|
|
|
)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
def _needs_update(self, endpoint):
|
|
|
|
if endpoint.enabled != self.params['enabled']:
|
|
|
|
return True
|
|
|
|
if endpoint.url != self.params['url']:
|
|
|
|
return True
|
|
|
|
return False
|
|
|
|
|
|
|
|
def _system_state_change(self, endpoint):
|
|
|
|
state = self.params['state']
|
|
|
|
if state == 'absent' and endpoint:
|
|
|
|
return True
|
2020-05-12 10:20:09 -05:00
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
if state == 'present':
|
|
|
|
if endpoint is None:
|
|
|
|
return True
|
|
|
|
return self._needs_update(endpoint)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
return False
|
|
|
|
|
|
|
|
def run(self):
|
|
|
|
service_name_or_id = self.params['service']
|
|
|
|
interface = self.params['endpoint_interface']
|
|
|
|
url = self.params['url']
|
|
|
|
region = self.params['region']
|
|
|
|
enabled = self.params['enabled']
|
|
|
|
state = self.params['state']
|
|
|
|
|
|
|
|
service = self.conn.get_service(service_name_or_id)
|
2020-11-16 10:35:20 +02:00
|
|
|
if service is None and state == 'absent':
|
2021-05-20 17:50:45 +02:00
|
|
|
self.exit_json(changed=False)
|
2020-11-16 10:35:20 +02:00
|
|
|
|
|
|
|
elif service is None and state == 'present':
|
2021-05-20 17:50:45 +02:00
|
|
|
self.fail_json(msg='Service %s does not exist' % service_name_or_id)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
filters = dict(service_id=service.id, interface=interface)
|
|
|
|
if region is not None:
|
|
|
|
filters['region'] = region
|
2021-05-20 17:50:45 +02:00
|
|
|
endpoints = self.conn.search_endpoints(filters=filters)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
if len(endpoints) > 1:
|
2021-05-20 17:50:45 +02:00
|
|
|
self.fail_json(msg='Service %s, interface %s and region %s are '
|
|
|
|
'not unique' %
|
|
|
|
(service_name_or_id, interface, region))
|
2020-05-12 10:20:09 -05:00
|
|
|
elif len(endpoints) == 1:
|
|
|
|
endpoint = endpoints[0]
|
|
|
|
else:
|
|
|
|
endpoint = None
|
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
if self.ansible.check_mode:
|
|
|
|
self.exit_json(changed=self._system_state_change(endpoint))
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
if state == 'present':
|
|
|
|
if endpoint is None:
|
2021-05-20 17:50:45 +02:00
|
|
|
result = self.conn.create_endpoint(
|
|
|
|
service_name_or_id=service, url=url, interface=interface,
|
|
|
|
region=region, enabled=enabled)
|
2020-05-12 10:20:09 -05:00
|
|
|
endpoint = result[0]
|
|
|
|
changed = True
|
|
|
|
else:
|
2021-05-20 17:50:45 +02:00
|
|
|
if self._needs_update(endpoint):
|
|
|
|
endpoint = self.conn.update_endpoint(
|
2020-05-12 10:20:09 -05:00
|
|
|
endpoint.id, url=url, enabled=enabled)
|
|
|
|
changed = True
|
|
|
|
else:
|
|
|
|
changed = False
|
2021-05-20 17:50:45 +02:00
|
|
|
self.exit_json(changed=changed, endpoint=endpoint)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
elif state == 'absent':
|
|
|
|
if endpoint is None:
|
|
|
|
changed = False
|
|
|
|
else:
|
2021-05-20 17:50:45 +02:00
|
|
|
self.conn.delete_endpoint(endpoint.id)
|
2020-05-12 10:20:09 -05:00
|
|
|
changed = True
|
2021-05-20 17:50:45 +02:00
|
|
|
self.exit_json(changed=changed)
|
2020-05-12 10:20:09 -05:00
|
|
|
|
2021-05-20 17:50:45 +02:00
|
|
|
|
|
|
|
def main():
|
|
|
|
module = IdentityEndpointModule()
|
|
|
|
module()
|
2020-05-12 10:20:09 -05:00
|
|
|
|
|
|
|
|
|
|
|
if __name__ == '__main__':
|
|
|
|
main()
|