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.dumps(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"""
77 ret = self._cloud.delete_stack(self.uuid, wait=wait)
78 _DEPLOYED_STACKS.pop(self.uuid)
84 """Delete all deployed stacks"""
85 for stack in _DEPLOYED_STACKS:
90 """Retrieve the current stack status"""
92 return self._stack.status
96 """Retrieve the current stack ID"""
101 class HeatTemplate(object):
102 """Describes a Heat template and a method to deploy template to a stack"""
104 DESCRIPTION_TEMPLATE = """
105 Stack built by the yardstick framework for %s on host %s %s.
106 All referred generated resources are prefixed with the template
110 HEAT_WAIT_LOOP_INTERVAL = 2
111 HEAT_STATUS_COMPLETE = 'COMPLETE'
113 def _init_template(self):
114 timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
116 'heat_template_version': '2013-05-23',
117 'description': self.DESCRIPTION_TEMPLATE % (
119 socket.gethostname(),
127 # short hand for resources part of template
128 self.resources = self._template['resources']
130 def __init__(self, name, template_file=None, heat_parameters=None):
132 self.keystone_client = None
133 self.heat_parameters = {}
135 # heat_parameters is passed to heat in stack create, empty dict when
136 # yardstick creates the template (no get_param in resources part)
138 self.heat_parameters = heat_parameters
141 with open(template_file) as stream:
142 log.info('Parsing external template: %s', template_file)
143 template_str = stream.read()
144 self._template = template_format.parse(template_str)
145 self._parameters = heat_parameters
147 self._init_template()
149 log.debug("template object '%s' created", name)
151 def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
152 is_public=True, rxtx_factor=1.0, swap=0,
154 """add to the template a Flavor description"""
157 log.debug("adding Nova::Flavor '%s' vcpus '%d' ram '%d' disk '%d' "
158 "ephemeral '%d' is_public '%s' rxtx_factor '%d' "
159 "swap '%d' extra_specs '%s'",
160 name, vcpus, ram, disk, ephemeral, is_public,
161 rxtx_factor, swap, str(extra_specs))
164 assert isinstance(extra_specs, collections.Mapping)
166 self.resources[name] = {
167 'type': 'OS::Nova::Flavor',
168 'properties': {'name': name,
173 'rxtx_factor': rxtx_factor,
175 'is_public': is_public,
176 'ephemeral': ephemeral,
177 'extra_specs': extra_specs}
180 self._template['outputs'][name] = {
181 'description': 'Flavor %s ID' % name,
182 'value': {'get_resource': name}
185 def add_volume(self, name, size=10):
186 """add to the template a volume description"""
187 log.debug("adding Cinder::Volume '%s' size '%d' ", name, size)
189 self.resources[name] = {
190 'type': 'OS::Cinder::Volume',
191 'properties': {'name': name,
195 self._template['outputs'][name] = {
196 'description': 'Volume %s ID' % name,
197 'value': {'get_resource': name}
200 def add_volume_attachment(self, server_name, volume_name, mountpoint=None):
201 """add to the template an association of volume to instance"""
202 log.debug("adding Cinder::VolumeAttachment server '%s' volume '%s' ", server_name,
205 name = "%s-%s" % (server_name, volume_name)
207 volume_id = op_utils.get_volume_id(volume_name)
209 volume_id = {'get_resource': volume_name}
210 self.resources[name] = {
211 'type': 'OS::Cinder::VolumeAttachment',
212 'properties': {'instance_uuid': {'get_resource': server_name},
213 'volume_id': volume_id}
217 self.resources[name]['properties']['mountpoint'] = mountpoint
219 def add_network(self, name, physical_network='physnet1', provider=None,
220 segmentation_id=None, port_security_enabled=None, network_type=None):
221 """add to the template a Neutron Net"""
222 log.debug("adding Neutron::Net '%s'", name)
224 self.resources[name] = {
225 'type': 'OS::Neutron::Net',
231 self.resources[name] = {
232 'type': 'OS::Neutron::ProviderNet',
235 'network_type': 'flat' if network_type is None else network_type,
236 'physical_network': physical_network,
240 self.resources[name]['properties']['segmentation_id'] = segmentation_id
241 if network_type is None:
242 self.resources[name]['properties']['network_type'] = 'vlan'
243 # if port security is not defined then don't add to template:
244 # some deployments don't have port security plugin installed
245 if port_security_enabled is not None:
246 self.resources[name]['properties']['port_security_enabled'] = port_security_enabled
248 def add_server_group(self, name, policies): # pragma: no cover
249 """add to the template a ServerGroup"""
250 log.debug("adding Nova::ServerGroup '%s'", name)
251 policies = policies if isinstance(policies, list) else [policies]
252 self.resources[name] = {
253 'type': 'OS::Nova::ServerGroup',
254 'properties': {'name': name,
255 'policies': policies}
258 def add_subnet(self, name, network, cidr, enable_dhcp='true', gateway_ip=None):
259 """add to the template a Neutron Subnet
261 log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
263 self.resources[name] = {
264 'type': 'OS::Neutron::Subnet',
265 'depends_on': network,
269 'network_id': {'get_resource': network},
270 'enable_dhcp': enable_dhcp,
273 if gateway_ip == 'null':
274 self.resources[name]['properties']['gateway_ip'] = None
275 elif gateway_ip is not None:
276 self.resources[name]['properties']['gateway_ip'] = gateway_ip
278 self._template['outputs'][name] = {
279 'description': 'subnet %s ID' % name,
280 'value': {'get_resource': name}
282 self._template['outputs'][name + "-cidr"] = {
283 'description': 'subnet %s cidr' % name,
284 'value': {'get_attr': [name, 'cidr']}
286 self._template['outputs'][name + "-gateway_ip"] = {
287 'description': 'subnet %s gateway_ip' % name,
288 'value': {'get_attr': [name, 'gateway_ip']}
291 def add_router(self, name, ext_gw_net, subnet_name):
292 """add to the template a Neutron Router and interface"""
293 log.debug("adding Neutron::Router:'%s', gw-net:'%s'", name, ext_gw_net)
294 self.resources[name] = {
295 'type': 'OS::Neutron::Router',
296 'depends_on': [subnet_name],
299 'external_gateway_info': {
300 'network': ext_gw_net
305 def add_router_interface(self, name, router_name, subnet_name):
306 """add to the template a Neutron RouterInterface and interface"""
307 log.debug("adding Neutron::RouterInterface '%s' router:'%s', "
308 "subnet:'%s'", name, router_name, subnet_name)
309 self.resources[name] = {
310 'type': 'OS::Neutron::RouterInterface',
311 'depends_on': [router_name, subnet_name],
313 'router_id': {'get_resource': router_name},
314 'subnet_id': {'get_resource': subnet_name}
318 def add_port(self, name, network_name, subnet_name, vnic_type, sec_group_id=None,
319 provider=None, allowed_address_pairs=None):
320 """add to the template a named Neutron Port
322 log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', vnic_type:'%s', "
323 "secgroup:%s", name, network_name, subnet_name, vnic_type, sec_group_id)
324 self.resources[name] = {
325 'type': 'OS::Neutron::Port',
326 'depends_on': [subnet_name],
329 'binding:vnic_type': vnic_type,
330 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
331 'network_id': {'get_resource': network_name},
332 'replacement_policy': 'AUTO',
336 if provider == PROVIDER_SRIOV:
337 self.resources[name]['properties']['binding:vnic_type'] = \
341 self.resources[name]['depends_on'].append(sec_group_id)
342 self.resources[name]['properties']['security_groups'] = \
345 if allowed_address_pairs:
346 self.resources[name]['properties'][
347 'allowed_address_pairs'] = allowed_address_pairs
349 self._template['outputs'][name] = {
350 'description': 'Address for interface %s' % name,
351 'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
353 self._template['outputs'][name + "-subnet_id"] = {
354 'description': 'Address for interface %s' % name,
355 'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
357 self._template['outputs'][name + "-mac_address"] = {
358 'description': 'MAC Address for interface %s' % name,
359 'value': {'get_attr': [name, 'mac_address']}
361 self._template['outputs'][name + "-device_id"] = {
362 'description': 'Device ID for interface %s' % name,
363 'value': {'get_attr': [name, 'device_id']}
365 self._template['outputs'][name + "-network_id"] = {
366 'description': 'Network ID for interface %s' % name,
367 'value': {'get_attr': [name, 'network_id']}
370 def add_floating_ip(self, name, network_name, port_name, router_if_name,
372 """add to the template a Nova FloatingIP resource
373 see: https://bugs.launchpad.net/heat/+bug/1299259
375 log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
376 "rif '%s'", name, network_name, port_name, router_if_name)
378 self.resources[name] = {
379 'type': 'OS::Nova::FloatingIP',
380 'depends_on': [port_name, router_if_name],
387 self.resources[name]["depends_on"].append(secgroup_name)
389 self._template['outputs'][name] = {
390 'description': 'floating ip %s' % name,
391 'value': {'get_attr': [name, 'ip']}
394 def add_floating_ip_association(self, name, floating_ip_name, port_name):
395 """add to the template a Nova FloatingIP Association resource
397 log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
398 "floating_ip '%s'", name, port_name, floating_ip_name)
400 self.resources[name] = {
401 'type': 'OS::Neutron::FloatingIPAssociation',
402 'depends_on': [port_name],
404 'floatingip_id': {'get_resource': floating_ip_name},
405 'port_id': {'get_resource': port_name}
409 def add_keypair(self, name, key_uuid):
410 """add to the template a Nova KeyPair"""
411 log.debug("adding Nova::KeyPair '%s'", name)
412 self.resources[name] = {
413 'type': 'OS::Nova::KeyPair',
416 # resource_string returns bytes, so we must decode to unicode
417 'public_key': encodeutils.safe_decode(
418 pkg_resources.resource_string(
419 'yardstick.resources',
420 'files/yardstick_key-' +
421 get_short_key_uuid(key_uuid) + '.pub'),
426 def add_servergroup(self, name, policy):
427 """add to the template a Nova ServerGroup"""
428 log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
429 if policy not in ["anti-affinity", "affinity"]:
430 raise ValueError(policy)
432 self.resources[name] = {
433 'type': 'OS::Nova::ServerGroup',
440 self._template['outputs'][name] = {
441 'description': 'ID Server Group %s' % name,
442 'value': {'get_resource': name}
445 def add_security_group(self, name):
446 """add to the template a Neutron SecurityGroup"""
447 log.debug("adding Neutron::SecurityGroup '%s'", name)
448 self.resources[name] = {
449 'type': 'OS::Neutron::SecurityGroup',
452 'description': "Group allowing IPv4 and IPv6 for icmp and upd/tcp on all ports",
454 {'remote_ip_prefix': '0.0.0.0/0',
456 'port_range_min': '1',
457 'port_range_max': '65535'},
458 {'remote_ip_prefix': '0.0.0.0/0',
460 'port_range_min': '1',
461 'port_range_max': '65535'},
462 {'remote_ip_prefix': '0.0.0.0/0',
464 {'remote_ip_prefix': '::/0',
467 'port_range_min': '1',
468 'port_range_max': '65535'},
469 {'remote_ip_prefix': '::/0',
472 'port_range_min': '1',
473 'port_range_max': '65535'},
474 {'remote_ip_prefix': '::/0',
476 'protocol': 'ipv6-icmp'}
481 self._template['outputs'][name] = {
482 'description': 'ID of Security Group',
483 'value': {'get_resource': name}
486 def add_server(self, name, image, flavor, flavors, ports=None, networks=None,
487 scheduler_hints=None, user=None, key_name=None, user_data=None, metadata=None,
488 additional_properties=None, availability_zone=None):
489 """add to the template a Nova Server """
490 log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
491 "ports %s", name, image, flavor, ports)
493 self.resources[name] = {
494 'type': 'OS::Nova::Server',
498 server_properties = {
502 'networks': [] # list of dictionaries
504 if availability_zone:
505 server_properties["availability_zone"] = availability_zone
507 if flavor in flavors:
508 self.resources[name]['depends_on'].append(flavor)
509 server_properties["flavor"] = {'get_resource': flavor}
511 server_properties["flavor"] = flavor
514 server_properties['admin_user'] = user
517 self.resources[name]['depends_on'].append(key_name)
518 server_properties['key_name'] = {'get_resource': key_name}
521 self.resources[name]['depends_on'].extend(ports)
523 server_properties['networks'].append(
524 {'port': {'get_resource': port}}
528 for i, _ in enumerate(networks):
529 server_properties['networks'].append({'network': networks[i]})
532 server_properties['scheduler_hints'] = scheduler_hints
535 server_properties['user_data'] = user_data
538 assert isinstance(metadata, collections.Mapping)
539 server_properties['metadata'] = metadata
541 if additional_properties:
542 assert isinstance(additional_properties, collections.Mapping)
543 for prop in additional_properties:
544 server_properties[prop] = additional_properties[prop]
546 server_properties['config_drive'] = True
548 self.resources[name]['properties'] = server_properties
550 self._template['outputs'][name] = {
551 'description': 'VM UUID',
552 'value': {'get_resource': name}
555 def create(self, block=True, timeout=3600):
556 """Creates a stack in the target based on the stored template
558 :param block: (bool) Wait for Heat create to finish
559 :param timeout: (int) Timeout in seconds for Heat create,
561 :return A dict with the requested output values from the template
563 log.info("Creating stack '%s' START", self.name)
565 start_time = time.time()
566 stack = HeatStack(self.name)
567 stack.create(self._template, self.heat_parameters, block, timeout)
570 log.info("Creating stack '%s' DONE in %d secs",
571 self.name, time.time() - start_time)
574 if stack.status != self.HEAT_STATUS_COMPLETE:
575 raise exceptions.HeatTemplateError(stack_name=self.name)
577 log.info("Creating stack '%s' DONE in %d secs",
578 self.name, time.time() - start_time)