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, router_settings=self.router_settings)
67 except Unauthorized as e:
68 logger.warn('Unable to lookup router with name %s - %s',
69 self.router_settings.name, e)
72 for internal_subnet_name in self.router_settings.internal_subnets:
73 internal_subnet = neutron_utils.get_subnet(
74 self._neutron, subnet_name=internal_subnet_name)
76 self.__internal_subnets.append(internal_subnet)
78 raise RouterCreationError(
79 'Subnet not found with name ' + internal_subnet_name)
81 for port_setting in self.router_settings.port_settings:
82 port = neutron_utils.get_port(
83 self._neutron, port_settings=port_setting)
85 self.__ports.append(port)
91 Responsible for creating the router.
92 :return: the Router domain object
97 self.__router = neutron_utils.create_router(
98 self._neutron, self._os_creds, self.router_settings)
100 for internal_subnet_name in self.router_settings.internal_subnets:
101 internal_subnet = neutron_utils.get_subnet(
102 self._neutron, subnet_name=internal_subnet_name)
104 self.__internal_subnets.append(internal_subnet)
106 logger.debug('Adding router to subnet...')
107 router_intf = neutron_utils.add_interface_router(
108 self._neutron, self.__router,
109 subnet=internal_subnet)
110 self.__internal_router_interface = router_intf
112 raise RouterCreationError(
113 'Subnet not found with name ' + internal_subnet_name)
115 for port_setting in self.router_settings.port_settings:
116 port = neutron_utils.get_port(
117 self._neutron, port_settings=port_setting)
119 'Retrieved port %s for router - %s', port_setting.name,
120 self.router_settings.name)
122 self.__ports.append(port)
125 port = neutron_utils.create_port(
126 self._neutron, self._os_creds, port_setting)
129 'Created port %s for router - %s',
131 self.router_settings.name)
132 self.__ports.append(port)
133 neutron_utils.add_interface_router(self._neutron,
137 raise RouterCreationError(
138 'Error creating port with name - '
141 self.__router = neutron_utils.get_router_by_id(
142 self._neutron, self.__router.id)
147 Removes and deletes all items created in reverse order.
149 for port in self.__ports:
151 'Removing router interface from router %s and port %s',
152 self.router_settings.name, port.name)
154 neutron_utils.remove_interface_router(self._neutron,
155 self.__router, port=port)
158 self.__ports = list()
160 for internal_subnet in self.__internal_subnets:
162 'Removing router interface from router %s and subnet %s',
163 self.router_settings.name, internal_subnet.name)
165 neutron_utils.remove_interface_router(self._neutron,
167 subnet=internal_subnet)
170 self.__internal_subnets = list()
173 logger.info('Removing router ' + self.router_settings.name)
175 neutron_utils.delete_router(self._neutron, self.__router)
180 def get_router(self):
182 Returns the OpenStack router object
187 def get_internal_router_interface(self):
189 Returns the OpenStack internal router interface object
192 return self.__internal_router_interface
195 class RouterCreationError(Exception):
197 Exception to be thrown when an router instance cannot be created
201 class RouterSettings(RouterConfig):
203 Class to hold the configuration settings required for creating OpenStack
208 def __init__(self, **kwargs):
209 from warnings import warn
210 warn('Use snaps.config.router.RouterConfig instead',
212 super(self.__class__, self).__init__(**kwargs)