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
22 from oslo_serialization import jsonutils
23 from oslo_utils import encodeutils
26 import yardstick.common.openstack_utils as op_utils
27 from yardstick.common import exceptions
28 from yardstick.common import template_format
30 log = logging.getLogger(__name__)
33 HEAT_KEY_UUID_LENGTH = 8
35 PROVIDER_SRIOV = "sriov"
40 def get_short_key_uuid(uuid):
41 return str(uuid)[:HEAT_KEY_UUID_LENGTH]
44 class HeatStack(object):
45 """Represents a Heat stack (deployed template) """
47 def __init__(self, name):
50 self._cloud = shade.openstack_cloud()
53 def create(self, template, heat_parameters, wait, timeout):
54 """Creates an OpenStack stack from a template"""
55 with tempfile.NamedTemporaryFile('wb', delete=False) as template_file:
56 template_file.write(jsonutils.dump_as_bytes(template))
58 self._stack = self._cloud.create_stack(
59 self.name, template_file=template_file.name, wait=wait,
60 timeout=timeout, **heat_parameters)
61 outputs = self._stack.outputs
62 self.outputs = {output['output_key']: output['output_value'] for output
65 _DEPLOYED_STACKS[self.uuid] = self._stack
69 """Check if any stack has been deployed"""
70 return len(_DEPLOYED_STACKS) > 0
72 def delete(self, wait=True):
73 """Deletes a stack in the target cloud"""
78 ret = self._cloud.delete_stack(self.uuid, wait=wait)
80 # NOTE(ralonsoh): this exception catch solves a bug in Shade, which
81 # tries to retrieve and read the stack status when it's already
85 _DEPLOYED_STACKS.pop(self.uuid)
91 """Delete all deployed stacks"""
92 for stack in _DEPLOYED_STACKS:
97 """Retrieve the current stack status"""
99 return self._stack.status
103 """Retrieve the current stack ID"""
105 return self._stack.id
108 class HeatTemplate(object):
109 """Describes a Heat template and a method to deploy template to a stack"""
111 DESCRIPTION_TEMPLATE = """
112 Stack built by the yardstick framework for %s on host %s %s.
113 All referred generated resources are prefixed with the template
117 HEAT_WAIT_LOOP_INTERVAL = 2
118 HEAT_STATUS_COMPLETE = 'COMPLETE'
120 def _init_template(self):
121 timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
123 'heat_template_version': '2013-05-23',
124 'description': self.DESCRIPTION_TEMPLATE % (
126 socket.gethostname(),
134 # short hand for resources part of template
135 self.resources = self._template['resources']
137 def __init__(self, name, template_file=None, heat_parameters=None):
139 self.keystone_client = None
140 self.heat_parameters = {}
142 # heat_parameters is passed to heat in stack create, empty dict when
143 # yardstick creates the template (no get_param in resources part)
145 self.heat_parameters = heat_parameters
148 with open(template_file) as stream:
149 log.info('Parsing external template: %s', template_file)
150 template_str = stream.read()
151 self._template = template_format.parse(template_str)
152 self._parameters = heat_parameters
154 self._init_template()
156 log.debug("template object '%s' created", name)
158 def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
159 is_public=True, rxtx_factor=1.0, swap=0,
161 """add to the template a Flavor description"""
164 log.debug("adding Nova::Flavor '%s' vcpus '%d' ram '%d' disk '%d' "
165 "ephemeral '%d' is_public '%s' rxtx_factor '%d' "
166 "swap '%d' extra_specs '%s'",
167 name, vcpus, ram, disk, ephemeral, is_public,
168 rxtx_factor, swap, str(extra_specs))
171 assert isinstance(extra_specs, collections.Mapping)
173 self.resources[name] = {
174 'type': 'OS::Nova::Flavor',
175 'properties': {'name': name,
180 'rxtx_factor': rxtx_factor,
182 'is_public': is_public,
183 'ephemeral': ephemeral,
184 'extra_specs': extra_specs}
187 self._template['outputs'][name] = {
188 'description': 'Flavor %s ID' % name,
189 'value': {'get_resource': name}
192 def add_volume(self, name, size=10):
193 """add to the template a volume description"""
194 log.debug("adding Cinder::Volume '%s' size '%d' ", name, size)
196 self.resources[name] = {
197 'type': 'OS::Cinder::Volume',
198 'properties': {'name': name,
202 self._template['outputs'][name] = {
203 'description': 'Volume %s ID' % name,
204 'value': {'get_resource': name}
207 def add_volume_attachment(self, server_name, volume_name, mountpoint=None):
208 """add to the template an association of volume to instance"""
209 log.debug("adding Cinder::VolumeAttachment server '%s' volume '%s' ", server_name,
212 name = "%s-%s" % (server_name, volume_name)
214 volume_id = op_utils.get_volume_id(volume_name)
216 volume_id = {'get_resource': volume_name}
217 self.resources[name] = {
218 'type': 'OS::Cinder::VolumeAttachment',
219 'properties': {'instance_uuid': {'get_resource': server_name},
220 'volume_id': volume_id}
224 self.resources[name]['properties']['mountpoint'] = mountpoint
226 def add_network(self, name, physical_network='physnet1', provider=None,
227 segmentation_id=None, port_security_enabled=None, network_type=None):
228 """add to the template a Neutron Net"""
229 log.debug("adding Neutron::Net '%s'", name)
231 self.resources[name] = {
232 'type': 'OS::Neutron::Net',
238 self.resources[name] = {
239 'type': 'OS::Neutron::ProviderNet',
242 'network_type': 'flat' if network_type is None else network_type,
243 'physical_network': physical_network,
247 self.resources[name]['properties']['segmentation_id'] = segmentation_id
248 if network_type is None:
249 self.resources[name]['properties']['network_type'] = 'vlan'
250 # if port security is not defined then don't add to template:
251 # some deployments don't have port security plugin installed
252 if port_security_enabled is not None:
253 self.resources[name]['properties']['port_security_enabled'] = port_security_enabled
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, enable_dhcp='true', gateway_ip=None):
266 """add to the template a Neutron Subnet
268 log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
270 self.resources[name] = {
271 'type': 'OS::Neutron::Subnet',
272 'depends_on': network,
276 'network_id': {'get_resource': network},
277 'enable_dhcp': enable_dhcp,
280 if gateway_ip == 'null':
281 self.resources[name]['properties']['gateway_ip'] = None
282 elif gateway_ip is not None:
283 self.resources[name]['properties']['gateway_ip'] = gateway_ip
285 self._template['outputs'][name] = {
286 'description': 'subnet %s ID' % name,
287 'value': {'get_resource': name}
289 self._template['outputs'][name + "-cidr"] = {
290 'description': 'subnet %s cidr' % name,
291 'value': {'get_attr': [name, 'cidr']}
293 self._template['outputs'][name + "-gateway_ip"] = {
294 'description': 'subnet %s gateway_ip' % name,
295 'value': {'get_attr': [name, 'gateway_ip']}
298 def add_router(self, name, ext_gw_net, subnet_name):
299 """add to the template a Neutron Router and interface"""
300 log.debug("adding Neutron::Router:'%s', gw-net:'%s'", name, ext_gw_net)
301 self.resources[name] = {
302 'type': 'OS::Neutron::Router',
303 'depends_on': [subnet_name],
306 'external_gateway_info': {
307 'network': ext_gw_net
312 def add_router_interface(self, name, router_name, subnet_name):
313 """add to the template a Neutron RouterInterface and interface"""
314 log.debug("adding Neutron::RouterInterface '%s' router:'%s', "
315 "subnet:'%s'", name, router_name, subnet_name)
316 self.resources[name] = {
317 'type': 'OS::Neutron::RouterInterface',
318 'depends_on': [router_name, subnet_name],
320 'router_id': {'get_resource': router_name},
321 'subnet_id': {'get_resource': subnet_name}
325 def add_port(self, name, network_name, subnet_name, vnic_type, sec_group_id=None,
326 provider=None, allowed_address_pairs=None):
327 """add to the template a named Neutron Port
329 log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', vnic_type:'%s', "
330 "secgroup:%s", name, network_name, subnet_name, vnic_type, sec_group_id)
331 self.resources[name] = {
332 'type': 'OS::Neutron::Port',
333 'depends_on': [subnet_name],
336 'binding:vnic_type': vnic_type,
337 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
338 'network_id': {'get_resource': network_name},
339 'replacement_policy': 'AUTO',
343 if provider == PROVIDER_SRIOV:
344 self.resources[name]['properties']['binding:vnic_type'] = \
348 self.resources[name]['depends_on'].append(sec_group_id)
349 self.resources[name]['properties']['security_groups'] = \
352 if allowed_address_pairs:
353 self.resources[name]['properties'][
354 'allowed_address_pairs'] = allowed_address_pairs
356 self._template['outputs'][name] = {
357 'description': 'Address for interface %s' % name,
358 'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
360 self._template['outputs'][name + "-subnet_id"] = {
361 'description': 'Address for interface %s' % name,
362 'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
364 self._template['outputs'][name + "-mac_address"] = {
365 'description': 'MAC Address for interface %s' % name,
366 'value': {'get_attr': [name, 'mac_address']}
368 self._template['outputs'][name + "-device_id"] = {
369 'description': 'Device ID for interface %s' % name,
370 'value': {'get_attr': [name, 'device_id']}
372 self._template['outputs'][name + "-network_id"] = {
373 'description': 'Network ID for interface %s' % name,
374 'value': {'get_attr': [name, 'network_id']}
377 def add_floating_ip(self, name, network_name, port_name, router_if_name,
379 """add to the template a Nova FloatingIP resource
380 see: https://bugs.launchpad.net/heat/+bug/1299259
382 log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
383 "rif '%s'", name, network_name, port_name, router_if_name)
385 self.resources[name] = {
386 'type': 'OS::Nova::FloatingIP',
387 'depends_on': [port_name, router_if_name],
394 self.resources[name]["depends_on"].append(secgroup_name)
396 self._template['outputs'][name] = {
397 'description': 'floating ip %s' % name,
398 'value': {'get_attr': [name, 'ip']}
401 def add_floating_ip_association(self, name, floating_ip_name, port_name):
402 """add to the template a Nova FloatingIP Association resource
404 log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
405 "floating_ip '%s'", name, port_name, floating_ip_name)
407 self.resources[name] = {
408 'type': 'OS::Neutron::FloatingIPAssociation',
409 'depends_on': [port_name],
411 'floatingip_id': {'get_resource': floating_ip_name},
412 'port_id': {'get_resource': port_name}
416 def add_keypair(self, name, key_uuid):
417 """add to the template a Nova KeyPair"""
418 log.debug("adding Nova::KeyPair '%s'", name)
419 self.resources[name] = {
420 'type': 'OS::Nova::KeyPair',
423 # resource_string returns bytes, so we must decode to unicode
424 'public_key': encodeutils.safe_decode(
425 pkg_resources.resource_string(
426 'yardstick.resources',
427 'files/yardstick_key-' +
428 get_short_key_uuid(key_uuid) + '.pub'),
433 def add_servergroup(self, name, policy):
434 """add to the template a Nova ServerGroup"""
435 log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
436 if policy not in ["anti-affinity", "affinity"]:
437 raise ValueError(policy)
439 self.resources[name] = {
440 'type': 'OS::Nova::ServerGroup',
447 self._template['outputs'][name] = {
448 'description': 'ID Server Group %s' % name,
449 'value': {'get_resource': name}
452 def add_security_group(self, name):
453 """add to the template a Neutron SecurityGroup"""
454 log.debug("adding Neutron::SecurityGroup '%s'", name)
455 self.resources[name] = {
456 'type': 'OS::Neutron::SecurityGroup',
459 'description': "Group allowing IPv4 and IPv6 for icmp and upd/tcp on all ports",
461 {'remote_ip_prefix': '0.0.0.0/0',
463 'port_range_min': '1',
464 'port_range_max': '65535'},
465 {'remote_ip_prefix': '0.0.0.0/0',
467 'port_range_min': '1',
468 'port_range_max': '65535'},
469 {'remote_ip_prefix': '0.0.0.0/0',
471 {'remote_ip_prefix': '::/0',
474 'port_range_min': '1',
475 'port_range_max': '65535'},
476 {'remote_ip_prefix': '::/0',
479 'port_range_min': '1',
480 'port_range_max': '65535'},
481 {'remote_ip_prefix': '::/0',
483 'protocol': 'ipv6-icmp'},
484 {'remote_ip_prefix': '0.0.0.0/0',
485 'direction': 'egress',
487 'port_range_min': '1',
488 'port_range_max': '65535'},
489 {'remote_ip_prefix': '0.0.0.0/0',
490 'direction': 'egress',
492 'port_range_min': '1',
493 'port_range_max': '65535'},
494 {'remote_ip_prefix': '0.0.0.0/0',
495 'direction': 'egress',
497 {'remote_ip_prefix': '::/0',
498 'direction': 'egress',
501 'port_range_min': '1',
502 'port_range_max': '65535'},
503 {'remote_ip_prefix': '::/0',
504 'direction': 'egress',
507 'port_range_min': '1',
508 'port_range_max': '65535'},
509 {'remote_ip_prefix': '::/0',
510 'direction': 'egress',
512 'protocol': 'ipv6-icmp'},
517 self._template['outputs'][name] = {
518 'description': 'ID of Security Group',
519 'value': {'get_resource': name}
522 def add_server(self, name, image, flavor, flavors, ports=None, networks=None,
523 scheduler_hints=None, user=None, key_name=None, user_data=None, metadata=None,
524 additional_properties=None, availability_zone=None):
525 """add to the template a Nova Server """
526 log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
527 "ports %s", name, image, flavor, ports)
529 self.resources[name] = {
530 'type': 'OS::Nova::Server',
534 server_properties = {
538 'networks': [] # list of dictionaries
540 if availability_zone:
541 server_properties["availability_zone"] = availability_zone
543 if flavor in flavors:
544 self.resources[name]['depends_on'].append(flavor)
545 server_properties["flavor"] = {'get_resource': flavor}
547 server_properties["flavor"] = flavor
550 server_properties['admin_user'] = user
553 self.resources[name]['depends_on'].append(key_name)
554 server_properties['key_name'] = {'get_resource': key_name}
557 self.resources[name]['depends_on'].extend(ports)
559 server_properties['networks'].append(
560 {'port': {'get_resource': port}}
564 for i, _ in enumerate(networks):
565 server_properties['networks'].append({'network': networks[i]})
568 server_properties['scheduler_hints'] = scheduler_hints
571 server_properties['user_data'] = user_data
574 assert isinstance(metadata, collections.Mapping)
575 server_properties['metadata'] = metadata
577 if additional_properties:
578 assert isinstance(additional_properties, collections.Mapping)
579 for prop in additional_properties:
580 server_properties[prop] = additional_properties[prop]
582 server_properties['config_drive'] = True
584 self.resources[name]['properties'] = server_properties
586 self._template['outputs'][name] = {
587 'description': 'VM UUID',
588 'value': {'get_resource': name}
591 def create(self, block=True, timeout=3600):
592 """Creates a stack in the target based on the stored template
594 :param block: (bool) Wait for Heat create to finish
595 :param timeout: (int) Timeout in seconds for Heat create,
597 :return A dict with the requested output values from the template
599 log.info("Creating stack '%s' START", self.name)
601 start_time = time.time()
602 stack = HeatStack(self.name)
603 stack.create(self._template, self.heat_parameters, block, timeout)
606 log.info("Creating stack '%s' DONE in %d secs",
607 self.name, time.time() - start_time)
610 if stack.status != self.HEAT_STATUS_COMPLETE:
611 raise exceptions.HeatTemplateError(stack_name=self.name)
613 log.info("Creating stack '%s' DONE in %d secs",
614 self.name, time.time() - start_time)