1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
4 # Licensed under the Apache License, Version 2.0 (the "License");
5 # you may not use this file except in compliance with the License.
6 # You may obtain a copy of the License at:
8 # http://www.apache.org/licenses/LICENSE-2.0
10 # Unless required by applicable law or agreed to in writing, software
11 # distributed under the License is distributed on an "AS IS" BASIS,
12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
17 from neutronclient.common.exceptions import NotFound, Unauthorized
19 from snaps.config.router import RouterConfig
20 from snaps.openstack.openstack_creator import OpenStackNetworkObject
21 from snaps.openstack.utils import neutron_utils
23 __author__ = 'spisarski'
25 logger = logging.getLogger('OpenStackNetwork')
28 class OpenStackRouter(OpenStackNetworkObject):
30 Class responsible for managing a router in OpenStack
33 def __init__(self, os_creds, router_settings):
35 Constructor - all parameters are required
36 :param os_creds: The credentials to connect with OpenStack
37 :param router_settings: The settings used to create a router object
38 (must be an instance of the RouterConfig
41 super(self.__class__, self).__init__(os_creds)
43 if not router_settings:
44 raise RouterCreationError('router_settings is required')
46 self.router_settings = router_settings
48 # Attributes instantiated on create()
50 self.__internal_subnets = list()
51 self.__internal_router_interface = None
53 # Dict where the port object is the key and any newly created router
54 # interfaces are the value
59 Loads the existing router.
60 :return: the Router domain object
62 super(self.__class__, self).initialize()
65 self.__router = neutron_utils.get_router(
66 self._neutron, self._keystone,
67 router_settings=self.router_settings,
68 project_name=self._os_creds.project_name)
69 except Unauthorized as e:
70 logger.warn('Unable to lookup router with name %s - %s',
71 self.router_settings.name, e)
74 for sub_config in self.router_settings.internal_subnets:
75 internal_subnet = self.__get_internal_subnet(sub_config)
77 self.__internal_subnets.append(internal_subnet)
79 raise RouterCreationError(
80 'Subnet not found with name ' + internal_subnet.name)
82 for port_setting in self.router_settings.port_settings:
83 port = neutron_utils.get_port(
84 self._neutron, self._keystone, port_settings=port_setting,
85 project_name=self._os_creds.project_name)
87 self.__ports.append(port)
93 Responsible for creating the router.
94 :return: the Router domain object
99 self.__router = neutron_utils.create_router(
100 self._neutron, self._os_creds, self.router_settings)
102 for sub_config in self.router_settings.internal_subnets:
103 internal_subnet = self.__get_internal_subnet(sub_config)
105 self.__internal_subnets.append(internal_subnet)
107 logger.debug('Adding router to subnet...')
108 router_intf = neutron_utils.add_interface_router(
109 self._neutron, self.__router,
110 subnet=internal_subnet)
111 self.__internal_router_interface = router_intf
113 raise RouterCreationError(
114 'Subnet not found with name ' + internal_subnet.name)
116 for port_setting in self.router_settings.port_settings:
117 port = neutron_utils.get_port(
118 self._neutron, self._keystone, port_settings=port_setting,
119 project_name=self._os_creds.project_name)
121 'Retrieved port %s for router - %s', port_setting.name,
122 self.router_settings.name)
124 self.__ports.append(port)
127 port = neutron_utils.create_port(
128 self._neutron, self._os_creds, port_setting)
131 'Created port %s for router - %s',
133 self.router_settings.name)
134 self.__ports.append(port)
135 neutron_utils.add_interface_router(
136 self._neutron, self.__router, port=port)
138 raise RouterCreationError(
139 'Error creating port with name - '
142 self.__router = neutron_utils.get_router_by_id(
143 self._neutron, self.__router.id)
146 def __get_internal_subnet(self, sub_config):
148 returns the Subnet domain object from the subnet configurator
152 if isinstance(sub_config, dict):
153 sub_dict = sub_config['subnet']
154 network = neutron_utils.get_network(
155 self._neutron, self._keystone,
156 network_name=sub_dict['network_name'],
157 project_name=sub_dict['project_name'])
159 return neutron_utils.get_subnet(
160 self._neutron, network,
161 subnet_name=sub_dict['subnet_name'])
163 return neutron_utils.get_subnet_by_name(
164 self._neutron, self._keystone,
165 subnet_name=sub_config)
169 Removes and deletes all items created in reverse order.
171 for port in self.__ports:
173 'Removing router interface from router %s and port %s',
174 self.router_settings.name, port.name)
176 neutron_utils.remove_interface_router(self._neutron,
177 self.__router, port=port)
180 self.__ports = list()
182 for internal_subnet in self.__internal_subnets:
184 'Removing router interface from router %s and subnet %s',
185 self.router_settings.name, internal_subnet.name)
187 neutron_utils.remove_interface_router(self._neutron,
189 subnet=internal_subnet)
192 self.__internal_subnets = list()
195 logger.info('Removing router ' + self.router_settings.name)
197 neutron_utils.delete_router(self._neutron, self.__router)
202 super(self.__class__, self).clean()
204 def get_router(self):
206 Returns the OpenStack router object
211 def get_internal_router_interface(self):
213 Returns the OpenStack internal router interface object
216 return self.__internal_router_interface
219 class RouterCreationError(Exception):
221 Exception to be thrown when an router instance cannot be created
225 class RouterSettings(RouterConfig):
227 Class to hold the configuration settings required for creating OpenStack
232 def __init__(self, **kwargs):
233 from warnings import warn
234 warn('Use snaps.config.router.RouterConfig instead',
236 super(self.__class__, self).__init__(**kwargs)