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
|
# 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 time
from heatclient.exc import HTTPNotFound
from snaps.openstack.utils import heat_utils
__author__ = 'spisarski'
logger = logging.getLogger('create_stack')
STACK_COMPLETE_TIMEOUT = 1200
POLL_INTERVAL = 3
STATUS_CREATE_FAILED = 'CREATE_FAILED'
STATUS_CREATE_COMPLETE = 'CREATE_COMPLETE'
STATUS_DELETE_COMPLETE = 'DELETE_COMPLETE'
class OpenStackHeatStack:
"""
Class responsible for creating an heat stack in OpenStack
"""
def __init__(self, os_creds, stack_settings):
"""
Constructor
:param os_creds: The OpenStack connection credentials
:param stack_settings: The stack settings
:return:
"""
self.__os_creds = os_creds
self.stack_settings = stack_settings
self.__stack = None
self.__heat_cli = None
def create(self, cleanup=False):
"""
Creates the heat stack in OpenStack if it does not already exist and
returns the domain Stack object
:param cleanup: Denotes whether or not this is being called for cleanup
:return: The OpenStack Stack object
"""
self.__heat_cli = heat_utils.heat_client(self.__os_creds)
self.__stack = heat_utils.get_stack_by_name(self.__heat_cli,
self.stack_settings.name)
if self.__stack:
logger.info('Found stack with name - ' + self.stack_settings.name)
return self.__stack
elif not cleanup:
self.__stack = heat_utils.create_stack(self.__heat_cli,
self.stack_settings)
logger.info(
'Created stack with name - ' + self.stack_settings.name)
if self.__stack and self.stack_complete(block=True):
logger.info(
'Stack is now active with name - ' +
self.stack_settings.name)
return self.__stack
else:
raise StackCreationError(
'Stack was not created or activated in the alloted amount '
'of time')
else:
logger.info('Did not create stack due to cleanup mode')
return self.__stack
def clean(self):
"""
Cleanse environment of all artifacts
:return: void
"""
if self.__stack:
try:
heat_utils.delete_stack(self.__heat_cli, self.__stack)
except HTTPNotFound:
pass
self.__stack = None
def get_stack(self):
"""
Returns the domain Stack object as it was populated when create() was
called
:return: the object
"""
return self.__stack
def get_outputs(self):
"""
Returns the list of outputs as contained on the OpenStack Heat Stack
object
:return:
"""
return heat_utils.get_stack_outputs(self.__heat_cli, self.__stack.id)
def get_status(self):
"""
Returns the list of outputs as contained on the OpenStack Heat Stack
object
:return:
"""
return heat_utils.get_stack_status(self.__heat_cli, self.__stack.id)
def stack_complete(self, block=False, timeout=None,
poll_interval=POLL_INTERVAL):
"""
Returns true when the stack status returns the value of
expected_status_code
:param block: When true, thread will block until active or timeout
value in seconds has been exceeded (False)
:param timeout: The timeout value
:param poll_interval: The polling interval in seconds
:return: T/F
"""
if not timeout:
timeout = self.stack_settings.stack_create_timeout
return self._stack_status_check(STATUS_CREATE_COMPLETE, block, timeout,
poll_interval)
def _stack_status_check(self, expected_status_code, block, timeout,
poll_interval):
"""
Returns true when the stack status returns the value of
expected_status_code
:param expected_status_code: stack status evaluated with this string
value
:param block: When true, thread will block until active or timeout
value in seconds has been exceeded (False)
:param timeout: The timeout value
:param poll_interval: The polling interval in seconds
:return: T/F
"""
# sleep and wait for stack status change
if block:
start = time.time()
else:
start = time.time() - timeout
while timeout > time.time() - start:
status = self._status(expected_status_code)
if status:
logger.debug(
'Stack is active with name - ' + self.stack_settings.name)
return True
logger.debug('Retry querying stack status in ' + str(
poll_interval) + ' seconds')
time.sleep(poll_interval)
logger.debug('Stack status query timeout in ' + str(
timeout - (time.time() - start)))
logger.error(
'Timeout checking for stack status for ' + expected_status_code)
return False
def _status(self, expected_status_code):
"""
Returns True when active else False
:param expected_status_code: stack status evaluated with this string
value
:return: T/F
"""
status = self.get_status()
if not status:
logger.warning(
'Cannot stack status for stack with ID - ' + self.__stack.id)
return False
if status == STATUS_CREATE_FAILED:
raise StackCreationError('Stack had an error during deployment')
logger.debug('Stack status is - ' + status)
return status == expected_status_code
class StackSettings:
def __init__(self, **kwargs):
"""
Constructor
:param name: the stack's name (required)
:param template: the heat template in dict() format (required if
template_path attribute is None)
:param template_path: the location of the heat template file (required
if template attribute is None)
:param env_values: k/v pairs of strings for substitution of template
default values (optional)
"""
self.name = kwargs.get('name')
self.template = kwargs.get('template')
self.template_path = kwargs.get('template_path')
self.env_values = kwargs.get('env_values')
if 'stack_create_timeout' in kwargs:
self.stack_create_timeout = kwargs['stack_create_timeout']
else:
self.stack_create_timeout = STACK_COMPLETE_TIMEOUT
if not self.name:
raise StackSettingsError('name is required')
if not self.template and not self.template_path:
raise StackSettingsError('A Heat template is required')
class StackSettingsError(Exception):
"""
Exception to be thrown when an stack settings are incorrect
"""
def __init__(self, message):
Exception.__init__(self, message)
class StackCreationError(Exception):
"""
Exception to be thrown when an stack cannot be created
"""
def __init__(self, message):
Exception.__init__(self, message)
|
