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
|
# 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
from keystoneclient.exceptions import NotFound, Conflict
from snaps.openstack.openstack_creator import OpenStackIdentityObject
from snaps.openstack.utils import keystone_utils, neutron_utils, nova_utils
__author__ = 'spisarski'
logger = logging.getLogger('create_image')
class OpenStackProject(OpenStackIdentityObject):
"""
Class responsible for managing a project/project in OpenStack
"""
def __init__(self, os_creds, project_settings):
"""
Constructor
:param os_creds: The OpenStack connection credentials
:param project_settings: The project's settings
:return:
"""
super(self.__class__, self).__init__(os_creds)
self.project_settings = project_settings
self.__project = None
self.__role = None
self.__role_name = self.project_settings.name + '-role'
def initialize(self):
"""
Loads the existing Project object if it exists
:return: The Project domain object
"""
super(self.__class__, self).initialize()
self.__project = keystone_utils.get_project(
keystone=self._keystone, project_settings=self.project_settings)
return self.__project
def create(self):
"""
Creates a Project/Tenant in OpenStack if it does not already exist
:return: The Project domain object
"""
self.initialize()
if not self.__project:
self.__project = keystone_utils.create_project(
self._keystone, self.project_settings)
for username in self.project_settings.users:
user = keystone_utils.get_user(self._keystone, username)
if user:
try:
self.assoc_user(user)
except Conflict as e:
logger.warn('Unable to associate user %s due to %s',
user.name, e)
return self.__project
def clean(self):
"""
Cleanse environment of all artifacts
:return: void
"""
if self.__project:
# Delete security group 'default' if exists
neutron = neutron_utils.neutron_client(self._os_creds)
default_sec_grp = neutron_utils.get_security_group(
neutron, sec_grp_name='default',
project_id=self.__project.id)
if default_sec_grp:
try:
neutron_utils.delete_security_group(
neutron, default_sec_grp)
except:
pass
# Delete Project
try:
keystone_utils.delete_project(self._keystone, self.__project)
except NotFound:
pass
self.__project = None
if self.__role:
try:
keystone_utils.delete_role(self._keystone, self.__role)
except NotFound:
pass
self.__project = None
# Final role check in case init was done from an existing instance
role = keystone_utils.get_role_by_name(
self._keystone, self.__role_name)
if role:
keystone_utils.delete_role(self._keystone, role)
def get_project(self):
"""
Returns the OpenStack project object populated on create()
:return:
"""
return self.__project
def assoc_user(self, user):
"""
The user object to associate with the project
:param user: the OpenStack User domain object to associate with project
:return:
"""
if not self.__role:
self.__role = keystone_utils.get_role_by_name(
self._keystone, self.__role_name)
if not self.__role:
self.__role = keystone_utils.create_role(
self._keystone, self.__role_name)
keystone_utils.grant_user_role_to_project(self._keystone, self.__role,
user, self.__project)
def get_compute_quotas(self):
"""
Returns the compute quotas as an instance of the ComputeQuotas class
:return:
"""
nova = nova_utils.nova_client(self._os_creds)
return nova_utils.get_compute_quotas(nova, self.__project.id)
def get_network_quotas(self):
"""
Returns the network quotas as an instance of the NetworkQuotas class
:return:
"""
neutron = neutron_utils.neutron_client(self._os_creds)
return neutron_utils.get_network_quotas(neutron, self.__project.id)
def update_compute_quotas(self, compute_quotas):
"""
Updates the compute quotas for this project
:param compute_quotas: a ComputeQuotas object.
"""
nova = nova_utils.nova_client(self._os_creds)
nova_utils.update_quotas(nova, self.__project.id, compute_quotas)
def update_network_quotas(self, network_quotas):
"""
Updates the network quotas for this project
:param network_quotas: a NetworkQuotas object.
"""
neutron = neutron_utils.neutron_client(self._os_creds)
neutron_utils.update_quotas(neutron, self.__project.id, network_quotas)
class ProjectSettings:
"""
Class to hold the configuration settings required for creating OpenStack
project objects
"""
def __init__(self, **kwargs):
"""
Constructor
:param name: the project's name (required)
:param domain or domain_name: the project's domain name
(default = 'Default').
Field is used for v3 clients
:param description: the description (optional)
:param users: list of users to associate project to (optional)
:param enabled: denotes whether or not the project is enabled
(default True)
"""
self.name = kwargs.get('name')
self.domain_name = kwargs.get(
'domain', kwargs.get('domain', 'Default'))
self.description = kwargs.get('description')
if kwargs.get('enabled') is not None:
self.enabled = kwargs['enabled']
else:
self.enabled = True
self.users = kwargs.get('users', list())
if not self.name:
raise ProjectSettingsError(
"The attribute name is required for ProjectSettings")
class ProjectSettingsError(Exception):
"""
Exception to be thrown when project settings attributes are incorrect
"""
|
