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 novaclient.exceptions import NotFound
21 from oslo_serialization import jsonutils
23 from snaps import file_utils
24 from snaps.domain.stack import Stack, Resource, Output
26 from snaps.openstack.utils import keystone_utils, neutron_utils, nova_utils
28 __author__ = 'spisarski'
30 logger = logging.getLogger('heat_utils')
33 def heat_client(os_creds):
35 Retrieves the Heat client
36 :param os_creds: the OpenStack credentials
39 logger.debug('Retrieving Nova Client')
40 return Client(os_creds.heat_api_version,
41 session=keystone_utils.keystone_session(os_creds),
42 region_name=os_creds.region_name)
45 def get_stack(heat_cli, stack_settings=None, stack_name=None):
47 Returns the first domain Stack object found. When stack_setting
48 is not None, the filter created will take the name attribute. When
49 stack_settings is None and stack_name is not, stack_name will be used
50 instead. When both are None, the first stack object received will be
52 :param heat_cli: the OpenStack heat client
53 :param stack_settings: a StackSettings object
54 :param stack_name: the name of the heat stack to return
55 :return: the Stack domain object else None
60 stack_filter['stack_name'] = stack_settings.name
62 stack_filter['stack_name'] = stack_name
64 stacks = heat_cli.stacks.list(**stack_filter)
66 return Stack(name=stack.identifier, stack_id=stack.id)
69 def get_stack_by_id(heat_cli, stack_id):
71 Returns a domain Stack object for a given ID
72 :param heat_cli: the OpenStack heat client
73 :param stack_id: the ID of the heat stack to retrieve
74 :return: the Stack domain object else None
76 stack = heat_cli.stacks.get(stack_id)
77 return Stack(name=stack.identifier, stack_id=stack.id)
80 def get_stack_status(heat_cli, stack_id):
82 Returns the current status of the Heat stack
83 :param heat_cli: the OpenStack heat client
84 :param stack_id: the ID of the heat stack to retrieve
87 return heat_cli.stacks.get(stack_id).stack_status
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 __get_os_resources(heat_cli, stack):
125 Returns all of the OpenStack resource objects for a given stack
126 :param heat_cli: the OpenStack heat client
127 :param stack: the SNAPS-OO Stack domain object
130 return heat_cli.resources.list(stack.id)
133 def get_resources(heat_cli, stack):
135 Returns all of the OpenStack resource objects for a given stack
136 :param heat_cli: the OpenStack heat client
137 :param stack: the SNAPS-OO Stack domain object
140 os_resources = __get_os_resources(heat_cli, stack)
144 for os_resource in os_resources:
145 out.append(Resource(resource_type=os_resource.resource_type,
146 resource_id=os_resource.physical_resource_id))
150 def get_outputs(heat_cli, stack):
152 Returns all of the SNAPS-OO Output domain objects for the defined outputs
154 :param heat_cli: the OpenStack heat client
155 :param stack: the SNAPS-OO Stack domain object
160 os_stack = heat_cli.stacks.get(stack.id)
164 outputs = os_stack.outputs
167 for output in outputs:
168 out.append(Output(**output))
173 def get_stack_networks(heat_cli, neutron, stack):
175 Returns an instance of NetworkSettings for each network owned by this stack
176 :param heat_cli: the OpenStack heat client object
177 :param neutron: the OpenStack neutron client object
178 :param stack: the SNAPS-OO Stack domain object
179 :return: a list of NetworkSettings
183 resources = get_resources(heat_cli, stack)
184 for resource in resources:
185 if resource.type == 'OS::Neutron::Net':
186 network = neutron_utils.get_network_by_id(
187 neutron, resource.id)
194 def get_stack_servers(heat_cli, nova, stack):
196 Returns an instance of NetworkSettings for each network owned by this stack
197 :param heat_cli: the OpenStack heat client object
198 :param nova: the OpenStack nova client object
199 :param stack: the SNAPS-OO Stack domain object
200 :return: a list of NetworkSettings
204 resources = get_resources(heat_cli, stack)
205 for resource in resources:
206 if resource.type == 'OS::Nova::Server':
208 server = nova_utils.get_server_object_by_id(
214 'VmInst cannot be located with ID %s', resource.id)
219 def parse_heat_template_str(tmpl_str):
221 Takes a heat template string, performs some simple validation and returns a
222 dict containing the parsed structure. This function supports both JSON and
223 YAML Heat template formats.
225 if tmpl_str.startswith('{'):
226 tpl = jsonutils.loads(tmpl_str)
229 tpl = yaml.load(tmpl_str, Loader=yaml_loader)
230 except yaml.YAMLError as yea:
231 raise ValueError(yea)
235 # Looking for supported version keys in the loaded template
236 if not ('HeatTemplateFormatVersion' in tpl or
237 'heat_template_version' in tpl or
238 'AWSTemplateFormatVersion' in tpl):
239 raise ValueError("Template format version not found.")