snaps/openstack/create_network.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 import enum
  18 from neutronclient.common.exceptions import NetworkNotFoundClient, Unauthorized
  19
  20 from snaps.config.network import NetworkConfig, SubnetConfig, PortConfig
  21 from snaps.openstack.openstack_creator import OpenStackNetworkObject
  22 from snaps.openstack.utils import neutron_utils
  23
  24 __author__ = 'spisarski'
  25
  26 logger = logging.getLogger('OpenStackNetwork')
  27
  28
  29 class OpenStackNetwork(OpenStackNetworkObject):
  30     """
  31     Class responsible for managing a network in OpenStack
  32     """
  33
  34     def __init__(self, os_creds, network_settings):
  35         """
  36         Constructor - all parameters are required
  37         :param os_creds: The credentials to connect with OpenStack
  38         :param network_settings: The settings used to create a network
  39         """
  40         super(self.__class__, self).__init__(os_creds)
  41
  42         self.network_settings = network_settings
  43
  44         # Attributes instantiated on create()
  45         self.__network = None
  46
  47     def initialize(self):
  48         """
  49         Loads the existing OpenStack network/subnet
  50         :return: The Network domain object or None
  51         """
  52         super(self.__class__, self).initialize()
  53
  54         try:
  55             self.__network = neutron_utils.get_network(
  56                 self._neutron, network_settings=self.network_settings,
  57                 project_id=self.network_settings.get_project_id(
  58                     self._os_creds))
  59         except Unauthorized as e:
  60             logger.warn('Unable to lookup network with name %s - %s',
  61                         self.network_settings.name, e)
  62
  63         return self.__network
  64
  65     def create(self):
  66         """
  67         Responsible for creating not only the network but then a private
  68         subnet, router, and an interface to the router.
  69         :return: the Network domain object
  70         """
  71         self.initialize()
  72
  73         if not self.__network:
  74             self.__network = neutron_utils.create_network(
  75                 self._neutron, self._os_creds, self.network_settings)
  76             logger.debug(
  77                 'Network [%s] created successfully' % self.__network.id)
  78
  79         return self.__network
  80
  81     def clean(self):
  82         """
  83         Removes and deletes all items created in reverse order.
  84         """
  85         if self.__network:
  86             try:
  87                 neutron_utils.delete_network(self._neutron, self.__network)
  88             except NetworkNotFoundClient:
  89                 pass
  90             self.__network = None
  91
  92     def get_network(self):
  93         """
  94         Returns the created OpenStack network object
  95         :return: the OpenStack network object
  96         """
  97         return self.__network
  98
  99
 100 class NetworkSettings(NetworkConfig):
 101     """
 102     Class to hold the configuration settings required for creating OpenStack
 103     Network objects
 104     deprecated
 105     """
 106
 107     def __init__(self, **kwargs):
 108         from warnings import warn
 109         warn('Use snaps.config.network.NetworkConfig instead',
 110              DeprecationWarning)
 111         super(self.__class__, self).__init__(**kwargs)
 112
 113
 114 class IPv6Mode(enum.Enum):
 115     """
 116     A rule's direction
 117     deprecated - use snaps.config.network.IPv6Mode
 118     """
 119     slaac = 'slaac'
 120     stateful = 'dhcpv6-stateful'
 121     stateless = 'dhcpv6-stateless'
 122
 123
 124 class SubnetSettings(SubnetConfig):
 125     """
 126     Class to hold the configuration settings required for creating OpenStack
 127     Subnet objects
 128     deprecated
 129     """
 130
 131     def __init__(self, **kwargs):
 132         from warnings import warn
 133         warn('Use snaps.config.network.SubnetConfig instead',
 134              DeprecationWarning)
 135         super(self.__class__, self).__init__(**kwargs)
 136
 137
 138 class PortSettings(PortConfig):
 139     """
 140     Class to hold the configuration settings required for creating OpenStack
 141     Subnet objects
 142     deprecated
 143     """
 144
 145     def __init__(self, **kwargs):
 146         from warnings import warn
 147         warn('Use snaps.config.network.PortConfig instead',
 148              DeprecationWarning)
 149         super(self.__class__, self).__init__(**kwargs)