cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Allow complete router configuration

Browse source 
This change allows one to completely configure a router, including
gateway and interfaces, using the latest shade (>0.13.0).
This commit is contained in:
David Shrewsbury 2015-09-25 13:09:02 -04:00 committed by Matt Clay
parent b724bf8f1c
commit 14546fe33c
1 changed files with 184 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

211
lib/ansible/modules/cloud/openstack/os_router.py
View file

@ -1,7 +1,4 @@
#!/usr/bin/python
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
# Copyright (c) 2013, Benno Joy <benno@ansible.com>
#
# 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
@ -26,7 +23,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: os_router
short_description: Create or Delete routers from OpenStack
short_description: Create or delete routers from OpenStack
extends_documentation_fragment: openstack
version_added: "2.0"
description:
@ -48,36 +45,147 @@ options:
- Desired admin state of the created or existing router.
required: false
default: true
enable_snat:
description:
- Enable Source NAT (SNAT) attribute.
required: false
default: true
network:
description:
- Unique name or ID of the external gateway network.
type: string
required: true when I(interfaces) or I(enable_snat) are provided,
false otherwise.
default: None
interfaces:
description:
- List of subnets to attach to the router. Each is a dictionary with
the subnet name or ID (subnet) and the IP address to assign on that
subnet (ip). If no IP is specified, one is automatically assigned from
that subnet.
required: false
default: None
requirements: ["shade"]
'''
EXAMPLES = '''
# Creates a router for tenant admin
# Create a simple router, not attached to a gateway or subnets.
- os_router:
state=present
name=router1
admin_state_up=True
cloud: mycloud
state: present
name: simple_router
# Creates a router attached to ext_network1 and one subnet interface.
# An IP address from subnet1's IP range will automatically be assigned
# to that interface.
- os_router:
cloud: mycloud
state: present
name: router1
network: ext_network1
interfaces:
- subnet: subnet1
# Update existing router1 to include subnet2 (10.5.5.0/24), specifying
# the IP address within subnet2's IP range we'd like for that interface.
- os_router:
cloud: mycloud
state: present
name: router1
network: ext_network1
interfaces:
- subnet: subnet1
- subnet: subnet2
ip: 10.5.5.1
# Delete router1
- os_router:
cloud: mycloud
state: absent
name: router1
'''
RETURN = '''
router:
description: Dictionary describing the router.
returned: On success when I(state) is 'present'
type dictionary
contains:
id:
description: Router ID
returned: On success when I(state) is 'present'.
description: Router ID.
type: string
sample: "474acfe5-be34-494c-b339-50f06aa143e4"
name:
description: Router name.
type: string
sample: "router1"
admin_state_up:
description: Administrative state of the router.
type: boolean
sample: true
status:
description: The router status.
type: string
sample: "ACTIVE"
tenant_id:
description: The tenant ID.
type: string
sample: "861174b82b43463c9edc5202aadc60ef"
external_gateway_info:
description: The external gateway parameters.
type: dictionary
sample: {
"enable_snat": true,
"external_fixed_ips": [
{
"ip_address": "10.6.6.99",
"subnet_id": "4272cb52-a456-4c20-8f3c-c26024ecfa81"
}
}
routes:
description: The extra routes configuration for L3 router.
type: list
'''
def _needs_update(router, admin_state_up):
def _needs_update(cloud, module, router, network):
"""Decide if the given router needs an update.
The only attribute of the router that we allow to change is the value
of admin_state_up. Name changes are not supported here.
"""
if router['admin_state_up'] != admin_state_up:
if router['admin_state_up'] != module.params['admin_state_up']:
return True
if router['external_gateway_info']['enable_snat'] != module.params['enable_snat']:
return True
if network:
if router['external_gateway_info']['network_id'] != network['id']:
return True
# check subnet interfaces
for new_iface in module.params['interfaces']:
subnet = cloud.get_subnet(new_iface['subnet'])
if not subnet:
module.fail_json(msg='subnet %s not found' % new_iface['subnet'])
exists = False
# compare the requested interface with existing, looking for an existing match
for existing_iface in router['external_gateway_info']['external_fixed_ips']:
if existing_iface['subnet_id'] == subnet['id']:
if 'ip' in new_iface:
if existing_iface['ip_address'] == new_iface['ip']:
# both subnet id and ip address match
exists = True
break
else:
# only the subnet was given, so ip doesn't matter
exists = True
break
# this interface isn't present on the existing router
if not exists:
return True
return False
def _system_state_change(module, router):
def _system_state_change(cloud, module, router, network):
"""Check if the system state would be changed."""
state = module.params['state']
if state == 'absent' and router:
@ -85,14 +193,45 @@ def _system_state_change(module, router):
if state == 'present':
if not router:
return True
return _needs_update(router, module.params['admin_state_up'])
return _needs_update(cloud, module, router, network)
return False
def _build_kwargs(cloud, module, router, network):
kwargs = {
'admin_state_up': module.params['admin_state_up'],
}
if router:
kwargs['name_or_id'] = router['id']
else:
kwargs['name'] = module.params['name']
if network:
kwargs['ext_gateway_net_id'] = network['id']
# can't send enable_snat unless we have a network
kwargs['enable_snat'] = module.params['enable_snat']
if module.params['interfaces']:
kwargs['ext_fixed_ips'] = []
for iface in module.params['interfaces']:
subnet = cloud.get_subnet(iface['subnet'])
if not subnet:
module.fail_json(msg='subnet %s not found' % iface['subnet'])
d = {'subnet_id': subnet['id']}
if 'ip' in iface:
d['ip_address'] = iface['ip']
kwargs['ext_fixed_ips'].append(d)
return kwargs
def main():
argument_spec = openstack_full_argument_spec(
state=dict(default='present', choices=['absent', 'present']),
name=dict(required=True),
admin_state_up=dict(type='bool', default=True),
state=dict(default='present', choices=['absent', 'present']),
enable_snat=dict(type='bool', default=True),
network=dict(default=None),
interfaces=dict(type='list', default=None)
)
module_kwargs = openstack_module_kwargs()
@ -103,28 +242,42 @@ def main():
if not HAS_SHADE:
module.fail_json(msg='shade is required for this module')
name = module.params['name']
admin_state_up = module.params['admin_state_up']
state = module.params['state']
name = module.params['name']
network = module.params['network']
if module.params['interfaces'] and not network:
module.fail_json(msg='network is required when supplying interfaces')
try:
cloud = shade.openstack_cloud(**module.params)
router = cloud.get_router(name)
net = None
if network:
net = cloud.get_network(network)
if not net:
module.fail_json(msg='network %s not found' % network)
if module.check_mode:
module.exit_json(changed=_system_state_change(module, router))
module.exit_json(
changed=_system_state_change(cloud, module, router, net)
)
if state == 'present':
changed = False
if not router:
router = cloud.create_router(name, admin_state_up)
module.exit_json(changed=True, id=router['id'])
kwargs = _build_kwargs(cloud, module, router, net)
router = cloud.create_router(**kwargs)
changed = True
else:
if _needs_update(router, admin_state_up):
cloud.update_router(router['id'],
admin_state_up=admin_state_up)
module.exit_json(changed=True, id=router['id'])
else:
module.exit_json(changed=False, id=router['id'])
if _needs_update(cloud, module, router, net):
kwargs = _build_kwargs(cloud, module, router, net)
router = cloud.update_router(**kwargs)
changed = True
module.exit_json(changed=changed, router=router)
elif state == 'absent':
if not router: