1 #############################################################################
2 # Copyright (c) 2015-2017 Ericsson AB and others.
4 # All rights reserved. This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 # http://www.apache.org/licenses/LICENSE-2.0
8 ##############################################################################
10 """Heat template and stack management"""
12 from __future__ import absolute_import
13 from __future__ import print_function
14 from six.moves import range
27 from oslo_utils import encodeutils
29 import yardstick.common.openstack_utils as op_utils
30 from yardstick.common import template_format
32 log = logging.getLogger(__name__)
35 HEAT_KEY_UUID_LENGTH = 8
37 PROVIDER_SRIOV = "sriov"
40 def get_short_key_uuid(uuid):
41 return str(uuid)[:HEAT_KEY_UUID_LENGTH]
44 class HeatObject(object):
45 """base class for template and stack"""
48 self._heat_client = None
52 def heat_client(self):
53 """returns a heat client instance"""
55 if self._heat_client is None:
56 sess = op_utils.get_session()
57 heat_endpoint = op_utils.get_endpoint(service_type='orchestration')
58 self._heat_client = heatclient.client.Client(
59 op_utils.get_heat_api_version(),
60 endpoint=heat_endpoint, session=sess)
62 return self._heat_client
65 """returns stack state as a string"""
66 heat_client = self.heat_client
67 stack = heat_client.stacks.get(self.uuid)
68 return stack.stack_status
71 class HeatStack(HeatObject):
72 """Represents a Heat stack (deployed template) """
75 def __init__(self, name):
76 super(HeatStack, self).__init__()
80 HeatStack.stacks.append(self)
84 """check if any stack has been deployed"""
85 return len(HeatStack.stacks) > 0
88 """deletes a stack from the target cloud using heat"""
92 log.info("Deleting stack '%s', uuid:%s", self.name, self.uuid)
93 heat = self.heat_client
94 template = heat.stacks.get(self.uuid)
95 start_time = time.time()
98 for status in iter(self.status, u'DELETE_COMPLETE'):
99 log.debug("stack state %s", status)
100 if status == u'DELETE_FAILED':
102 heat.stacks.get(self.uuid).stack_status_reason)
106 end_time = time.time()
107 log.info("Deleted stack '%s' in %d secs", self.name,
108 end_time - start_time)
111 def delete(self, block=True, retries=3):
112 """deletes a stack in the target cloud using heat (with retry)
113 Sometimes delete fail with "InternalServerError" and the next attempt
114 succeeds. So it is worthwhile to test a couple of times.
116 if self.uuid is None:
123 for _ in range(retries):
127 except RuntimeError as err:
128 log.warning(err.args)
131 # if still not deleted try once more and let it fail everything
132 if self.uuid is not None:
135 HeatStack.stacks.remove(self)
139 for stack in HeatStack.stacks[:]:
144 raise RuntimeError("not implemented")
147 class HeatTemplate(HeatObject):
148 """Describes a Heat template and a method to deploy template to a stack"""
150 DESCRIPTION_TEMPLATE = """\
151 Stack built by the yardstick framework for %s on host %s %s.
152 All referred generated resources are prefixed with the template
156 def _init_template(self):
157 timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
159 'heat_template_version': '2013-05-23',
160 'description': self.DESCRIPTION_TEMPLATE % (
162 socket.gethostname(),
170 # short hand for resources part of template
171 self.resources = self._template['resources']
173 def __init__(self, name, template_file=None, heat_parameters=None):
174 super(HeatTemplate, self).__init__()
176 self.state = "NOT_CREATED"
177 self.keystone_client = None
178 self.heat_parameters = {}
180 # heat_parameters is passed to heat in stack create, empty dict when
181 # yardstick creates the template (no get_param in resources part)
183 self.heat_parameters = heat_parameters
186 with open(template_file) as stream:
187 print("Parsing external template:", template_file)
188 template_str = stream.read()
189 self._template = template_format.parse(template_str)
190 self._parameters = heat_parameters
192 self._init_template()
194 # holds results of requested output after deployment
197 log.debug("template object '%s' created", name)
199 def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
200 is_public=True, rxtx_factor=1.0, swap=0,
202 """add to the template a Flavor description"""
205 log.debug("adding Nova::Flavor '%s' vcpus '%d' ram '%d' disk '%d' " +
206 "ephemeral '%d' is_public '%s' rxtx_factor '%d' " +
207 "swap '%d' extra_specs '%s' ",
208 name, vcpus, ram, disk, ephemeral, is_public,
209 rxtx_factor, swap, str(extra_specs))
212 assert isinstance(extra_specs, collections.Mapping)
214 self.resources[name] = {
215 'type': 'OS::Nova::Flavor',
216 'properties': {'name': name,
221 'rxtx_factor': rxtx_factor,
223 'is_public': is_public,
224 'ephemeral': ephemeral,
225 'extra_specs': extra_specs}
228 self._template['outputs'][name] = {
229 'description': 'Flavor %s ID' % name,
230 'value': {'get_resource': name}
233 def add_network(self, name, physical_network='physnet1', provider=None,
234 segmentation_id=None):
235 """add to the template a Neutron Net"""
236 log.debug("adding Neutron::Net '%s'", name)
238 self.resources[name] = {
239 'type': 'OS::Neutron::Net',
240 'properties': {'name': name}
243 self.resources[name] = {
244 'type': 'OS::Neutron::ProviderNet',
247 'network_type': 'vlan',
248 'physical_network': physical_network
252 seg_id_dit = {'segmentation_id': segmentation_id}
253 self.resources[name]["properties"].update(seg_id_dit)
255 def add_server_group(self, name, policies): # pragma: no cover
256 """add to the template a ServerGroup"""
257 log.debug("adding Nova::ServerGroup '%s'", name)
258 policies = policies if isinstance(policies, list) else [policies]
259 self.resources[name] = {
260 'type': 'OS::Nova::ServerGroup',
261 'properties': {'name': name,
262 'policies': policies}
265 def add_subnet(self, name, network, cidr):
266 """add to the template a Neutron Subnet"""
267 log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
269 self.resources[name] = {
270 'type': 'OS::Neutron::Subnet',
271 'depends_on': network,
275 'network_id': {'get_resource': network}
279 self._template['outputs'][name] = {
280 'description': 'subnet %s ID' % name,
281 'value': {'get_resource': name}
283 self._template['outputs'][name + "-cidr"] = {
284 'description': 'subnet %s cidr' % name,
285 'value': {'get_attr': [name, 'cidr']}
287 self._template['outputs'][name + "-gateway_ip"] = {
288 'description': 'subnet %s gateway_ip' % name,
289 'value': {'get_attr': [name, 'gateway_ip']}
292 def add_router(self, name, ext_gw_net, subnet_name):
293 """add to the template a Neutron Router and interface"""
294 log.debug("adding Neutron::Router:'%s', gw-net:'%s'", name, ext_gw_net)
295 self.resources[name] = {
296 'type': 'OS::Neutron::Router',
297 'depends_on': [subnet_name],
300 'external_gateway_info': {
301 'network': ext_gw_net
306 def add_router_interface(self, name, router_name, subnet_name):
307 """add to the template a Neutron RouterInterface and interface"""
308 log.debug("adding Neutron::RouterInterface '%s' router:'%s', "
309 "subnet:'%s'", name, router_name, subnet_name)
310 self.resources[name] = {
311 'type': 'OS::Neutron::RouterInterface',
312 'depends_on': [router_name, subnet_name],
314 'router_id': {'get_resource': router_name},
315 'subnet_id': {'get_resource': subnet_name}
319 def add_port(self, name, network_name, subnet_name, sec_group_id=None,
321 """add to the template a named Neutron Port"""
322 log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', "
323 "secgroup:%s", name, network_name, subnet_name, sec_group_id)
324 self.resources[name] = {
325 'type': 'OS::Neutron::Port',
326 'depends_on': [subnet_name],
329 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
330 'network_id': {'get_resource': network_name},
331 'replacement_policy': 'AUTO',
335 if provider == PROVIDER_SRIOV:
336 self.resources[name]['properties']['binding:vnic_type'] = \
340 self.resources[name]['depends_on'].append(sec_group_id)
341 self.resources[name]['properties']['security_groups'] = \
344 self._template['outputs'][name] = {
345 'description': 'Address for interface %s' % name,
346 'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
348 self._template['outputs'][name + "-subnet_id"] = {
349 'description': 'Address for interface %s' % name,
350 'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
352 self._template['outputs'][name + "-mac_address"] = {
353 'description': 'MAC Address for interface %s' % name,
354 'value': {'get_attr': [name, 'mac_address']}
356 self._template['outputs'][name + "-device_id"] = {
357 'description': 'Device ID for interface %s' % name,
358 'value': {'get_attr': [name, 'device_id']}
360 self._template['outputs'][name + "-network_id"] = {
361 'description': 'Network ID for interface %s' % name,
362 'value': {'get_attr': [name, 'network_id']}
365 def add_floating_ip(self, name, network_name, port_name, router_if_name,
367 """add to the template a Nova FloatingIP resource
368 see: https://bugs.launchpad.net/heat/+bug/1299259
370 log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
371 "rif '%s'", name, network_name, port_name, router_if_name)
373 self.resources[name] = {
374 'type': 'OS::Nova::FloatingIP',
375 'depends_on': [port_name, router_if_name],
382 self.resources[name]["depends_on"].append(secgroup_name)
384 self._template['outputs'][name] = {
385 'description': 'floating ip %s' % name,
386 'value': {'get_attr': [name, 'ip']}
389 def add_floating_ip_association(self, name, floating_ip_name, port_name):
390 """add to the template a Nova FloatingIP Association resource
392 log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
393 "floating_ip '%s'", name, port_name, floating_ip_name)
395 self.resources[name] = {
396 'type': 'OS::Neutron::FloatingIPAssociation',
397 'depends_on': [port_name],
399 'floatingip_id': {'get_resource': floating_ip_name},
400 'port_id': {'get_resource': port_name}
404 def add_keypair(self, name, key_uuid):
405 """add to the template a Nova KeyPair"""
406 log.debug("adding Nova::KeyPair '%s'", name)
407 self.resources[name] = {
408 'type': 'OS::Nova::KeyPair',
411 # resource_string returns bytes, so we must decode to unicode
412 'public_key': encodeutils.safe_decode(
413 pkg_resources.resource_string(
414 'yardstick.resources',
415 'files/yardstick_key-' +
416 get_short_key_uuid(key_uuid) + '.pub'),
421 def add_servergroup(self, name, policy):
422 """add to the template a Nova ServerGroup"""
423 log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
424 if policy not in ["anti-affinity", "affinity"]:
425 raise ValueError(policy)
427 self.resources[name] = {
428 'type': 'OS::Nova::ServerGroup',
435 self._template['outputs'][name] = {
436 'description': 'ID Server Group %s' % name,
437 'value': {'get_resource': name}
440 def add_security_group(self, name):
441 """add to the template a Neutron SecurityGroup"""
442 log.debug("adding Neutron::SecurityGroup '%s'", name)
443 self.resources[name] = {
444 'type': 'OS::Neutron::SecurityGroup',
447 'description': "Group allowing icmp and upd/tcp on all ports",
449 {'remote_ip_prefix': '0.0.0.0/0',
451 'port_range_min': '1',
452 'port_range_max': '65535'},
453 {'remote_ip_prefix': '0.0.0.0/0',
455 'port_range_min': '1',
456 'port_range_max': '65535'},
457 {'remote_ip_prefix': '0.0.0.0/0',
463 self._template['outputs'][name] = {
464 'description': 'ID of Security Group',
465 'value': {'get_resource': name}
468 def add_server(self, name, image, flavor, flavors, ports=None,
469 networks=None, scheduler_hints=None, user=None,
470 key_name=None, user_data=None, metadata=None,
471 additional_properties=None):
472 """add to the template a Nova Server"""
473 log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
474 "ports %s", name, image, flavor, ports)
476 self.resources[name] = {
477 'type': 'OS::Nova::Server',
481 server_properties = {
485 'networks': [] # list of dictionaries
488 if flavor in flavors:
489 self.resources[name]['depends_on'].append(flavor)
490 server_properties["flavor"] = {'get_resource': flavor}
492 server_properties["flavor"] = flavor
495 server_properties['admin_user'] = user
498 self.resources[name]['depends_on'].append(key_name)
499 server_properties['key_name'] = {'get_resource': key_name}
502 self.resources[name]['depends_on'].extend(ports)
504 server_properties['networks'].append(
505 {'port': {'get_resource': port}}
509 for i, _ in enumerate(networks):
510 server_properties['networks'].append({'network': networks[i]})
513 server_properties['scheduler_hints'] = scheduler_hints
516 server_properties['user_data'] = user_data
519 assert isinstance(metadata, collections.Mapping)
520 server_properties['metadata'] = metadata
522 if additional_properties:
523 assert isinstance(additional_properties, collections.Mapping)
524 for prop in additional_properties:
525 server_properties[prop] = additional_properties[prop]
527 server_properties['config_drive'] = True
529 self.resources[name]['properties'] = server_properties
531 self._template['outputs'][name] = {
532 'description': 'VM UUID',
533 'value': {'get_resource': name}
536 HEAT_WAIT_LOOP_INTERVAL = 2
538 def create(self, block=True, timeout=3600):
540 creates a template in the target cloud using heat
541 returns a dict with the requested output values from the template
543 :param block: Wait for Heat create to finish
545 :param: timeout: timeout in seconds for Heat create, default 3600s
548 log.info("Creating stack '%s'", self.name)
550 # create stack early to support cleanup, e.g. ctrl-c while waiting
551 stack = HeatStack(self.name)
553 heat_client = self.heat_client
554 start_time = time.time()
555 stack.uuid = self.uuid = heat_client.stacks.create(
556 stack_name=self.name, template=self._template,
557 parameters=self.heat_parameters)['stack']['id']
560 self.outputs = stack.outputs = {}
563 time_limit = start_time + timeout
564 for status in iter(self.status, u'CREATE_COMPLETE'):
565 log.debug("stack state %s", status)
566 if status == u'CREATE_FAILED':
567 stack_status_reason = heat_client.stacks.get(self.uuid).stack_status_reason
568 heat_client.stacks.delete(self.uuid)
569 raise RuntimeError(stack_status_reason)
570 if time.time() > time_limit:
571 raise RuntimeError("Heat stack create timeout")
573 time.sleep(self.HEAT_WAIT_LOOP_INTERVAL)
575 end_time = time.time()
576 outputs = heat_client.stacks.get(self.uuid).outputs
577 log.info("Created stack '%s' in %d secs",
578 self.name, end_time - start_time)
580 # keep outputs as unicode
581 self.outputs = {output["output_key"]: output["output_value"] for output
584 stack.outputs = self.outputs