1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
# and others. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
import enum
from cinderclient.exceptions import NotFound
from neutronclient.common.utils import str2bool
from snaps.openstack.openstack_creator import OpenStackVolumeObject
from snaps.openstack.utils import cinder_utils
__author__ = 'spisarski'
logger = logging.getLogger('create_volume_type')
class OpenStackVolumeType(OpenStackVolumeObject):
"""
Class responsible for managing an volume in OpenStack
"""
def __init__(self, os_creds, volume_type_settings):
"""
Constructor
:param os_creds: The OpenStack connection credentials
:param volume_type_settings: The volume type settings
:return:
"""
super(self.__class__, self).__init__(os_creds)
self.volume_type_settings = volume_type_settings
self.__volume_type = None
def initialize(self):
"""
Loads the existing Volume
:return: The Volume domain object or None
"""
super(self.__class__, self).initialize()
self.__volume_type = cinder_utils.get_volume_type(
self._cinder, volume_type_settings=self.volume_type_settings)
return self.__volume_type
def create(self):
"""
Creates the volume in OpenStack if it does not already exist and
returns the domain Volume object
:return: The Volume domain object or None
"""
self.initialize()
if not self.__volume_type:
self.__volume_type = cinder_utils.create_volume_type(
self._cinder, self.volume_type_settings)
logger.info(
'Created volume type with name - %s',
self.volume_type_settings.name)
return self.__volume_type
def clean(self):
"""
Cleanse environment of all artifacts
:return: void
"""
if self.__volume_type:
try:
cinder_utils.delete_volume_type(self._cinder,
self.__volume_type)
except NotFound:
pass
self.__volume_type = None
def get_volume_type(self):
"""
Returns the domain Volume object as it was populated when create() was
called
:return: the object
"""
return self.__volume_type
class VolumeTypeSettings:
def __init__(self, **kwargs):
"""
Constructor
:param name: the volume's name (required)
:param description: the volume's name (optional)
:param encryption: VolumeTypeEncryptionSettings (optional)
:param qos_spec_name: name of the QoS Spec to associate (optional)
:param public: volume visibility where True denotes global
(default - False)
TODO - Implement project_access parameter that will associate this
VolumeType to a list of project names
"""
self.name = kwargs.get('name')
self.description = kwargs.get('description')
self.qos_spec_name = kwargs.get('qos_spec_name')
if 'encryption' in kwargs:
if isinstance(kwargs['encryption'], dict):
self.encryption = VolumeTypeEncryptionSettings(
**kwargs['encryption'])
elif isinstance(kwargs['encryption'],
VolumeTypeEncryptionSettings):
self.encryption = kwargs['encryption']
else:
self.encryption = None
if 'public' in kwargs:
if isinstance(kwargs['public'], str):
self.public = str2bool(kwargs['public'])
else:
self.public = kwargs['public']
else:
self.public = False
if not self.name:
raise VolumeTypeSettingsError("The attribute name is required")
def __eq__(self, other):
return (self.name == other.name
and self.description == other.description
and self.qos_spec_name == other.qos_spec_name
and self.encryption == other.encryption
and self.public == other.public)
class ControlLocation(enum.Enum):
"""
QoS Specification consumer types
"""
front_end = 'front-end'
back_end = 'back-end'
class VolumeTypeEncryptionSettings:
def __init__(self, **kwargs):
"""
Constructor
:param name: the volume's name (required)
:param provider_class: the volume's provider class (e.g. LuksEncryptor)
:param control_location: the notional service where encryption is
performed (e.g., front-end=Nova). The default
value is 'front-end.'
:param cipher: the encryption algorithm/mode to use
(e.g., aes-xts-plain64). If the field is left empty,
the provider default will be used
:param key_size: the size of the encryption key, in bits
(e.g., 128, 256). If the field is left empty, the
provider default will be used
"""
self.name = kwargs.get('name')
self.provider_class = kwargs.get('provider_class')
self.control_location = kwargs.get('control_location')
if kwargs.get('control_location'):
self.control_location = map_control_location(
kwargs['control_location'])
else:
self.control_location = None
self.cipher = kwargs.get('cipher')
self.key_size = kwargs.get('key_size')
if (not self.name or not self.provider_class
or not self.control_location):
raise VolumeTypeSettingsError(
'The attributes name, provider_class, and control_location '
'are required')
def __eq__(self, other):
return (self.name == other.name
and self.provider_class == other.provider_class
and self.control_location == other.control_location
and self.cipher == other.cipher
and self.key_size == other.key_size)
def map_control_location(control_location):
"""
Takes a the protocol value maps it to the Consumer enum. When None return
None
:param control_location: the value to map to the Enum
:return: a ControlLocation enum object
:raise: Exception if control_location parameter is invalid
"""
if not control_location:
return None
elif isinstance(control_location, ControlLocation):
return control_location
else:
proto_str = str(control_location)
if proto_str == 'front-end':
return ControlLocation.front_end
elif proto_str == 'back-end':
return ControlLocation.back_end
else:
raise VolumeTypeSettingsError('Invalid Consumer - ' + proto_str)
class VolumeTypeSettingsError(Exception):
"""
Exception to be thrown when an volume settings are incorrect
"""
def __init__(self, message):
Exception.__init__(self, message)
class VolumeTypeCreationError(Exception):
"""
Exception to be thrown when an volume cannot be created
"""
def __init__(self, message):
Exception.__init__(self, message)
|
