snaps/openstack/create_router.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   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:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  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.
  15 import logging
  16
  17 from neutronclient.common.exceptions import NotFound
  18
  19 from snaps.config.router import RouterConfig
  20 from snaps.openstack.openstack_creator import OpenStackNetworkObject
  21 from snaps.openstack.utils import neutron_utils
  22
  23 __author__ = 'spisarski'
  24
  25 logger = logging.getLogger('OpenStackNetwork')
  26
  27
  28 class OpenStackRouter(OpenStackNetworkObject):
  29     """
  30     Class responsible for managing a router in OpenStack
  31     """
  32
  33     def __init__(self, os_creds, router_settings):
  34         """
  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
  39                                 class)
  40         """
  41         super(self.__class__, self).__init__(os_creds)
  42
  43         if not router_settings:
  44             raise RouterCreationError('router_settings is required')
  45
  46         self.router_settings = router_settings
  47
  48         # Attributes instantiated on create()
  49         self.__router = None
  50         self.__internal_subnets = list()
  51         self.__internal_router_interface = None
  52
  53         # Dict where the port object is the key and any newly created router
  54         # interfaces are the value
  55         self.__ports = list()
  56
  57     def initialize(self):
  58         """
  59         Loads the existing router.
  60         :return: the Router domain object
  61         """
  62         super(self.__class__, self).initialize()
  63
  64         self.__router = neutron_utils.get_router(
  65             self._neutron, router_settings=self.router_settings)
  66
  67         if self.__router:
  68             for internal_subnet_name in self.router_settings.internal_subnets:
  69                 internal_subnet = neutron_utils.get_subnet(
  70                     self._neutron, subnet_name=internal_subnet_name)
  71                 if internal_subnet:
  72                     self.__internal_subnets.append(internal_subnet)
  73                 else:
  74                     raise RouterCreationError(
  75                         'Subnet not found with name ' + internal_subnet_name)
  76
  77             for port_setting in self.router_settings.port_settings:
  78                 port = neutron_utils.get_port(
  79                     self._neutron, port_settings=port_setting)
  80                 if port:
  81                     self.__ports.append(port)
  82
  83         return self.__router
  84
  85     def create(self):
  86         """
  87         Responsible for creating the router.
  88         :return: the Router domain object
  89         """
  90         self.initialize()
  91
  92         if not self.__router:
  93             self.__router = neutron_utils.create_router(
  94                 self._neutron, self._os_creds, self.router_settings)
  95
  96             for internal_subnet_name in self.router_settings.internal_subnets:
  97                 internal_subnet = neutron_utils.get_subnet(
  98                     self._neutron, subnet_name=internal_subnet_name)
  99                 if internal_subnet:
 100                     self.__internal_subnets.append(internal_subnet)
 101                     if internal_subnet:
 102                         logger.debug('Adding router to subnet...')
 103                         router_intf = neutron_utils.add_interface_router(
 104                             self._neutron, self.__router,
 105                             subnet=internal_subnet)
 106                         self.__internal_router_interface = router_intf
 107                 else:
 108                     raise RouterCreationError(
 109                         'Subnet not found with name ' + internal_subnet_name)
 110
 111             for port_setting in self.router_settings.port_settings:
 112                 port = neutron_utils.get_port(
 113                     self._neutron, port_settings=port_setting)
 114                 logger.info(
 115                     'Retrieved port %s for router - %s', port_setting.name,
 116                     self.router_settings.name)
 117                 if port:
 118                     self.__ports.append(port)
 119
 120                 if not port:
 121                     port = neutron_utils.create_port(
 122                         self._neutron, self._os_creds, port_setting)
 123                     if port:
 124                         logger.info(
 125                             'Created port %s for router - %s',
 126                             port_setting.name,
 127                             self.router_settings.name)
 128                         self.__ports.append(port)
 129                         neutron_utils.add_interface_router(self._neutron,
 130                                                            self.__router,
 131                                                            port=port)
 132                     else:
 133                         raise RouterCreationError(
 134                             'Error creating port with name - '
 135                             + port_setting.name)
 136
 137         self.__router = neutron_utils.get_router_by_id(
 138             self._neutron, self.__router.id)
 139         return self.__router
 140
 141     def clean(self):
 142         """
 143         Removes and deletes all items created in reverse order.
 144         """
 145         for port in self.__ports:
 146             logger.info(
 147                 'Removing router interface from router %s and port %s',
 148                 self.router_settings.name, port.name)
 149             try:
 150                 neutron_utils.remove_interface_router(self._neutron,
 151                                                       self.__router, port=port)
 152             except NotFound:
 153                 pass
 154         self.__ports = list()
 155
 156         for internal_subnet in self.__internal_subnets:
 157             logger.info(
 158                 'Removing router interface from router %s and subnet %s',
 159                 self.router_settings.name, internal_subnet.name)
 160             try:
 161                 neutron_utils.remove_interface_router(self._neutron,
 162                                                       self.__router,
 163                                                       subnet=internal_subnet)
 164             except NotFound:
 165                 pass
 166         self.__internal_subnets = list()
 167
 168         if self.__router:
 169             logger.info('Removing router ' + self.router_settings.name)
 170             try:
 171                 neutron_utils.delete_router(self._neutron, self.__router)
 172             except NotFound:
 173                 pass
 174             self.__router = None
 175
 176     def get_router(self):
 177         """
 178         Returns the OpenStack router object
 179         :return:
 180         """
 181         return self.__router
 182
 183     def get_internal_router_interface(self):
 184         """
 185         Returns the OpenStack internal router interface object
 186         :return:
 187         """
 188         return self.__internal_router_interface
 189
 190
 191 class RouterCreationError(Exception):
 192     """
 193     Exception to be thrown when an router instance cannot be created
 194     """
 195
 196
 197 class RouterSettings(RouterConfig):
 198     """
 199     Class to hold the configuration settings required for creating OpenStack
 200     router objects
 201     deprecated
 202     """
 203
 204     def __init__(self, **kwargs):
 205         from warnings import warn
 206         warn('Use snaps.config.router.RouterConfig instead',
 207              DeprecationWarning)
 208         super(self.__class__, self).__init__(**kwargs)