mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-05-07 05:43:15 +00:00
Refactored lb_{health_monitor,listener,member,pool} modules
Change-Id: Iffd6ffb08aae4cbd84e4cade79993d82e8c2b2de
This commit is contained in:
Jakob Meng
@@ -4,259 +4,332 @@
|
||||
# Copyright (c) 2018 Catalyst Cloud Ltd.
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: lb_pool
|
||||
short_description: Add/Delete a pool in the load balancing service from OpenStack Cloud
|
||||
short_description: Manage load-balancer pool in a OpenStack cloud.
|
||||
author: OpenStack Ansible SIG
|
||||
description:
|
||||
- Add or Remove a pool from the OpenStack load-balancer service.
|
||||
- Add, update or remove load-balancer pool from OpenStack cloud.
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Name that has to be given to the pool
|
||||
required: true
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
type: str
|
||||
loadbalancer:
|
||||
description:
|
||||
- The name or id of the load balancer that this pool belongs to.
|
||||
Either loadbalancer or listener must be specified for pool creation.
|
||||
type: str
|
||||
listener:
|
||||
description:
|
||||
- The name or id of the listener that this pool belongs to.
|
||||
Either loadbalancer or listener must be specified for pool creation.
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- The protocol for the pool.
|
||||
choices: [HTTP, HTTPS, PROXY, TCP, UDP]
|
||||
default: HTTP
|
||||
type: str
|
||||
lb_algorithm:
|
||||
description:
|
||||
- The load balancing algorithm for the pool.
|
||||
choices: [LEAST_CONNECTIONS, ROUND_ROBIN, SOURCE_IP]
|
||||
default: ROUND_ROBIN
|
||||
type: str
|
||||
wait:
|
||||
description:
|
||||
- If the module should wait for the pool to be ACTIVE.
|
||||
type: bool
|
||||
default: 'yes'
|
||||
timeout:
|
||||
description:
|
||||
- The amount of time the module should wait for the pool to get
|
||||
into ACTIVE state.
|
||||
default: 180
|
||||
type: int
|
||||
requirements:
|
||||
- "python >= 3.6"
|
||||
- "openstacksdk"
|
||||
|
||||
extends_documentation_fragment:
|
||||
- openstack.cloud.openstack
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
id:
|
||||
description: The pool UUID.
|
||||
returned: On success when I(state) is 'present'
|
||||
description:
|
||||
description:
|
||||
- A human-readable description for the load-balancer pool.
|
||||
type: str
|
||||
sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
|
||||
listener:
|
||||
description: Dictionary describing the pool.
|
||||
returned: On success when I(state) is 'present'
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description: Unique UUID.
|
||||
type: str
|
||||
sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
|
||||
name:
|
||||
description: Name given to the pool.
|
||||
type: str
|
||||
sample: "test"
|
||||
description:
|
||||
description: The pool description.
|
||||
type: str
|
||||
sample: "description"
|
||||
loadbalancers:
|
||||
description: A list of load balancer IDs.
|
||||
type: list
|
||||
sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}]
|
||||
listeners:
|
||||
description: A list of listener IDs.
|
||||
type: list
|
||||
sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}]
|
||||
members:
|
||||
description: A list of member IDs.
|
||||
type: list
|
||||
sample: [{"id": "b32eef7e-d2a6-4ea4-a301-60a873f89b3b"}]
|
||||
loadbalancer_id:
|
||||
description: The load balancer ID the pool belongs to. This field is set when the pool doesn't belong to any listener in the load balancer.
|
||||
type: str
|
||||
sample: "7c4be3f8-9c2f-11e8-83b3-44a8422643a4"
|
||||
listener_id:
|
||||
description: The listener ID the pool belongs to.
|
||||
type: str
|
||||
sample: "956aa716-9c2f-11e8-83b3-44a8422643a4"
|
||||
provisioning_status:
|
||||
description: The provisioning status of the pool.
|
||||
type: str
|
||||
sample: "ACTIVE"
|
||||
operating_status:
|
||||
description: The operating status of the pool.
|
||||
type: str
|
||||
sample: "ONLINE"
|
||||
is_admin_state_up:
|
||||
description: The administrative state of the pool.
|
||||
type: bool
|
||||
sample: true
|
||||
protocol:
|
||||
description: The protocol for the pool.
|
||||
type: str
|
||||
sample: "HTTP"
|
||||
lb_algorithm:
|
||||
description: The load balancing algorithm for the pool.
|
||||
type: str
|
||||
sample: "ROUND_ROBIN"
|
||||
lb_algorithm:
|
||||
description:
|
||||
- The load balancing algorithm for the pool.
|
||||
- For example, I(lb_algorithm) could be C(LEAST_CONNECTIONS),
|
||||
C(ROUND_ROBIN), C(SOURCE_IP) or C(SOURCE_IP_PORT).
|
||||
default: ROUND_ROBIN
|
||||
type: str
|
||||
listener:
|
||||
description:
|
||||
- The name or id of the listener that this pool belongs to.
|
||||
- Either I(listener) or I(loadbalancer) must be specified for pool
|
||||
creation.
|
||||
- This attribute cannot be updated.
|
||||
type: str
|
||||
loadbalancer:
|
||||
description:
|
||||
- The name or id of the load balancer that this pool belongs to.
|
||||
- Either I(listener) or I(loadbalancer) must be specified for pool
|
||||
creation.
|
||||
- This attribute cannot be updated.
|
||||
type: str
|
||||
name:
|
||||
description:
|
||||
- Name that has to be given to the pool.
|
||||
- This attribute cannot be updated.
|
||||
required: true
|
||||
type: str
|
||||
protocol:
|
||||
description:
|
||||
- The protocol for the pool.
|
||||
- For example, I(protocol) could be C(HTTP), C(HTTPS), C(PROXY),
|
||||
C(PROXYV2), C(SCTP), C(TCP) and C(UDP).
|
||||
- This attribute cannot be updated.
|
||||
default: HTTP
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- Should the resource be present or absent.
|
||||
choices: [present, absent]
|
||||
default: present
|
||||
type: str
|
||||
requirements:
|
||||
- "python >= 3.6"
|
||||
- "openstacksdk"
|
||||
extends_documentation_fragment:
|
||||
- openstack.cloud.openstack
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Create a pool, wait for the pool to be active.
|
||||
- openstack.cloud.lb_pool:
|
||||
RETURN = r'''
|
||||
pool:
|
||||
description: Dictionary describing the load-balancer pool.
|
||||
returned: On success when I(state) is C(present).
|
||||
type: dict
|
||||
contains:
|
||||
alpn_protocols:
|
||||
description: List of ALPN protocols.
|
||||
type: list
|
||||
created_at:
|
||||
description: Timestamp when the pool was created.
|
||||
type: str
|
||||
description:
|
||||
description: The pool description.
|
||||
type: str
|
||||
health_monitor_id:
|
||||
description: Health Monitor ID.
|
||||
type: str
|
||||
id:
|
||||
description: Unique UUID.
|
||||
type: str
|
||||
is_admin_state_up:
|
||||
description: The administrative state of the pool.
|
||||
type: bool
|
||||
lb_algorithm:
|
||||
description: The load balancing algorithm for the pool.
|
||||
type: str
|
||||
listener_id:
|
||||
description: The listener ID the pool belongs to.
|
||||
type: str
|
||||
listeners:
|
||||
description: A list of listener IDs.
|
||||
type: list
|
||||
loadbalancer_id:
|
||||
description: The load balancer ID the pool belongs to. This field is set
|
||||
when the pool does not belong to any listener in the load
|
||||
balancer.
|
||||
type: str
|
||||
loadbalancers:
|
||||
description: A list of load balancer IDs.
|
||||
type: list
|
||||
members:
|
||||
description: A list of member IDs.
|
||||
type: list
|
||||
name:
|
||||
description: Name given to the pool.
|
||||
type: str
|
||||
operating_status:
|
||||
description: The operating status of the pool.
|
||||
type: str
|
||||
project_id:
|
||||
description: The ID of the project.
|
||||
type: str
|
||||
protocol:
|
||||
description: The protocol for the pool.
|
||||
type: str
|
||||
provisioning_status:
|
||||
description: The provisioning status of the pool.
|
||||
type: str
|
||||
session_persistence:
|
||||
description: A JSON object specifying the session persistence for the
|
||||
pool.
|
||||
type: dict
|
||||
tags:
|
||||
description: A list of associated tags.
|
||||
type: list
|
||||
tls_ciphers:
|
||||
description: Stores a string of cipher strings in OpenSSL format.
|
||||
type: str
|
||||
tls_enabled:
|
||||
description: Use TLS for connections to backend member servers.
|
||||
type: bool
|
||||
tls_versions:
|
||||
description: A list of TLS protocol versions to be used in by the pool.
|
||||
type: list
|
||||
updated_at:
|
||||
description: Timestamp when the pool was updated.
|
||||
type: str
|
||||
'''
|
||||
|
||||
EXAMPLES = r'''
|
||||
- name: Create a load-balander pool
|
||||
openstack.cloud.lb_pool:
|
||||
cloud: mycloud
|
||||
endpoint_type: admin
|
||||
state: present
|
||||
name: test-pool
|
||||
loadbalancer: test-loadbalancer
|
||||
protocol: HTTP
|
||||
lb_algorithm: ROUND_ROBIN
|
||||
|
||||
# Delete a pool
|
||||
- openstack.cloud.lb_pool:
|
||||
cloud: mycloud
|
||||
endpoint_type: admin
|
||||
state: absent
|
||||
loadbalancer: test-loadbalancer
|
||||
name: test-pool
|
||||
'''
|
||||
protocol: HTTP
|
||||
state: present
|
||||
|
||||
import time
|
||||
- name: Delete a load-balander pool
|
||||
openstack.cloud.lb_pool:
|
||||
cloud: mycloud
|
||||
name: test-pool
|
||||
state: absent
|
||||
'''
|
||||
|
||||
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
||||
|
||||
|
||||
class LoadbalancerPoolModule(OpenStackModule):
|
||||
class LoadBalancerPoolModule(OpenStackModule):
|
||||
argument_spec = dict(
|
||||
name=dict(required=True),
|
||||
state=dict(default='present', choices=['absent', 'present']),
|
||||
loadbalancer=dict(),
|
||||
description=dict(),
|
||||
lb_algorithm=dict(default='ROUND_ROBIN'),
|
||||
listener=dict(),
|
||||
protocol=dict(default='HTTP',
|
||||
choices=['HTTP', 'HTTPS', 'TCP', 'UDP', 'PROXY']),
|
||||
lb_algorithm=dict(
|
||||
default='ROUND_ROBIN',
|
||||
choices=['ROUND_ROBIN', 'LEAST_CONNECTIONS', 'SOURCE_IP']
|
||||
)
|
||||
loadbalancer=dict(),
|
||||
name=dict(required=True),
|
||||
protocol=dict(default='HTTP'),
|
||||
state=dict(default='present', choices=['absent', 'present']),
|
||||
)
|
||||
module_kwargs = dict(
|
||||
mutually_exclusive=[['loadbalancer', 'listener']]
|
||||
required_if=[
|
||||
('state', 'present', ('listener', 'loadbalancer'), True),
|
||||
],
|
||||
mutually_exclusive=[
|
||||
('listener', 'loadbalancer')
|
||||
],
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
def _wait_for_pool_status(self, pool_id, status, failures,
|
||||
interval=5):
|
||||
timeout = self.params['timeout']
|
||||
|
||||
total_sleep = 0
|
||||
if failures is None:
|
||||
failures = []
|
||||
|
||||
while total_sleep < timeout:
|
||||
pool = self.conn.load_balancer.get_pool(pool_id)
|
||||
provisioning_status = pool.provisioning_status
|
||||
if provisioning_status == status:
|
||||
return pool
|
||||
if provisioning_status in failures:
|
||||
self.fail_json(
|
||||
msg="pool %s transitioned to failure state %s" %
|
||||
(pool_id, provisioning_status)
|
||||
)
|
||||
|
||||
time.sleep(interval)
|
||||
total_sleep += interval
|
||||
|
||||
self.fail_json(
|
||||
msg="timeout waiting for pool %s to transition to %s" %
|
||||
(pool_id, status)
|
||||
)
|
||||
|
||||
def run(self):
|
||||
loadbalancer = self.params['loadbalancer']
|
||||
listener = self.params['listener']
|
||||
state = self.params['state']
|
||||
|
||||
changed = False
|
||||
pool = self.conn.load_balancer.find_pool(name_or_id=self.params['name'])
|
||||
pool = self._find()
|
||||
|
||||
if self.params['state'] == 'present':
|
||||
if not pool:
|
||||
loadbalancer_id = None
|
||||
if not (loadbalancer or listener):
|
||||
self.fail_json(
|
||||
msg="either loadbalancer or listener must be provided"
|
||||
)
|
||||
if self.ansible.check_mode:
|
||||
self.exit_json(changed=self._will_change(state, pool))
|
||||
|
||||
if loadbalancer:
|
||||
lb = self.conn.load_balancer.find_load_balancer(loadbalancer)
|
||||
if not lb:
|
||||
self.fail_json(
|
||||
msg='load balancer %s is not found' % loadbalancer)
|
||||
loadbalancer_id = lb.id
|
||||
if state == 'present' and not pool:
|
||||
# Create pool
|
||||
pool = self._create()
|
||||
self.exit_json(changed=True,
|
||||
pool=pool.to_dict(computed=False))
|
||||
|
||||
listener_id = None
|
||||
if listener:
|
||||
listener_ret = self.conn.load_balancer.find_listener(listener)
|
||||
if not listener_ret:
|
||||
self.fail_json(
|
||||
msg='listener %s is not found' % listener)
|
||||
listener_id = listener_ret.id
|
||||
elif state == 'present' and pool:
|
||||
# Update pool
|
||||
update = self._build_update(pool)
|
||||
if update:
|
||||
pool = self._update(pool, update)
|
||||
|
||||
pool = self.conn.load_balancer.create_pool(
|
||||
name=self.params['name'],
|
||||
loadbalancer_id=loadbalancer_id,
|
||||
listener_id=listener_id,
|
||||
protocol=self.params['protocol'],
|
||||
lb_algorithm=self.params['lb_algorithm']
|
||||
)
|
||||
changed = True
|
||||
self.exit_json(changed=bool(update),
|
||||
pool=pool.to_dict(computed=False))
|
||||
|
||||
if not self.params['wait']:
|
||||
self.exit_json(
|
||||
changed=changed, pool=pool.to_dict(), id=pool.id)
|
||||
elif state == 'absent' and pool:
|
||||
# Delete pool
|
||||
self._delete(pool)
|
||||
self.exit_json(changed=True)
|
||||
|
||||
if self.params['wait']:
|
||||
pool = self._wait_for_pool_status(
|
||||
pool.id, "ACTIVE", ["ERROR"])
|
||||
elif state == 'absent' and not pool:
|
||||
# Do nothing
|
||||
self.exit_json(changed=False)
|
||||
|
||||
self.exit_json(
|
||||
changed=changed, pool=pool.to_dict(), id=pool.id)
|
||||
def _build_update(self, pool):
|
||||
update = {}
|
||||
|
||||
elif self.params['state'] == 'absent':
|
||||
if pool:
|
||||
self.conn.load_balancer.delete_pool(pool)
|
||||
changed = True
|
||||
non_updateable_keys = [k for k in ['protocol']
|
||||
if self.params[k] is not None
|
||||
and self.params[k] != pool[k]]
|
||||
|
||||
self.exit_json(changed=changed)
|
||||
listener_name_or_id = self.params['listener']
|
||||
if listener_name_or_id:
|
||||
listener = self.conn.load_balancer.find_listener(
|
||||
listener_name_or_id, ignore_missing=False)
|
||||
# Field listener_id is not returned from self.conn.load_balancer.\
|
||||
# find_listener() so use listeners instead.
|
||||
if pool['listeners'] != [dict(id=listener.id)]:
|
||||
non_updateable_keys.append('listener_id')
|
||||
|
||||
loadbalancer_name_or_id = self.params['loadbalancer']
|
||||
if loadbalancer_name_or_id:
|
||||
loadbalancer = self.conn.load_balancer.find_load_balancer(
|
||||
loadbalancer_name_or_id, ignore_missing=False)
|
||||
# Field load_balancer_id is not returned from self.conn.\
|
||||
# load_balancer.find_load_balancer() so use load_balancers instead.
|
||||
if listener['load_balancers'] != [dict(id=loadbalancer.id)]:
|
||||
non_updateable_keys.append('loadbalancer_id')
|
||||
|
||||
if non_updateable_keys:
|
||||
self.fail_json(msg='Cannot update parameters {0}'
|
||||
.format(non_updateable_keys))
|
||||
|
||||
attributes = dict((k, self.params[k])
|
||||
for k in ['description', 'lb_algorithm']
|
||||
if self.params[k] is not None
|
||||
and self.params[k] != pool[k])
|
||||
|
||||
if attributes:
|
||||
update['attributes'] = attributes
|
||||
|
||||
return update
|
||||
|
||||
def _create(self):
|
||||
kwargs = dict((k, self.params[k])
|
||||
for k in ['description', 'name', 'protocol',
|
||||
'lb_algorithm']
|
||||
if self.params[k] is not None)
|
||||
|
||||
listener_name_or_id = self.params['listener']
|
||||
if listener_name_or_id:
|
||||
listener = self.conn.load_balancer.find_listener(
|
||||
listener_name_or_id, ignore_missing=False)
|
||||
kwargs['listener_id'] = listener.id
|
||||
|
||||
loadbalancer_name_or_id = self.params['loadbalancer']
|
||||
if loadbalancer_name_or_id:
|
||||
loadbalancer = self.conn.load_balancer.find_load_balancer(
|
||||
loadbalancer_name_or_id, ignore_missing=False)
|
||||
kwargs['loadbalancer_id'] = loadbalancer.id
|
||||
|
||||
pool = self.conn.load_balancer.create_pool(**kwargs)
|
||||
|
||||
if self.params['wait']:
|
||||
pool = self.sdk.resource.wait_for_status(
|
||||
self.conn.load_balancer, pool,
|
||||
status='active',
|
||||
failures=['error'],
|
||||
wait=self.params['timeout'],
|
||||
attribute='provisioning_status')
|
||||
|
||||
return pool
|
||||
|
||||
def _delete(self, pool):
|
||||
self.conn.load_balancer.delete_pool(pool.id)
|
||||
|
||||
if self.params['wait']:
|
||||
for count in self.sdk.utils.iterate_timeout(
|
||||
timeout=self.params['timeout'],
|
||||
message="Timeout waiting for load-balancer pool to be absent"
|
||||
):
|
||||
if self.conn.load_balancer.\
|
||||
find_pool(pool.id) is None:
|
||||
break
|
||||
|
||||
def _find(self):
|
||||
name = self.params['name']
|
||||
return self.conn.load_balancer.find_pool(name_or_id=name)
|
||||
|
||||
def _update(self, pool, update):
|
||||
attributes = update.get('attributes')
|
||||
if attributes:
|
||||
pool = self.conn.load_balancer.update_pool(pool.id, **attributes)
|
||||
|
||||
if self.params['wait']:
|
||||
pool = self.sdk.resource.wait_for_status(
|
||||
self.conn.load_balancer, pool,
|
||||
status='active',
|
||||
failures=['error'],
|
||||
wait=self.params['timeout'],
|
||||
attribute='provisioning_status')
|
||||
|
||||
return pool
|
||||
|
||||
def _will_change(self, state, pool):
|
||||
if state == 'present' and not pool:
|
||||
return True
|
||||
elif state == 'present' and pool:
|
||||
return bool(self._build_update(pool))
|
||||
elif state == 'absent' and pool:
|
||||
return True
|
||||
else:
|
||||
# state == 'absent' and not pool:
|
||||
return False
|
||||
|
||||
|
||||
def main():
|
||||
module = LoadbalancerPoolModule()
|
||||
module = LoadBalancerPoolModule()
|
||||
module()
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user