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
  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         self.__network = neutron_utils.get_network(
  55             self._neutron, network_settings=self.network_settings,
  56             project_id=self.network_settings.get_project_id(self._os_creds))
  57
  58         return self.__network
  59
  60     def create(self):
  61         """
  62         Responsible for creating not only the network but then a private
  63         subnet, router, and an interface to the router.
  64         :return: the Network domain object
  65         """
  66         self.initialize()
  67
  68         if not self.__network:
  69             self.__network = neutron_utils.create_network(
  70                 self._neutron, self._os_creds, self.network_settings)
  71             logger.debug(
  72                 'Network [%s] created successfully' % self.__network.id)
  73
  74         return self.__network
  75
  76     def clean(self):
  77         """
  78         Removes and deletes all items created in reverse order.
  79         """
  80         if self.__network:
  81             try:
  82                 neutron_utils.delete_network(self._neutron, self.__network)
  83             except NetworkNotFoundClient:
  84                 pass
  85             self.__network = None
  86
  87     def get_network(self):
  88         """
  89         Returns the created OpenStack network object
  90         :return: the OpenStack network object
  91         """
  92         return self.__network
  93
  94
  95 class NetworkSettings(NetworkConfig):
  96     """
  97     Class to hold the configuration settings required for creating OpenStack
  98     Network objects
  99     deprecated
 100     """
 101
 102     def __init__(self, **kwargs):
 103         from warnings import warn
 104         warn('Use snaps.config.network.NetworkConfig instead',
 105              DeprecationWarning)
 106         super(self.__class__, self).__init__(**kwargs)
 107
 108
 109 class IPv6Mode(enum.Enum):
 110     """
 111     A rule's direction
 112     deprecated - use snaps.config.network.IPv6Mode
 113     """
 114     slaac = 'slaac'
 115     stateful = 'dhcpv6-stateful'
 116     stateless = 'dhcpv6-stateless'
 117
 118
 119 class SubnetSettings(SubnetConfig):
 120     """
 121     Class to hold the configuration settings required for creating OpenStack
 122     Subnet objects
 123     deprecated
 124     """
 125
 126     def __init__(self, **kwargs):
 127         from warnings import warn
 128         warn('Use snaps.config.network.SubnetConfig instead',
 129              DeprecationWarning)
 130         super(self.__class__, self).__init__(**kwargs)
 131
 132
 133 class PortSettings(PortConfig):
 134     """
 135     Class to hold the configuration settings required for creating OpenStack
 136     Subnet objects
 137     deprecated
 138     """
 139
 140     def __init__(self, **kwargs):
 141         from warnings import warn
 142         warn('Use snaps.config.network.PortConfig instead',
 143              DeprecationWarning)
 144         super(self.__class__, self).__init__(**kwargs)