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.
18 from neutronclient.common.exceptions import NetworkNotFoundClient, Unauthorized
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
24 __author__ = 'spisarski'
26 logger = logging.getLogger('OpenStackNetwork')
29 class OpenStackNetwork(OpenStackNetworkObject):
31 Class responsible for managing a network in OpenStack
34 def __init__(self, os_creds, network_settings):
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
40 super(self.__class__, self).__init__(os_creds)
42 self.network_settings = network_settings
44 # Attributes instantiated on create()
49 Loads the existing OpenStack network/subnet
50 :return: The Network domain object or None
52 super(self.__class__, self).initialize()
55 self.__network = neutron_utils.get_network(
56 self._neutron, network_settings=self.network_settings,
57 project_id=self.network_settings.get_project_id(
59 except Unauthorized as e:
60 logger.warn('Unable to lookup network with name %s - %s',
61 self.network_settings.name, e)
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
73 if not self.__network:
74 self.__network = neutron_utils.create_network(
75 self._neutron, self._os_creds, self.network_settings)
77 'Network [%s] created successfully' % self.__network.id)
83 Removes and deletes all items created in reverse order.
87 neutron_utils.delete_network(self._neutron, self.__network)
88 except NetworkNotFoundClient:
92 def get_network(self):
94 Returns the created OpenStack network object
95 :return: the OpenStack network object
100 class NetworkSettings(NetworkConfig):
102 Class to hold the configuration settings required for creating OpenStack
107 def __init__(self, **kwargs):
108 from warnings import warn
109 warn('Use snaps.config.network.NetworkConfig instead',
111 super(self.__class__, self).__init__(**kwargs)
114 class IPv6Mode(enum.Enum):
117 deprecated - use snaps.config.network.IPv6Mode
120 stateful = 'dhcpv6-stateful'
121 stateless = 'dhcpv6-stateless'
124 class SubnetSettings(SubnetConfig):
126 Class to hold the configuration settings required for creating OpenStack
131 def __init__(self, **kwargs):
132 from warnings import warn
133 warn('Use snaps.config.network.SubnetConfig instead',
135 super(self.__class__, self).__init__(**kwargs)
138 class PortSettings(PortConfig):
140 Class to hold the configuration settings required for creating OpenStack
145 def __init__(self, **kwargs):
146 from warnings import warn
147 warn('Use snaps.config.network.PortConfig instead',
149 super(self.__class__, self).__init__(**kwargs)