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 heatclient.client import Client
19 from heatclient.common.template_format import yaml_loader
20 from oslo_serialization import jsonutils
22 from snaps import file_utils
23 from snaps.domain.stack import Stack
25 from snaps.openstack.utils import keystone_utils
27 __author__ = 'spisarski'
29 logger = logging.getLogger('heat_utils')
32 def heat_client(os_creds):
34 Retrieves the Heat client
35 :param os_creds: the OpenStack credentials
38 logger.debug('Retrieving Nova Client')
39 return Client(os_creds.heat_api_version,
40 session=keystone_utils.keystone_session(os_creds),
41 region_name=os_creds.region_name)
44 def get_stack_by_name(heat_cli, stack_name):
46 Returns a domain Stack object
47 :param heat_cli: the OpenStack heat client
48 :param stack_name: the name of the heat stack
49 :return: the Stack domain object else None
51 stacks = heat_cli.stacks.list(**{'name': stack_name})
53 return Stack(name=stack.identifier, stack_id=stack.id)
58 def get_stack_by_id(heat_cli, stack_id):
60 Returns a domain Stack object for a given ID
61 :param heat_cli: the OpenStack heat client
62 :param stack_id: the ID of the heat stack to retrieve
63 :return: the Stack domain object else None
65 stack = heat_cli.stacks.get(stack_id)
66 return Stack(name=stack.identifier, stack_id=stack.id)
69 def get_stack_status(heat_cli, stack_id):
71 Returns the current status of the Heat stack
72 :param heat_cli: the OpenStack heat client
73 :param stack_id: the ID of the heat stack to retrieve
76 return heat_cli.stacks.get(stack_id).stack_status
79 def get_stack_outputs(heat_cli, stack_id):
81 Returns a domain Stack object for a given ID
82 :param heat_cli: the OpenStack heat client
83 :param stack_id: the ID of the heat stack to retrieve
84 :return: the Stack domain object else None
86 stack = heat_cli.stacks.get(stack_id)
90 def create_stack(heat_cli, stack_settings):
92 Executes an Ansible playbook to the given host
93 :param heat_cli: the OpenStack heat client object
94 :param stack_settings: the stack configuration
95 :return: the Stack domain object
99 if stack_settings.template:
100 args['template'] = stack_settings.template
102 args['template'] = parse_heat_template_str(
103 file_utils.read_file(stack_settings.template_path))
104 args['stack_name'] = stack_settings.name
106 if stack_settings.env_values:
107 args['parameters'] = stack_settings.env_values
109 stack = heat_cli.stacks.create(**args)
111 return get_stack_by_id(heat_cli, stack_id=stack['stack']['id'])
114 def delete_stack(heat_cli, stack):
116 Deletes the Heat stack
117 :param heat_cli: the OpenStack heat client object
118 :param stack: the OpenStack Heat stack object
120 heat_cli.stacks.delete(stack.id)
123 def parse_heat_template_str(tmpl_str):
125 Takes a heat template string, performs some simple validation and returns a
126 dict containing the parsed structure. This function supports both JSON and
127 YAML Heat template formats.
129 if tmpl_str.startswith('{'):
130 tpl = jsonutils.loads(tmpl_str)
133 tpl = yaml.load(tmpl_str, Loader=yaml_loader)
134 except yaml.YAMLError as yea:
135 raise ValueError(yea)
139 # Looking for supported version keys in the loaded template
140 if not ('HeatTemplateFormatVersion' in tpl or
141 'heat_template_version' in tpl or
142 'AWSTemplateFormatVersion' in tpl):
143 raise ValueError("Template format version not found.")