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 PROVIDER_SRIOV = "sriov"
38 class HeatStack(object):
39 """Represents a Heat stack (deployed template) """
41 def __init__(self, name):
44 self._cloud = shade.openstack_cloud()
47 def create(self, template, heat_parameters, wait, timeout):
48 """Creates an OpenStack stack from a template"""
49 with tempfile.NamedTemporaryFile('wb', delete=False) as template_file:
50 template_file.write(jsonutils.dump_as_bytes(template))
52 self._stack = self._cloud.create_stack(
53 self.name, template_file=template_file.name, wait=wait,
54 timeout=timeout, **heat_parameters)
55 outputs = self._stack.outputs
56 self.outputs = {output['output_key']: output['output_value'] for output
59 _DEPLOYED_STACKS[self.uuid] = self._stack
63 """Check if any stack has been deployed"""
64 return len(_DEPLOYED_STACKS) > 0
66 def delete(self, wait=True):
67 """Deletes a stack in the target cloud"""
72 ret = self._cloud.delete_stack(self.uuid, wait=wait)
74 # NOTE(ralonsoh): this exception catch solves a bug in Shade, which
75 # tries to retrieve and read the stack status when it's already
79 _DEPLOYED_STACKS.pop(self.uuid)
85 """Delete all deployed stacks"""
86 for stack in _DEPLOYED_STACKS:
91 """Retrieve the current stack status"""
93 return self._stack.status
97 """Retrieve the current stack ID"""
102 class HeatTemplate(object):
103 """Describes a Heat template and a method to deploy template to a stack"""
105 DESCRIPTION_TEMPLATE = """
106 Stack built by the yardstick framework for %s on host %s %s.
107 All referred generated resources are prefixed with the template
111 HEAT_WAIT_LOOP_INTERVAL = 2
112 HEAT_STATUS_COMPLETE = 'COMPLETE'
114 def _init_template(self):
115 timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
117 'heat_template_version': '2013-05-23',
118 'description': self.DESCRIPTION_TEMPLATE % (
120 socket.gethostname(),
128 # short hand for resources part of template
129 self.resources = self._template['resources']
131 def __init__(self, name, template_file=None, heat_parameters=None):
133 self.keystone_client = None
134 self.heat_parameters = {}
136 # heat_parameters is passed to heat in stack create, empty dict when
137 # yardstick creates the template (no get_param in resources part)
139 self.heat_parameters = heat_parameters
142 with open(template_file) as stream:
143 log.info('Parsing external template: %s', template_file)
144 template_str = stream.read()
145 self._template = template_format.parse(template_str)
146 self._parameters = heat_parameters
148 self._init_template()
150 log.debug("template object '%s' created", name)
152 def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
153 is_public=True, rxtx_factor=1.0, swap=0,
155 """add to the template a Flavor description"""
158 log.debug("adding Nova::Flavor '%s' vcpus '%d' ram '%d' disk '%d' "
159 "ephemeral '%d' is_public '%s' rxtx_factor '%d' "
160 "swap '%d' extra_specs '%s'",
161 name, vcpus, ram, disk, ephemeral, is_public,
162 rxtx_factor, swap, str(extra_specs))
165 assert isinstance(extra_specs, collections.Mapping)
167 self.resources[name] = {
168 'type': 'OS::Nova::Flavor',
169 'properties': {'name': name,
174 'rxtx_factor': rxtx_factor,
176 'is_public': is_public,
177 'ephemeral': ephemeral,
178 'extra_specs': extra_specs}
181 self._template['outputs'][name] = {
182 'description': 'Flavor %s ID' % name,
183 'value': {'get_resource': name}
186 def add_volume(self, name, size=10):
187 """add to the template a volume description"""
188 log.debug("adding Cinder::Volume '%s' size '%d' ", name, size)
190 self.resources[name] = {
191 'type': 'OS::Cinder::Volume',
192 'properties': {'name': name,
196 self._template['outputs'][name] = {
197 'description': 'Volume %s ID' % name,
198 'value': {'get_resource': name}
201 def add_volume_attachment(self, server_name, volume_name, mountpoint=None):
202 """add to the template an association of volume to instance"""
203 log.debug("adding Cinder::VolumeAttachment server '%s' volume '%s' ", server_name,
206 name = "%s-%s" % (server_name, volume_name)
208 volume_id = op_utils.get_volume_id(volume_name)
210 volume_id = {'get_resource': volume_name}
211 self.resources[name] = {
212 'type': 'OS::Cinder::VolumeAttachment',
213 'properties': {'instance_uuid': {'get_resource': server_name},
214 'volume_id': volume_id}
218 self.resources[name]['properties']['mountpoint'] = mountpoint
220 def add_network(self, name, physical_network='physnet1', provider=None,
221 segmentation_id=None, port_security_enabled=None, network_type=None):
222 """add to the template a Neutron Net"""
223 log.debug("adding Neutron::Net '%s'", name)
225 self.resources[name] = {
226 'type': 'OS::Neutron::Net',
232 self.resources[name] = {
233 'type': 'OS::Neutron::ProviderNet',
236 'network_type': 'flat' if network_type is None else network_type,
237 'physical_network': physical_network,
241 self.resources[name]['properties']['segmentation_id'] = segmentation_id
242 if network_type is None:
243 self.resources[name]['properties']['network_type'] = 'vlan'
244 # if port security is not defined then don't add to template:
245 # some deployments don't have port security plugin installed
246 if port_security_enabled is not None:
247 self.resources[name]['properties']['port_security_enabled'] = port_security_enabled
249 def add_server_group(self, name, policies): # pragma: no cover
250 """add to the template a ServerGroup"""
251 log.debug("adding Nova::ServerGroup '%s'", name)
252 policies = policies if isinstance(policies, list) else [policies]
253 self.resources[name] = {
254 'type': 'OS::Nova::ServerGroup',
255 'properties': {'name': name,
256 'policies': policies}
259 def add_subnet(self, name, network, cidr, enable_dhcp='true', gateway_ip=None):
260 """add to the template a Neutron Subnet
262 log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
264 self.resources[name] = {
265 'type': 'OS::Neutron::Subnet',
266 'depends_on': network,
270 'network_id': {'get_resource': network},
271 'enable_dhcp': enable_dhcp,
274 if gateway_ip == 'null':
275 self.resources[name]['properties']['gateway_ip'] = None
276 elif gateway_ip is not None:
277 self.resources[name]['properties']['gateway_ip'] = gateway_ip
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, vnic_type, sec_group_id=None,
320 provider=None, allowed_address_pairs=None):
321 """add to the template a named Neutron Port
323 log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', vnic_type:'%s', "
324 "secgroup:%s", name, network_name, subnet_name, vnic_type, sec_group_id)
325 self.resources[name] = {
326 'type': 'OS::Neutron::Port',
327 'depends_on': [subnet_name],
330 'binding:vnic_type': vnic_type,
331 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
332 'network_id': {'get_resource': network_name},
333 'replacement_policy': 'AUTO',
337 if provider == PROVIDER_SRIOV:
338 self.resources[name]['properties']['binding:vnic_type'] = \
342 self.resources[name]['depends_on'].append(sec_group_id)
343 self.resources[name]['properties']['security_groups'] = \
346 if allowed_address_pairs:
347 self.resources[name]['properties'][
348 'allowed_address_pairs'] = allowed_address_pairs
350 self._template['outputs'][name] = {
351 'description': 'Address for interface %s' % name,
352 'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
354 self._template['outputs'][name + "-subnet_id"] = {
355 'description': 'Address for interface %s' % name,
356 'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
358 self._template['outputs'][name + "-mac_address"] = {
359 'description': 'MAC Address for interface %s' % name,
360 'value': {'get_attr': [name, 'mac_address']}
362 self._template['outputs'][name + "-device_id"] = {
363 'description': 'Device ID for interface %s' % name,
364 'value': {'get_attr': [name, 'device_id']}
366 self._template['outputs'][name + "-network_id"] = {
367 'description': 'Network ID for interface %s' % name,
368 'value': {'get_attr': [name, 'network_id']}
371 def add_floating_ip(self, name, network_name, port_name, router_if_name,
373 """add to the template a Nova FloatingIP resource
374 see: https://bugs.launchpad.net/heat/+bug/1299259
376 log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
377 "rif '%s'", name, network_name, port_name, router_if_name)
379 self.resources[name] = {
380 'type': 'OS::Nova::FloatingIP',
381 'depends_on': [port_name, router_if_name],
388 self.resources[name]["depends_on"].append(secgroup_name)
390 self._template['outputs'][name] = {
391 'description': 'floating ip %s' % name,
392 'value': {'get_attr': [name, 'ip']}
395 def add_floating_ip_association(self, name, floating_ip_name, port_name):
396 """add to the template a Nova FloatingIP Association resource
398 log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
399 "floating_ip '%s'", name, port_name, floating_ip_name)
401 self.resources[name] = {
402 'type': 'OS::Neutron::FloatingIPAssociation',
403 'depends_on': [port_name],
405 'floatingip_id': {'get_resource': floating_ip_name},
406 'port_id': {'get_resource': port_name}
410 def add_keypair(self, name, key_id):
411 """add to the template a Nova KeyPair"""
412 log.debug("adding Nova::KeyPair '%s'", name)
413 self.resources[name] = {
414 'type': 'OS::Nova::KeyPair',
417 # resource_string returns bytes, so we must decode to unicode
418 'public_key': encodeutils.safe_decode(
419 pkg_resources.resource_string(
420 'yardstick.resources',
421 'files/yardstick_key-' +
427 def add_servergroup(self, name, policy):
428 """add to the template a Nova ServerGroup"""
429 log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
430 if policy not in ["anti-affinity", "affinity"]:
431 raise ValueError(policy)
433 self.resources[name] = {
434 'type': 'OS::Nova::ServerGroup',
441 self._template['outputs'][name] = {
442 'description': 'ID Server Group %s' % name,
443 'value': {'get_resource': name}
446 def add_security_group(self, name):
447 """add to the template a Neutron SecurityGroup"""
448 log.debug("adding Neutron::SecurityGroup '%s'", name)
449 self.resources[name] = {
450 'type': 'OS::Neutron::SecurityGroup',
453 'description': "Group allowing IPv4 and IPv6 for icmp and upd/tcp on all ports",
455 {'remote_ip_prefix': '0.0.0.0/0',
457 'port_range_min': '1',
458 'port_range_max': '65535'},
459 {'remote_ip_prefix': '0.0.0.0/0',
461 'port_range_min': '1',
462 'port_range_max': '65535'},
463 {'remote_ip_prefix': '0.0.0.0/0',
465 {'remote_ip_prefix': '::/0',
468 'port_range_min': '1',
469 'port_range_max': '65535'},
470 {'remote_ip_prefix': '::/0',
473 'port_range_min': '1',
474 'port_range_max': '65535'},
475 {'remote_ip_prefix': '::/0',
477 'protocol': 'ipv6-icmp'}
482 self._template['outputs'][name] = {
483 'description': 'ID of Security Group',
484 'value': {'get_resource': name}
487 def add_server(self, name, image, flavor, flavors, ports=None, networks=None,
488 scheduler_hints=None, user=None, key_name=None, user_data=None, metadata=None,
489 additional_properties=None, availability_zone=None):
490 """add to the template a Nova Server """
491 log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
492 "ports %s", name, image, flavor, ports)
494 self.resources[name] = {
495 'type': 'OS::Nova::Server',
499 server_properties = {
503 'networks': [] # list of dictionaries
505 if availability_zone:
506 server_properties["availability_zone"] = availability_zone
508 if flavor in flavors:
509 self.resources[name]['depends_on'].append(flavor)
510 server_properties["flavor"] = {'get_resource': flavor}
512 server_properties["flavor"] = flavor
515 server_properties['admin_user'] = user
518 self.resources[name]['depends_on'].append(key_name)
519 server_properties['key_name'] = {'get_resource': key_name}
522 self.resources[name]['depends_on'].extend(ports)
524 server_properties['networks'].append(
525 {'port': {'get_resource': port}}
529 for i, _ in enumerate(networks):
530 server_properties['networks'].append({'network': networks[i]})
533 server_properties['scheduler_hints'] = scheduler_hints
536 server_properties['user_data'] = user_data
539 assert isinstance(metadata, collections.Mapping)
540 server_properties['metadata'] = metadata
542 if additional_properties:
543 assert isinstance(additional_properties, collections.Mapping)
544 for prop in additional_properties:
545 server_properties[prop] = additional_properties[prop]
547 server_properties['config_drive'] = True
549 self.resources[name]['properties'] = server_properties
551 self._template['outputs'][name] = {
552 'description': 'VM UUID',
553 'value': {'get_resource': name}
556 def create(self, block=True, timeout=3600):
557 """Creates a stack in the target based on the stored template
559 :param block: (bool) Wait for Heat create to finish
560 :param timeout: (int) Timeout in seconds for Heat create,
562 :return A dict with the requested output values from the template
564 log.info("Creating stack '%s' START", self.name)
566 start_time = time.time()
567 stack = HeatStack(self.name)
568 stack.create(self._template, self.heat_parameters, block, timeout)
571 log.info("Creating stack '%s' DONE in %d secs",
572 self.name, time.time() - start_time)
575 if stack.status != self.HEAT_STATUS_COMPLETE:
576 raise exceptions.HeatTemplateError(stack_name=self.name)
578 log.info("Creating stack '%s' DONE in %d secs",
579 self.name, time.time() - start_time)