yardstick/orchestrator/heat.py

   1 #############################################################################
   2 # Copyright (c) 2015-2017 Ericsson AB and others.
   3 #
   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 ##############################################################################
   9
  10 """Heat template and stack management"""
  11
  12 from __future__ import absolute_import
  13 import collections
  14 import datetime
  15 import getpass
  16 import logging
  17 import pkg_resources
  18 import socket
  19 import tempfile
  20 import time
  21
  22 from oslo_serialization import jsonutils
  23 from oslo_utils import encodeutils
  24 import shade
  25
  26 import yardstick.common.openstack_utils as op_utils
  27 from yardstick.common import exceptions
  28 from yardstick.common import template_format
  29
  30 log = logging.getLogger(__name__)
  31
  32
  33 HEAT_KEY_UUID_LENGTH = 8
  34
  35 PROVIDER_SRIOV = "sriov"
  36
  37 _DEPLOYED_STACKS = {}
  38
  39
  40 def get_short_key_uuid(uuid):
  41     return str(uuid)[:HEAT_KEY_UUID_LENGTH]
  42
  43
  44 class HeatStack(object):
  45     """Represents a Heat stack (deployed template) """
  46
  47     def __init__(self, name):
  48         self.name = name
  49         self.outputs = {}
  50         self._cloud = shade.openstack_cloud()
  51         self._stack = None
  52
  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))
  57             template_file.close()
  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
  63                         in outputs}
  64         if self.uuid:
  65             _DEPLOYED_STACKS[self.uuid] = self._stack
  66
  67     @staticmethod
  68     def stacks_exist():
  69         """Check if any stack has been deployed"""
  70         return len(_DEPLOYED_STACKS) > 0
  71
  72     def delete(self, wait=True):
  73         """Deletes a stack in the target cloud"""
  74         if self.uuid is None:
  75             return
  76
  77         try:
  78             ret = self._cloud.delete_stack(self.uuid, wait=wait)
  79         except TypeError:
  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
  82             # deleted.
  83             ret = True
  84
  85         _DEPLOYED_STACKS.pop(self.uuid)
  86         self._stack = None
  87         return ret
  88
  89     @staticmethod
  90     def delete_all():
  91         """Delete all deployed stacks"""
  92         for stack in _DEPLOYED_STACKS:
  93             stack.delete()
  94
  95     @property
  96     def status(self):
  97         """Retrieve the current stack status"""
  98         if self._stack:
  99             return self._stack.status
 100
 101     @property
 102     def uuid(self):
 103         """Retrieve the current stack ID"""
 104         if self._stack:
 105             return self._stack.id
 106
 107
 108 class HeatTemplate(object):
 109     """Describes a Heat template and a method to deploy template to a stack"""
 110
 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
 114 name (i.e. %s).
 115 """
 116
 117     HEAT_WAIT_LOOP_INTERVAL = 2
 118     HEAT_STATUS_COMPLETE = 'COMPLETE'
 119
 120     def _init_template(self):
 121         timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 122         self._template = {
 123             'heat_template_version': '2013-05-23',
 124             'description': self.DESCRIPTION_TEMPLATE % (
 125                 getpass.getuser(),
 126                 socket.gethostname(),
 127                 timestamp,
 128                 self.name
 129             ),
 130             'resources': {},
 131             'outputs': {}
 132         }
 133
 134         # short hand for resources part of template
 135         self.resources = self._template['resources']
 136
 137     def __init__(self, name, template_file=None, heat_parameters=None):
 138         self.name = name
 139         self.keystone_client = None
 140         self.heat_parameters = {}
 141
 142         # heat_parameters is passed to heat in stack create, empty dict when
 143         # yardstick creates the template (no get_param in resources part)
 144         if heat_parameters:
 145             self.heat_parameters = heat_parameters
 146
 147         if template_file:
 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
 153         else:
 154             self._init_template()
 155
 156         log.debug("template object '%s' created", name)
 157
 158     def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
 159                    is_public=True, rxtx_factor=1.0, swap=0,
 160                    extra_specs=None):
 161         """add to the template a Flavor description"""
 162         if name is None:
 163             name = 'auto'
 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))
 169
 170         if extra_specs:
 171             assert isinstance(extra_specs, collections.Mapping)
 172
 173         self.resources[name] = {
 174             'type': 'OS::Nova::Flavor',
 175             'properties': {'name': name,
 176                            'disk': disk,
 177                            'vcpus': vcpus,
 178                            'swap': swap,
 179                            'flavorid': name,
 180                            'rxtx_factor': rxtx_factor,
 181                            'ram': ram,
 182                            'is_public': is_public,
 183                            'ephemeral': ephemeral,
 184                            'extra_specs': extra_specs}
 185         }
 186
 187         self._template['outputs'][name] = {
 188             'description': 'Flavor %s ID' % name,
 189             'value': {'get_resource': name}
 190         }
 191
 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)
 195
 196         self.resources[name] = {
 197             'type': 'OS::Cinder::Volume',
 198             'properties': {'name': name,
 199                            'size': size}
 200         }
 201
 202         self._template['outputs'][name] = {
 203             'description': 'Volume %s ID' % name,
 204             'value': {'get_resource': name}
 205         }
 206
 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,
 210                   volume_name)
 211
 212         name = "%s-%s" % (server_name, volume_name)
 213
 214         volume_id = op_utils.get_volume_id(volume_name)
 215         if not volume_id:
 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}
 221         }
 222
 223         if mountpoint:
 224             self.resources[name]['properties']['mountpoint'] = mountpoint
 225
 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)
 230         if provider is None:
 231             self.resources[name] = {
 232                 'type': 'OS::Neutron::Net',
 233                 'properties': {
 234                     'name': name,
 235                 }
 236             }
 237         else:
 238             self.resources[name] = {
 239                 'type': 'OS::Neutron::ProviderNet',
 240                 'properties': {
 241                     'name': name,
 242                     'network_type': 'flat' if network_type is None else network_type,
 243                     'physical_network': physical_network,
 244                 },
 245             }
 246             if segmentation_id:
 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
 254
 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}
 263         }
 264
 265     def add_subnet(self, name, network, cidr, enable_dhcp='true', gateway_ip=None):
 266         """add to the template a Neutron Subnet
 267         """
 268         log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
 269                   name, network, cidr)
 270         self.resources[name] = {
 271             'type': 'OS::Neutron::Subnet',
 272             'depends_on': network,
 273             'properties': {
 274                 'name': name,
 275                 'cidr': cidr,
 276                 'network_id': {'get_resource': network},
 277                 'enable_dhcp': enable_dhcp,
 278             }
 279         }
 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
 284
 285         self._template['outputs'][name] = {
 286             'description': 'subnet %s ID' % name,
 287             'value': {'get_resource': name}
 288         }
 289         self._template['outputs'][name + "-cidr"] = {
 290             'description': 'subnet %s cidr' % name,
 291             'value': {'get_attr': [name, 'cidr']}
 292         }
 293         self._template['outputs'][name + "-gateway_ip"] = {
 294             'description': 'subnet %s gateway_ip' % name,
 295             'value': {'get_attr': [name, 'gateway_ip']}
 296         }
 297
 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],
 304             'properties': {
 305                 'name': name,
 306                 'external_gateway_info': {
 307                     'network': ext_gw_net
 308                 }
 309             }
 310         }
 311
 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],
 319             'properties': {
 320                 'router_id': {'get_resource': router_name},
 321                 'subnet_id': {'get_resource': subnet_name}
 322             }
 323         }
 324
 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
 328         """
 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],
 334             'properties': {
 335                 'name': 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',
 340             }
 341         }
 342
 343         if provider == PROVIDER_SRIOV:
 344             self.resources[name]['properties']['binding:vnic_type'] = \
 345                 'direct'
 346
 347         if sec_group_id:
 348             self.resources[name]['depends_on'].append(sec_group_id)
 349             self.resources[name]['properties']['security_groups'] = \
 350                 [sec_group_id]
 351
 352         if allowed_address_pairs:
 353             self.resources[name]['properties'][
 354                 'allowed_address_pairs'] = allowed_address_pairs
 355
 356         self._template['outputs'][name] = {
 357             'description': 'Address for interface %s' % name,
 358             'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
 359         }
 360         self._template['outputs'][name + "-subnet_id"] = {
 361             'description': 'Address for interface %s' % name,
 362             'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
 363         }
 364         self._template['outputs'][name + "-mac_address"] = {
 365             'description': 'MAC Address for interface %s' % name,
 366             'value': {'get_attr': [name, 'mac_address']}
 367         }
 368         self._template['outputs'][name + "-device_id"] = {
 369             'description': 'Device ID for interface %s' % name,
 370             'value': {'get_attr': [name, 'device_id']}
 371         }
 372         self._template['outputs'][name + "-network_id"] = {
 373             'description': 'Network ID for interface %s' % name,
 374             'value': {'get_attr': [name, 'network_id']}
 375         }
 376
 377     def add_floating_ip(self, name, network_name, port_name, router_if_name,
 378                         secgroup_name=None):
 379         """add to the template a Nova FloatingIP resource
 380         see: https://bugs.launchpad.net/heat/+bug/1299259
 381         """
 382         log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
 383                   "rif '%s'", name, network_name, port_name, router_if_name)
 384
 385         self.resources[name] = {
 386             'type': 'OS::Nova::FloatingIP',
 387             'depends_on': [port_name, router_if_name],
 388             'properties': {
 389                 'pool': network_name
 390             }
 391         }
 392
 393         if secgroup_name:
 394             self.resources[name]["depends_on"].append(secgroup_name)
 395
 396         self._template['outputs'][name] = {
 397             'description': 'floating ip %s' % name,
 398             'value': {'get_attr': [name, 'ip']}
 399         }
 400
 401     def add_floating_ip_association(self, name, floating_ip_name, port_name):
 402         """add to the template a Nova FloatingIP Association resource
 403         """
 404         log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
 405                   "floating_ip '%s'", name, port_name, floating_ip_name)
 406
 407         self.resources[name] = {
 408             'type': 'OS::Neutron::FloatingIPAssociation',
 409             'depends_on': [port_name],
 410             'properties': {
 411                 'floatingip_id': {'get_resource': floating_ip_name},
 412                 'port_id': {'get_resource': port_name}
 413             }
 414         }
 415
 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',
 421             'properties': {
 422                 'name': name,
 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'),
 429                     'utf-8')
 430             }
 431         }
 432
 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)
 438
 439         self.resources[name] = {
 440             'type': 'OS::Nova::ServerGroup',
 441             'properties': {
 442                 'name': name,
 443                 'policies': [policy]
 444             }
 445         }
 446
 447         self._template['outputs'][name] = {
 448             'description': 'ID Server Group %s' % name,
 449             'value': {'get_resource': name}
 450         }
 451
 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',
 457             'properties': {
 458                 'name': name,
 459                 'description': "Group allowing IPv4 and IPv6 for icmp and upd/tcp on all ports",
 460                 'rules': [
 461                     {'remote_ip_prefix': '0.0.0.0/0',
 462                      'protocol': 'tcp',
 463                      'port_range_min': '1',
 464                      'port_range_max': '65535'},
 465                     {'remote_ip_prefix': '0.0.0.0/0',
 466                      'protocol': 'udp',
 467                      'port_range_min': '1',
 468                      'port_range_max': '65535'},
 469                     {'remote_ip_prefix': '0.0.0.0/0',
 470                      'protocol': 'icmp'},
 471                     {'remote_ip_prefix': '::/0',
 472                      'ethertype': 'IPv6',
 473                      'protocol': 'tcp',
 474                      'port_range_min': '1',
 475                      'port_range_max': '65535'},
 476                     {'remote_ip_prefix': '::/0',
 477                      'ethertype': 'IPv6',
 478                      'protocol': 'udp',
 479                      'port_range_min': '1',
 480                      'port_range_max': '65535'},
 481                     {'remote_ip_prefix': '::/0',
 482                      'ethertype': 'IPv6',
 483                      'protocol': 'ipv6-icmp'}
 484                 ]
 485             }
 486         }
 487
 488         self._template['outputs'][name] = {
 489             'description': 'ID of Security Group',
 490             'value': {'get_resource': name}
 491         }
 492
 493     def add_server(self, name, image, flavor, flavors, ports=None, networks=None,
 494                    scheduler_hints=None, user=None, key_name=None, user_data=None, metadata=None,
 495                    additional_properties=None, availability_zone=None):
 496         """add to the template a Nova Server """
 497         log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
 498                   "ports %s", name, image, flavor, ports)
 499
 500         self.resources[name] = {
 501             'type': 'OS::Nova::Server',
 502             'depends_on': []
 503         }
 504
 505         server_properties = {
 506             'name': name,
 507             'image': image,
 508             'flavor': {},
 509             'networks': []  # list of dictionaries
 510         }
 511         if availability_zone:
 512             server_properties["availability_zone"] = availability_zone
 513
 514         if flavor in flavors:
 515             self.resources[name]['depends_on'].append(flavor)
 516             server_properties["flavor"] = {'get_resource': flavor}
 517         else:
 518             server_properties["flavor"] = flavor
 519
 520         if user:
 521             server_properties['admin_user'] = user
 522
 523         if key_name:
 524             self.resources[name]['depends_on'].append(key_name)
 525             server_properties['key_name'] = {'get_resource': key_name}
 526
 527         if ports:
 528             self.resources[name]['depends_on'].extend(ports)
 529             for port in ports:
 530                 server_properties['networks'].append(
 531                     {'port': {'get_resource': port}}
 532                 )
 533
 534         if networks:
 535             for i, _ in enumerate(networks):
 536                 server_properties['networks'].append({'network': networks[i]})
 537
 538         if scheduler_hints:
 539             server_properties['scheduler_hints'] = scheduler_hints
 540
 541         if user_data:
 542             server_properties['user_data'] = user_data
 543
 544         if metadata:
 545             assert isinstance(metadata, collections.Mapping)
 546             server_properties['metadata'] = metadata
 547
 548         if additional_properties:
 549             assert isinstance(additional_properties, collections.Mapping)
 550             for prop in additional_properties:
 551                 server_properties[prop] = additional_properties[prop]
 552
 553         server_properties['config_drive'] = True
 554
 555         self.resources[name]['properties'] = server_properties
 556
 557         self._template['outputs'][name] = {
 558             'description': 'VM UUID',
 559             'value': {'get_resource': name}
 560         }
 561
 562     def create(self, block=True, timeout=3600):
 563         """Creates a stack in the target based on the stored template
 564
 565         :param block: (bool) Wait for Heat create to finish
 566         :param timeout: (int) Timeout in seconds for Heat create,
 567                default 3600s
 568         :return A dict with the requested output values from the template
 569         """
 570         log.info("Creating stack '%s' START", self.name)
 571
 572         start_time = time.time()
 573         stack = HeatStack(self.name)
 574         stack.create(self._template, self.heat_parameters, block, timeout)
 575
 576         if not block:
 577             log.info("Creating stack '%s' DONE in %d secs",
 578                      self.name, time.time() - start_time)
 579             return stack
 580
 581         if stack.status != self.HEAT_STATUS_COMPLETE:
 582             raise exceptions.HeatTemplateError(stack_name=self.name)
 583
 584         log.info("Creating stack '%s' DONE in %d secs",
 585                  self.name, time.time() - start_time)
 586         return stack