ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

os_loadbalancer: support to create populated load balancer (#44619)

Browse source 
The user can use os_loadbalancer module to configure a fully functional
load balancer by specifying the sub-resources definition in the module,
rather than combining os_listener, os_pool and os_member modules.
This commit is contained in:
Lingxian Kong 2018-09-18 06:10:03 +12:00 • committed by David Shrewsbury
parent a7a99c5fd4
commit cf1e0bde99
2 changed files with 466 additions and 118 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

579
lib/ansible/modules/cloud/openstack/os_loadbalancer.py
View file

@ -19,93 +19,176 @@ extends_documentation_fragment: openstack
version_added: "2.7" version_added: "2.7"
author: "Lingxian Kong (@lingxiankong)" author: "Lingxian Kong (@lingxiankong)"
description: description:
- Add or Remove load balancer from the OpenStack load-balancer service. - Add or Remove load balancer from the OpenStack load-balancer
service(Octavia). Load balancer update is not supported for now.
options: options:
name: name:
description: description:
- Name that has to be given to the load balancer - Name that has to be given to the load balancer
required: true required: true
state: state:
description: description:
- Should the resource be present or absent. - Should the resource be present or absent.
choices: [present, absent] choices: [present, absent]
default: present default: present
vip_network: vip_network:
description: description:
- The name or id of the network for the virtual IP of the load balancer. - The name or id of the network for the virtual IP of the load balancer.
One of vip_network, vip_subnet, or vip_port must be specified. One of I(vip_network), I(vip_subnet), or I(vip_port) must be specified
vip_subnet: for creation.
description: vip_subnet:
- The name or id of the subnet for the virtual IP of the load balancer. description:
One of vip_network, vip_subnet, or vip_port must be specified. - The name or id of the subnet for the virtual IP of the load balancer.
vip_port: One of I(vip_network), I(vip_subnet), or I(vip_port) must be specified
description: for creation.
- The name or id of the load balancer virtual IP port. One of vip_port:
vip_network, vip_subnet, or vip_port must be specified. description:
vip_address: - The name or id of the load balancer virtual IP port. One of
description: I(vip_network), I(vip_subnet), or I(vip_port) must be specified for
- IP address of the load balancer virtual IP. creation.
wait: vip_address:
description: description:
- If the module should wait for the load balancer to be created. - IP address of the load balancer virtual IP.
type: bool public_ip_address:
default: 'yes' description:
timeout: - Public IP address associated with the VIP.
description: auto_public_ip:
- The amount of time the module should wait for the load balancer to get description:
into ACTIVE state. - Allocate a public IP address and associate with the VIP automatically.
default: 180 type: bool
availability_zone: default: 'no'
description: public_network:
- Ignored. Present for backwards compatibility description:
- The name or ID of a Neutron external network.
delete_public_ip:
description:
- When C(state=absent) and this option is true, any public IP address
associated with the VIP will be deleted along with the load balancer.
type: bool
default: 'no'
listeners:
description:
- A list of listeners that attached to the load balancer.
suboptions:
name:
description:
- The listener name or ID.
protocol:
description:
- The protocol for the listener.
default: HTTP
protocol_port:
description:
- The protocol port number for the listener.
default: 80
pool:
description:
- The pool attached to the listener.
suboptions:
name:
description:
- The pool name or ID.
protocol:
description:
- The protocol for the pool.
default: HTTP
lb_algorithm:
description:
- The load balancing algorithm for the pool.
default: ROUND_ROBIN
members:
description:
- A list of members that added to the pool.
suboptions:
name:
description:
- The member name or ID.
address:
description:
- The IP address of the member.
protocol_port:
description:
- The protocol port number for the member.
default: 80
subnet:
description:
- The name or ID of the subnet the member service is
accessible from.
wait:
description:
- If the module should wait for the load balancer to be created or
deleted.
type: bool
default: 'yes'
timeout:
description:
- The amount of time the module should wait.
default: 180
availability_zone:
description:
- Ignored. Present for backwards compatibility
requirements: ["openstacksdk"] requirements: ["openstacksdk"]
''' '''
RETURN = ''' RETURN = '''
id: id:
description: Unique UUID. description: The load balancer UUID.
returned: success returned: On success when C(state=present)
type: string type: string
name: sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
description: Name given to the load balancer. loadbalancer:
returned: success description: Dictionary describing the load balancer.
type: string returned: On success when C(state=present)
vip_network_id: type: complex
description: Network ID the load balancer virutal IP port belongs in. contains:
returned: success id:
type: string description: Unique UUID.
vip_subnet_id: type: string
description: Subnet ID the load balancer virutal IP port belongs in. sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
returned: success name:
type: string description: Name given to the load balancer.
vip_port_id: type: string
description: The load balancer virutal IP port ID. sample: "lingxian_test"
returned: success vip_network_id:
type: string description: Network ID the load balancer virutal IP port belongs in.
vip_address: type: string
description: The load balancer virutal IP address. sample: "f171db43-56fd-41cf-82d7-4e91d741762e"
returned: success vip_subnet_id:
type: string description: Subnet ID the load balancer virutal IP port belongs in.
provisioning_status: type: string
description: The provisioning status of the load balancer. sample: "c53e3c70-9d62-409a-9f71-db148e7aa853"
returned: success vip_port_id:
type: string description: The load balancer virutal IP port ID.
operating_status: type: string
description: The operating status of the load balancer. sample: "2061395c-1c01-47ab-b925-c91b93df9c1d"
returned: success vip_address:
type: string description: The load balancer virutal IP address.
is_admin_state_up: type: string
description: The administrative state of the load balancer. sample: "192.168.2.88"
returned: success public_vip_address:
type: bool description: The load balancer public VIP address.
listeners: type: string
description: The associated listener IDs, if any. sample: "10.17.8.254"
returned: success provisioning_status:
type: list description: The provisioning status of the load balancer.
pools: type: string
description: The associated pool IDs, if any. sample: "ACTIVE"
returned: success operating_status:
type: list description: The operating status of the load balancer.
type: string
sample: "ONLINE"
is_admin_state_up:
description: The administrative state of the load balancer.
type: bool
sample: true
listeners:
description: The associated listener IDs, if any.
type: list
sample: [{"id": "7aa1b380-beec-459c-a8a7-3a4fb6d30645"}, {"id": "692d06b8-c4f8-4bdb-b2a3-5a263cc23ba6"}]
pools:
description: The associated pool IDs, if any.
type: list
sample: [{"id": "27b78d92-cee1-4646-b831-e3b90a7fa714"}, {"id": "befc1fb5-1992-4697-bdb9-eee330989344"}]
''' '''
EXAMPLES = ''' EXAMPLES = '''
@ -132,6 +215,66 @@ EXAMPLES = '''
name: my_lb name: my_lb
vip_network: my_network vip_network: my_network
vip_address: 192.168.0.11 vip_address: 192.168.0.11
# Create a load balancer together with its sub-resources in the 'all in one'
# way. A public IP address is also allocated to the load balancer VIP.
- os_loadbalancer:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
name: lingxian_test
state: present
vip_subnet: kong_subnet
auto_public_ip: yes
public_network: public
listeners:
- name: lingxian_80
protocol: TCP
protocol_port: 80
pool:
name: lingxian_80_pool
protocol: TCP
members:
- name: mywebserver1
address: 192.168.2.81
protocol_port: 80
subnet: webserver_subnet
- name: lingxian_8080
protocol: TCP
protocol_port: 8080
pool:
name: lingxian_8080-pool
protocol: TCP
members:
- name: mywebserver2
address: 192.168.2.82
protocol_port: 8080
wait: yes
timeout: 600
# Delete a load balancer(and all its related resources)
- os_loadbalancer:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
state: absent
name: my_lb
# Delete a load balancer(and all its related resources) together with the
# public IP address(if any) attached to it.
- os_loadbalancer:
auth:
auth_url: https://identity.example.com
username: admin
password: passme
project_name: admin
state: absent
name: my_lb
delete_public_ip: yes
''' '''
import time import time
@ -141,7 +284,7 @@ from ansible.module_utils.openstack import openstack_full_argument_spec, \
openstack_module_kwargs, openstack_cloud_from_module openstack_module_kwargs, openstack_cloud_from_module
def _lb_wait_for_status(module, cloud, lb, status, failures, interval=5): def _wait_for_lb(module, cloud, lb, status, failures, interval=5):
"""Wait for load balancer to be in a particular provisioning status.""" """Wait for load balancer to be in a particular provisioning status."""
timeout = module.params['timeout'] timeout = module.params['timeout']
@ -151,13 +294,22 @@ def _lb_wait_for_status(module, cloud, lb, status, failures, interval=5):
while total_sleep < timeout: while total_sleep < timeout:
lb = cloud.load_balancer.get_load_balancer(lb.id) lb = cloud.load_balancer.get_load_balancer(lb.id)
if lb.provisioning_status == status:
return None if lb:
if lb.provisioning_status in failures: if lb.provisioning_status == status:
module.fail_json( return None
msg="Load Balancer %s transitioned to failure state %s" % if lb.provisioning_status in failures:
(lb.id, lb.provisioning_status) module.fail_json(
) msg="Load Balancer %s transitioned to failure state %s" %
(lb.id, lb.provisioning_status)
)
else:
if status == "DELETED":
return None
else:
module.fail_json(
msg="Load Balancer %s transitioned to DELETED" % lb.id
)
time.sleep(interval) time.sleep(interval)
total_sleep += interval total_sleep += interval
@ -176,15 +328,25 @@ def main():
vip_subnet=dict(required=False), vip_subnet=dict(required=False),
vip_port=dict(required=False), vip_port=dict(required=False),
vip_address=dict(required=False), vip_address=dict(required=False),
listeners=dict(type='list', default=[]),
public_ip_address=dict(required=False, default=None),
auto_public_ip=dict(required=False, default=False, type='bool'),
public_network=dict(required=False),
delete_public_ip=dict(required=False, default=False, type='bool'),
) )
module_kwargs = openstack_module_kwargs( module_kwargs = openstack_module_kwargs()
required_one_of=[
['vip_network', 'vip_subnet', 'vip_port'],
]
)
module = AnsibleModule(argument_spec, **module_kwargs) module = AnsibleModule(argument_spec, **module_kwargs)
sdk, cloud = openstack_cloud_from_module(module) sdk, cloud = openstack_cloud_from_module(module)
vip_network = module.params['vip_network']
vip_subnet = module.params['vip_subnet']
vip_port = module.params['vip_port']
listeners = module.params['listeners']
public_vip_address = module.params['public_ip_address']
allocate_fip = module.params['auto_public_ip']
delete_fip = module.params['delete_public_ip']
public_network = module.params['public_network']
vip_network_id = None vip_network_id = None
vip_subnet_id = None vip_subnet_id = None
vip_port_id = None vip_port_id = None
@ -196,28 +358,31 @@ def main():
if module.params['state'] == 'present': if module.params['state'] == 'present':
if not lb: if not lb:
if module.params['vip_network']: if not (vip_network or vip_subnet or vip_port):
network = cloud.get_network(module.params['vip_network']) module.fail_json(
msg="One of vip_network, vip_subnet, or vip_port must "
"be specified for load balancer creation"
)
if vip_network:
network = cloud.get_network(vip_network)
if not network: if not network:
module.fail_json( module.fail_json(
msg='network %s is not found' % msg='network %s is not found' % vip_network
module.params['vip_network']
) )
vip_network_id = network.id vip_network_id = network.id
if module.params['vip_subnet']: if vip_subnet:
subnet = cloud.get_subnet(module.params['vip_subnet']) subnet = cloud.get_subnet(vip_subnet)
if not subnet: if not subnet:
module.fail_json( module.fail_json(
msg='subnet %s is not found' % msg='subnet %s is not found' % vip_subnet
module.params['vip_subnet']
) )
vip_subnet_id = subnet.id vip_subnet_id = subnet.id
if module.params['vip_port']: if vip_port:
port = cloud.get_port(module.params['vip_port']) port = cloud.get_port(vip_port)
if not port: if not port:
module.fail_json( module.fail_json(
msg='port %s is not found' % msg='port %s is not found' % vip_port
module.params['vip_port']
) )
vip_port_id = port.id vip_port_id = port.id
@ -230,25 +395,207 @@ def main():
) )
changed = True changed = True
if not module.params['wait']: if not listeners and not module.params['wait']:
module.exit_json(changed=changed, module.exit_json(
loadbalancer=lb.to_dict(), id=lb.id) changed=changed,
loadbalancer=lb.to_dict(),
id=lb.id
)
if module.params['wait']: _wait_for_lb(module, cloud, lb, "ACTIVE", ["ERROR"])
_lb_wait_for_status(module, cloud, lb, "ACTIVE", ["ERROR"])
module.exit_json(changed=changed, loadbalancer=lb.to_dict(), for listener_def in listeners:
id=lb.id) listener_name = listener_def.get("name")
pool_def = listener_def.get("pool")
if not listener_name:
module.fail_json(msg='listener name is required')
listener = cloud.load_balancer.find_listener(
name_or_id=listener_name
)
if not listener:
_wait_for_lb(module, cloud, lb, "ACTIVE", ["ERROR"])
protocol = listener_def.get("protocol", "HTTP")
protocol_port = listener_def.get("protocol_port", 80)
listener = cloud.load_balancer.create_listener(
name=listener_name,
loadbalancer_id=lb.id,
protocol=protocol,
protocol_port=protocol_port,
)
changed = True
# Ensure pool in the listener.
if pool_def:
pool_name = pool_def.get("name")
members = pool_def.get('members', [])
if not pool_name:
module.fail_json(msg='pool name is required')
pool = cloud.load_balancer.find_pool(name_or_id=pool_name)
if not pool:
_wait_for_lb(module, cloud, lb, "ACTIVE", ["ERROR"])
protocol = pool_def.get("protocol", "HTTP")
lb_algorithm = pool_def.get("lb_algorithm",
"ROUND_ROBIN")
pool = cloud.load_balancer.create_pool(
name=pool_name,
listener_id=listener.id,
protocol=protocol,
lb_algorithm=lb_algorithm
)
changed = True
# Ensure members in the pool
for member_def in members:
member_name = member_def.get("name")
if not member_name:
module.fail_json(msg='member name is required')
member = cloud.load_balancer.find_member(member_name,
pool.id)
if not member:
_wait_for_lb(module, cloud, lb, "ACTIVE",
["ERROR"])
address = member_def.get("address")
if not address:
module.fail_json(
msg='member address for member %s is '
'required' % member_name
)
subnet_id = member_def.get("subnet")
if subnet_id:
subnet = cloud.get_subnet(subnet_id)
if not subnet:
module.fail_json(
msg='subnet %s for member %s is not '
'found' % (subnet_id, member_name)
)
subnet_id = subnet.id
protocol_port = member_def.get("protocol_port", 80)
member = cloud.load_balancer.create_member(
pool,
name=member_name,
address=address,
protocol_port=protocol_port,
subnet_id=subnet_id
)
changed = True
# Associate public ip to the load balancer VIP. If
# public_vip_address is provided, use that IP, otherwise, either
# find an available public ip or create a new one.
fip = None
orig_public_ip = None
new_public_ip = None
if public_vip_address or allocate_fip:
ips = cloud.network.ips(
port_id=lb.vip_port_id,
fixed_ip_address=lb.vip_address
)
ips = list(ips)
if ips:
orig_public_ip = ips[0]
new_public_ip = orig_public_ip.floating_ip_address
if public_vip_address and public_vip_address != orig_public_ip:
fip = cloud.network.find_ip(public_vip_address)
if not fip:
module.fail_json(
msg='Public IP %s is unavailable' % public_vip_address
)
# Release origin public ip first
cloud.network.update_ip(
orig_public_ip,
fixed_ip_address=None,
port_id=None
)
# Associate new public ip
cloud.network.update_ip(
fip,
fixed_ip_address=lb.vip_address,
port_id=lb.vip_port_id
)
new_public_ip = public_vip_address
changed = True
elif allocate_fip and not orig_public_ip:
fip = cloud.network.find_available_ip()
if not fip:
if not public_network:
module.fail_json(msg="Public network is not provided")
pub_net = cloud.network.find_network(public_network)
if not pub_net:
module.fail_json(
msg='Public network %s not found' %
public_network
)
fip = cloud.network.create_ip(
floating_network_id=pub_net.id
)
cloud.network.update_ip(
fip,
fixed_ip_address=lb.vip_address,
port_id=lb.vip_port_id
)
new_public_ip = fip.floating_ip_address
changed = True
# Include public_vip_address in the result.
lb = cloud.load_balancer.find_load_balancer(name_or_id=lb.id)
lb_dict = lb.to_dict()
lb_dict.update({"public_vip_address": new_public_ip})
module.exit_json(
changed=changed,
loadbalancer=lb_dict,
id=lb.id
)
elif module.params['state'] == 'absent': elif module.params['state'] == 'absent':
if not lb: changed = False
changed = False public_vip_address = None
else:
if lb:
if delete_fip:
ips = cloud.network.ips(
port_id=lb.vip_port_id,
fixed_ip_address=lb.vip_address
)
ips = list(ips)
if ips:
public_vip_address = ips[0]
# Deleting load balancer with `cascade=False` does not make # Deleting load balancer with `cascade=False` does not make
# sense because the deletion will always fail if there are # sense because the deletion will always fail if there are
# sub-resources. # sub-resources.
cloud.load_balancer.delete_load_balancer(lb, cascade=True) cloud.load_balancer.delete_load_balancer(lb, cascade=True)
changed = True changed = True
if module.params['wait']:
_wait_for_lb(module, cloud, lb, "DELETED", ["ERROR"])
if delete_fip and public_vip_address:
cloud.network.delete_ip(public_vip_address)
changed = True
module.exit_json(changed=changed) module.exit_json(changed=changed)
except sdk.exceptions.OpenStackCloudException as e: except sdk.exceptions.OpenStackCloudException as e:
module.fail_json(msg=str(e), extra_data=e.extra_data) module.fail_json(msg=str(e), extra_data=e.extra_data)

5
lib/ansible/modules/cloud/openstack/os_pool.py
View file

@ -213,8 +213,9 @@ def main():
if not pool: if not pool:
loadbalancer_id = None loadbalancer_id = None
if not (loadbalancer or listener): if not (loadbalancer or listener):
module.fail_json("either loadbalancer or listener must " module.fail_json(
"be provided") msg="either loadbalancer or listener must be provided"
)
if loadbalancer: if loadbalancer:
lb = cloud.load_balancer.find_load_balancer(loadbalancer) lb = cloud.load_balancer.find_load_balancer(loadbalancer)