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.
19 from heatclient.exc import HTTPNotFound
21 from snaps.openstack.create_flavor import OpenStackFlavor
22 from snaps.openstack.create_instance import OpenStackVmInstance
23 from snaps.openstack.create_keypairs import OpenStackKeypair
24 from snaps.openstack.create_router import OpenStackRouter
25 from snaps.openstack.create_volume import OpenStackVolume
26 from snaps.openstack.create_volume_type import OpenStackVolumeType
27 from snaps.openstack.openstack_creator import OpenStackCloudObject
28 from snaps.openstack.utils import (
29 nova_utils, settings_utils, glance_utils, cinder_utils)
31 from snaps.openstack.create_network import OpenStackNetwork
32 from snaps.openstack.utils import heat_utils, neutron_utils
34 __author__ = 'spisarski'
36 logger = logging.getLogger('create_stack')
38 STACK_DELETE_TIMEOUT = 1200
39 STACK_COMPLETE_TIMEOUT = 1200
41 STATUS_CREATE_FAILED = 'CREATE_FAILED'
42 STATUS_CREATE_COMPLETE = 'CREATE_COMPLETE'
43 STATUS_DELETE_COMPLETE = 'DELETE_COMPLETE'
44 STATUS_DELETE_FAILED = 'DELETE_FAILED'
47 class OpenStackHeatStack(OpenStackCloudObject, object):
49 Class responsible for managing a heat stack in OpenStack
52 def __init__(self, os_creds, stack_settings, image_settings=None,
53 keypair_settings=None):
56 :param os_creds: The OpenStack connection credentials
57 :param stack_settings: The stack settings
58 :param image_settings: A list of ImageSettings objects that were used
59 for spawning this stack
60 :param image_settings: A list of ImageSettings objects that were used
61 for spawning this stack
62 :param keypair_settings: A list of KeypairSettings objects that were
63 used for spawning this stack
66 super(self.__class__, self).__init__(os_creds)
68 self.stack_settings = stack_settings
71 self.image_settings = image_settings
73 self.image_settings = None
76 self.keypair_settings = keypair_settings
78 self.keypair_settings = None
81 self.__heat_cli = None
85 Loads the existing heat stack
86 :return: The Stack domain object or None
88 self.__heat_cli = heat_utils.heat_client(self._os_creds)
89 self.__stack = heat_utils.get_stack(
90 self.__heat_cli, stack_settings=self.stack_settings)
92 logger.info('Found stack with name - ' + self.stack_settings.name)
97 Creates the heat stack in OpenStack if it does not already exist and
98 returns the domain Stack object
99 :return: The Stack domain object or None
104 logger.info('Found stack with name - %s', self.stack_settings.name)
107 self.__stack = heat_utils.create_stack(self.__heat_cli,
110 'Created stack with name - %s', self.stack_settings.name)
111 if self.__stack and self.stack_complete(block=True):
112 logger.info('Stack is now active with name - %s',
113 self.stack_settings.name)
116 status = heat_utils.get_stack_status_reason(self.__heat_cli,
118 logger.error('ERROR: STACK CREATION FAILED: %s', status)
119 raise StackCreationError('Failure while creating stack')
123 Cleanse environment of all artifacts
128 logger.info('Deleting stack - %s', self.__stack.name)
129 heat_utils.delete_stack(self.__heat_cli, self.__stack)
132 self.stack_deleted(block=True)
133 except StackError as e:
134 # Stack deletion seems to fail quite a bit
135 logger.warn('Stack did not delete properly - %s', e)
138 for vm_inst_creator in self.get_vm_inst_creators():
140 vm_inst_creator.clean()
141 if not vm_inst_creator.vm_deleted(block=True):
142 logger.warn('Unable to deleted VM - %s',
143 vm_inst_creator.get_vm_inst().name)
145 logger.warn('Unexpected error deleting VM - %s ',
146 vm_inst_creator.get_vm_inst().name)
148 logger.info('Attempting to delete again stack - %s',
152 heat_utils.delete_stack(self.__heat_cli, self.__stack)
153 deleted = self.stack_deleted(block=True)
156 'Stack could not be deleted ' + self.__stack.name)
164 Returns the domain Stack object as it was populated when create() was
170 def get_outputs(self):
172 Returns the list of outputs as contained on the OpenStack Heat Stack
176 return heat_utils.get_outputs(self.__heat_cli, self.__stack)
178 def get_status(self):
180 Returns the list of outputs as contained on the OpenStack Heat Stack
184 return heat_utils.get_stack_status(self.__heat_cli, self.__stack.id)
186 def stack_complete(self, block=False, timeout=None,
187 poll_interval=POLL_INTERVAL):
189 Returns true when the stack status returns the value of
191 :param block: When true, thread will block until active or timeout
192 value in seconds has been exceeded (False)
193 :param timeout: The timeout value
194 :param poll_interval: The polling interval in seconds
198 timeout = self.stack_settings.stack_create_timeout
199 return self._stack_status_check(STATUS_CREATE_COMPLETE, block, timeout,
200 poll_interval, STATUS_CREATE_FAILED)
202 def stack_deleted(self, block=False, timeout=STACK_DELETE_TIMEOUT,
203 poll_interval=POLL_INTERVAL):
205 Returns true when the stack status returns the value of
207 :param block: When true, thread will block until active or timeout
208 value in seconds has been exceeded (False)
209 :param timeout: The timeout value
210 :param poll_interval: The polling interval in seconds
213 return self._stack_status_check(STATUS_DELETE_COMPLETE, block, timeout,
214 poll_interval, STATUS_DELETE_FAILED)
216 def get_network_creators(self):
218 Returns a list of network creator objects as configured by the heat
220 :return: list() of OpenStackNetwork objects
223 neutron = neutron_utils.neutron_client(self._os_creds)
226 stack_networks = heat_utils.get_stack_networks(
227 self.__heat_cli, neutron, self.__stack)
229 for stack_network in stack_networks:
230 net_settings = settings_utils.create_network_settings(
231 neutron, stack_network)
232 net_creator = OpenStackNetwork(self._os_creds, net_settings)
233 out.append(net_creator)
234 net_creator.initialize()
238 def get_router_creators(self):
240 Returns a list of router creator objects as configured by the heat
242 :return: list() of OpenStackRouter objects
245 neutron = neutron_utils.neutron_client(self._os_creds)
248 stack_routers = heat_utils.get_stack_routers(
249 self.__heat_cli, neutron, self.__stack)
251 for routers in stack_routers:
252 settings = settings_utils.create_router_settings(
254 creator = OpenStackRouter(self._os_creds, settings)
260 def get_vm_inst_creators(self, heat_keypair_option=None):
262 Returns a list of VM Instance creator objects as configured by the heat
264 :return: list() of OpenStackVmInstance objects
268 nova = nova_utils.nova_client(self._os_creds)
270 stack_servers = heat_utils.get_stack_servers(
271 self.__heat_cli, nova, self.__stack)
273 neutron = neutron_utils.neutron_client(self._os_creds)
274 glance = glance_utils.glance_client(self._os_creds)
276 for stack_server in stack_servers:
277 vm_inst_settings = settings_utils.create_vm_inst_settings(
278 nova, neutron, stack_server)
279 image_settings = settings_utils.determine_image_settings(
280 glance, stack_server, self.image_settings)
281 keypair_settings = settings_utils.determine_keypair_settings(
282 self.__heat_cli, self.__stack, stack_server,
283 keypair_settings=self.keypair_settings,
284 priv_key_key=heat_keypair_option)
285 vm_inst_creator = OpenStackVmInstance(
286 self._os_creds, vm_inst_settings, image_settings,
288 out.append(vm_inst_creator)
289 vm_inst_creator.initialize()
293 def get_volume_creators(self):
295 Returns a list of Volume creator objects as configured by the heat
297 :return: list() of OpenStackVolume objects
301 cinder = cinder_utils.cinder_client(self._os_creds)
303 volumes = heat_utils.get_stack_volumes(
304 self.__heat_cli, cinder, self.__stack)
306 for volume in volumes:
307 settings = settings_utils.create_volume_settings(volume)
308 creator = OpenStackVolume(self._os_creds, settings)
313 except Exception as e:
315 'Unexpected error initializing volume creator - %s', e)
319 def get_volume_type_creators(self):
321 Returns a list of VolumeType creator objects as configured by the heat
323 :return: list() of OpenStackVolumeType objects
327 cinder = cinder_utils.cinder_client(self._os_creds)
329 vol_types = heat_utils.get_stack_volume_types(
330 self.__heat_cli, cinder, self.__stack)
332 for volume in vol_types:
333 settings = settings_utils.create_volume_type_settings(volume)
334 creator = OpenStackVolumeType(self._os_creds, settings)
339 except Exception as e:
341 'Unexpected error initializing volume type creator - %s',
346 def get_keypair_creators(self, outputs_pk_key=None):
348 Returns a list of keypair creator objects as configured by the heat
350 :return: list() of OpenStackKeypair objects
354 nova = nova_utils.nova_client(self._os_creds)
356 keypairs = heat_utils.get_stack_keypairs(
357 self.__heat_cli, nova, self.__stack)
359 for keypair in keypairs:
360 settings = settings_utils.create_keypair_settings(
361 self.__heat_cli, self.__stack, keypair, outputs_pk_key)
362 creator = OpenStackKeypair(self._os_creds, settings)
367 except Exception as e:
369 'Unexpected error initializing volume type creator - %s',
374 def get_flavor_creators(self):
376 Returns a list of Flavor creator objects as configured by the heat
378 :return: list() of OpenStackFlavor objects
382 nova = nova_utils.nova_client(self._os_creds)
384 flavors = heat_utils.get_stack_flavors(
385 self.__heat_cli, nova, self.__stack)
387 for flavor in flavors:
388 settings = settings_utils.create_flavor_settings(flavor)
389 creator = OpenStackFlavor(self._os_creds, settings)
394 except Exception as e:
396 'Unexpected error initializing volume creator - %s', e)
400 def _stack_status_check(self, expected_status_code, block, timeout,
401 poll_interval, fail_status):
403 Returns true when the stack status returns the value of
405 :param expected_status_code: stack status evaluated with this string
407 :param block: When true, thread will block until active or timeout
408 value in seconds has been exceeded (False)
409 :param timeout: The timeout value
410 :param poll_interval: The polling interval in seconds
411 :param fail_status: Returns false if the fail_status code is found
414 # sleep and wait for stack status change
418 start = time.time() - timeout
420 while timeout > time.time() - start:
421 status = self._status(expected_status_code, fail_status)
424 'Stack is active with name - ' + self.stack_settings.name)
427 logger.debug('Retry querying stack status in ' + str(
428 poll_interval) + ' seconds')
429 time.sleep(poll_interval)
430 logger.debug('Stack status query timeout in ' + str(
431 timeout - (time.time() - start)))
434 'Timeout checking for stack status for ' + expected_status_code)
437 def _status(self, expected_status_code, fail_status=STATUS_CREATE_FAILED):
439 Returns True when active else False
440 :param expected_status_code: stack status evaluated with this string
444 status = self.get_status()
447 'Cannot stack status for stack with ID - ' + self.__stack.id)
450 if fail_status and status == fail_status:
451 raise StackError('Stack had an error')
452 logger.debug('Stack status is - ' + status)
453 return status == expected_status_code
457 def __init__(self, **kwargs):
460 :param name: the stack's name (required)
461 :param template: the heat template in dict() format (required if
462 template_path attribute is None)
463 :param template_path: the location of the heat template file (required
464 if template attribute is None)
465 :param env_values: dict() of strings for substitution of template
466 default values (optional)
469 self.name = kwargs.get('name')
470 self.template = kwargs.get('template')
471 self.template_path = kwargs.get('template_path')
472 self.env_values = kwargs.get('env_values')
473 if 'stack_create_timeout' in kwargs:
474 self.stack_create_timeout = kwargs['stack_create_timeout']
476 self.stack_create_timeout = STACK_COMPLETE_TIMEOUT
479 raise StackSettingsError('name is required')
481 if not self.template and not self.template_path:
482 raise StackSettingsError('A Heat template is required')
484 def __eq__(self, other):
485 return (self.name == other.name and
486 self.template == other.template and
487 self.template_path == other.template_path and
488 self.env_values == other.env_values and
489 self.stack_create_timeout == other.stack_create_timeout)
492 class StackSettingsError(Exception):
494 Exception to be thrown when an stack settings are incorrect
498 class StackCreationError(Exception):
500 Exception to be thrown when an stack cannot be created
504 class StackError(Exception):