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 PROVIDER_SRIOV = "sriov"
  34
  35 _DEPLOYED_STACKS = {}
  36
  37
  38 class HeatStack(object):
  39     """Represents a Heat stack (deployed template) """
  40
  41     def __init__(self, name):
  42         self.name = name
  43         self.outputs = {}
  44         self._cloud = shade.openstack_cloud()
  45         self._stack = None
  46
  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))
  51             template_file.close()
  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
  57                         in outputs}
  58         if self.uuid:
  59             _DEPLOYED_STACKS[self.uuid] = self._stack
  60
  61     @staticmethod
  62     def stacks_exist():
  63         """Check if any stack has been deployed"""
  64         return len(_DEPLOYED_STACKS) > 0
  65
  66     def delete(self, wait=True):
  67         """Deletes a stack in the target cloud"""
  68         if self.uuid is None:
  69             return
  70
  71         try:
  72             ret = self._cloud.delete_stack(self.uuid, wait=wait)
  73         except TypeError:
  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
  76             # deleted.
  77             ret = True
  78
  79         _DEPLOYED_STACKS.pop(self.uuid)
  80         self._stack = None
  81         return ret
  82
  83     @staticmethod
  84     def delete_all():
  85         """Delete all deployed stacks"""
  86         for stack in _DEPLOYED_STACKS:
  87             stack.delete()
  88
  89     @property
  90     def status(self):
  91         """Retrieve the current stack status"""
  92         if self._stack:
  93             return self._stack.status
  94
  95     @property
  96     def uuid(self):
  97         """Retrieve the current stack ID"""
  98         if self._stack:
  99             return self._stack.id
 100
 101
 102 class HeatTemplate(object):
 103     """Describes a Heat template and a method to deploy template to a stack"""
 104
 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
 108 name (i.e. %s).
 109 """
 110
 111     HEAT_WAIT_LOOP_INTERVAL = 2
 112     HEAT_STATUS_COMPLETE = 'COMPLETE'
 113
 114     def _init_template(self):
 115         timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 116         self._template = {
 117             'heat_template_version': '2013-05-23',
 118             'description': self.DESCRIPTION_TEMPLATE % (
 119                 getpass.getuser(),
 120                 socket.gethostname(),
 121                 timestamp,
 122                 self.name
 123             ),
 124             'resources': {},
 125             'outputs': {}
 126         }
 127
 128         # short hand for resources part of template
 129         self.resources = self._template['resources']
 130
 131     def __init__(self, name, template_file=None, heat_parameters=None):
 132         self.name = name
 133         self.keystone_client = None
 134         self.heat_parameters = {}
 135
 136         # heat_parameters is passed to heat in stack create, empty dict when
 137         # yardstick creates the template (no get_param in resources part)
 138         if heat_parameters:
 139             self.heat_parameters = heat_parameters
 140
 141         if template_file:
 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
 147         else:
 148             self._init_template()
 149
 150         log.debug("template object '%s' created", name)
 151
 152     def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
 153                    is_public=True, rxtx_factor=1.0, swap=0,
 154                    extra_specs=None):
 155         """add to the template a Flavor description"""
 156         if name is None:
 157             name = 'auto'
 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))
 163
 164         if extra_specs:
 165             assert isinstance(extra_specs, collections.Mapping)
 166
 167         self.resources[name] = {
 168             'type': 'OS::Nova::Flavor',
 169             'properties': {'name': name,
 170                            'disk': disk,
 171                            'vcpus': vcpus,
 172                            'swap': swap,
 173                            'flavorid': name,
 174                            'rxtx_factor': rxtx_factor,
 175                            'ram': ram,
 176                            'is_public': is_public,
 177                            'ephemeral': ephemeral,
 178                            'extra_specs': extra_specs}
 179         }
 180
 181         self._template['outputs'][name] = {
 182             'description': 'Flavor %s ID' % name,
 183             'value': {'get_resource': name}
 184         }
 185
 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)
 189
 190         self.resources[name] = {
 191             'type': 'OS::Cinder::Volume',
 192             'properties': {'name': name,
 193                            'size': size}
 194         }
 195
 196         self._template['outputs'][name] = {
 197             'description': 'Volume %s ID' % name,
 198             'value': {'get_resource': name}
 199         }
 200
 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,
 204                   volume_name)
 205
 206         name = "%s-%s" % (server_name, volume_name)
 207
 208         volume_id = op_utils.get_volume_id(volume_name)
 209         if not volume_id:
 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}
 215         }
 216
 217         if mountpoint:
 218             self.resources[name]['properties']['mountpoint'] = mountpoint
 219
 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)
 224         if provider is None:
 225             self.resources[name] = {
 226                 'type': 'OS::Neutron::Net',
 227                 'properties': {
 228                     'name': name,
 229                 }
 230             }
 231         else:
 232             self.resources[name] = {
 233                 'type': 'OS::Neutron::ProviderNet',
 234                 'properties': {
 235                     'name': name,
 236                     'network_type': 'flat' if network_type is None else network_type,
 237                     'physical_network': physical_network,
 238                 },
 239             }
 240             if segmentation_id:
 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
 248
 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}
 257         }
 258
 259     def add_subnet(self, name, network, cidr, enable_dhcp='true', gateway_ip=None):
 260         """add to the template a Neutron Subnet
 261         """
 262         log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
 263                   name, network, cidr)
 264         self.resources[name] = {
 265             'type': 'OS::Neutron::Subnet',
 266             'depends_on': network,
 267             'properties': {
 268                 'name': name,
 269                 'cidr': cidr,
 270                 'network_id': {'get_resource': network},
 271                 'enable_dhcp': enable_dhcp,
 272             }
 273         }
 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
 278
 279         self._template['outputs'][name] = {
 280             'description': 'subnet %s ID' % name,
 281             'value': {'get_resource': name}
 282         }
 283         self._template['outputs'][name + "-cidr"] = {
 284             'description': 'subnet %s cidr' % name,
 285             'value': {'get_attr': [name, 'cidr']}
 286         }
 287         self._template['outputs'][name + "-gateway_ip"] = {
 288             'description': 'subnet %s gateway_ip' % name,
 289             'value': {'get_attr': [name, 'gateway_ip']}
 290         }
 291
 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],
 298             'properties': {
 299                 'name': name,
 300                 'external_gateway_info': {
 301                     'network': ext_gw_net
 302                 }
 303             }
 304         }
 305
 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],
 313             'properties': {
 314                 'router_id': {'get_resource': router_name},
 315                 'subnet_id': {'get_resource': subnet_name}
 316             }
 317         }
 318
 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
 322         """
 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],
 328             'properties': {
 329                 'name': 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',
 334             }
 335         }
 336
 337         if provider == PROVIDER_SRIOV:
 338             self.resources[name]['properties']['binding:vnic_type'] = \
 339                 'direct'
 340
 341         if sec_group_id:
 342             self.resources[name]['depends_on'].append(sec_group_id)
 343             self.resources[name]['properties']['security_groups'] = \
 344                 [sec_group_id]
 345
 346         if allowed_address_pairs:
 347             self.resources[name]['properties'][
 348                 'allowed_address_pairs'] = allowed_address_pairs
 349
 350         self._template['outputs'][name] = {
 351             'description': 'Address for interface %s' % name,
 352             'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
 353         }
 354         self._template['outputs'][name + "-subnet_id"] = {
 355             'description': 'Address for interface %s' % name,
 356             'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
 357         }
 358         self._template['outputs'][name + "-mac_address"] = {
 359             'description': 'MAC Address for interface %s' % name,
 360             'value': {'get_attr': [name, 'mac_address']}
 361         }
 362         self._template['outputs'][name + "-device_id"] = {
 363             'description': 'Device ID for interface %s' % name,
 364             'value': {'get_attr': [name, 'device_id']}
 365         }
 366         self._template['outputs'][name + "-network_id"] = {
 367             'description': 'Network ID for interface %s' % name,
 368             'value': {'get_attr': [name, 'network_id']}
 369         }
 370
 371     def add_floating_ip(self, name, network_name, port_name, router_if_name,
 372                         secgroup_name=None):
 373         """add to the template a Nova FloatingIP resource
 374         see: https://bugs.launchpad.net/heat/+bug/1299259
 375         """
 376         log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
 377                   "rif '%s'", name, network_name, port_name, router_if_name)
 378
 379         self.resources[name] = {
 380             'type': 'OS::Nova::FloatingIP',
 381             'depends_on': [port_name, router_if_name],
 382             'properties': {
 383                 'pool': network_name
 384             }
 385         }
 386
 387         if secgroup_name:
 388             self.resources[name]["depends_on"].append(secgroup_name)
 389
 390         self._template['outputs'][name] = {
 391             'description': 'floating ip %s' % name,
 392             'value': {'get_attr': [name, 'ip']}
 393         }
 394
 395     def add_floating_ip_association(self, name, floating_ip_name, port_name):
 396         """add to the template a Nova FloatingIP Association resource
 397         """
 398         log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
 399                   "floating_ip '%s'", name, port_name, floating_ip_name)
 400
 401         self.resources[name] = {
 402             'type': 'OS::Neutron::FloatingIPAssociation',
 403             'depends_on': [port_name],
 404             'properties': {
 405                 'floatingip_id': {'get_resource': floating_ip_name},
 406                 'port_id': {'get_resource': port_name}
 407             }
 408         }
 409
 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',
 415             'properties': {
 416                 'name': name,
 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-' +
 422                         key_id + '.pub'),
 423                     'utf-8')
 424             }
 425         }
 426
 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)
 432
 433         self.resources[name] = {
 434             'type': 'OS::Nova::ServerGroup',
 435             'properties': {
 436                 'name': name,
 437                 'policies': [policy]
 438             }
 439         }
 440
 441         self._template['outputs'][name] = {
 442             'description': 'ID Server Group %s' % name,
 443             'value': {'get_resource': name}
 444         }
 445
 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',
 451             'properties': {
 452                 'name': name,
 453                 'description': "Group allowing IPv4 and IPv6 for icmp and upd/tcp on all ports",
 454                 'rules': [
 455                     {'remote_ip_prefix': '0.0.0.0/0',
 456                      'protocol': 'tcp',
 457                      'port_range_min': '1',
 458                      'port_range_max': '65535'},
 459                     {'remote_ip_prefix': '0.0.0.0/0',
 460                      'protocol': 'udp',
 461                      'port_range_min': '1',
 462                      'port_range_max': '65535'},
 463                     {'remote_ip_prefix': '0.0.0.0/0',
 464                      'protocol': 'icmp'},
 465                     {'remote_ip_prefix': '::/0',
 466                      'ethertype': 'IPv6',
 467                      'protocol': 'tcp',
 468                      'port_range_min': '1',
 469                      'port_range_max': '65535'},
 470                     {'remote_ip_prefix': '::/0',
 471                      'ethertype': 'IPv6',
 472                      'protocol': 'udp',
 473                      'port_range_min': '1',
 474                      'port_range_max': '65535'},
 475                     {'remote_ip_prefix': '::/0',
 476                      'ethertype': 'IPv6',
 477                      'protocol': 'ipv6-icmp'},
 478                     {'remote_ip_prefix': '0.0.0.0/0',
 479                      'direction': 'egress',
 480                      'protocol': 'tcp',
 481                      'port_range_min': '1',
 482                      'port_range_max': '65535'},
 483                     {'remote_ip_prefix': '0.0.0.0/0',
 484                      'direction': 'egress',
 485                      'protocol': 'udp',
 486                      'port_range_min': '1',
 487                      'port_range_max': '65535'},
 488                     {'remote_ip_prefix': '0.0.0.0/0',
 489                      'direction': 'egress',
 490                      'protocol': 'icmp'},
 491                     {'remote_ip_prefix': '::/0',
 492                      'direction': 'egress',
 493                      'ethertype': 'IPv6',
 494                      'protocol': 'tcp',
 495                      'port_range_min': '1',
 496                      'port_range_max': '65535'},
 497                     {'remote_ip_prefix': '::/0',
 498                      'direction': 'egress',
 499                      'ethertype': 'IPv6',
 500                      'protocol': 'udp',
 501                      'port_range_min': '1',
 502                      'port_range_max': '65535'},
 503                     {'remote_ip_prefix': '::/0',
 504                      'direction': 'egress',
 505                      'ethertype': 'IPv6',
 506                      'protocol': 'ipv6-icmp'},
 507                 ]
 508             }
 509         }
 510
 511         self._template['outputs'][name] = {
 512             'description': 'ID of Security Group',
 513             'value': {'get_resource': name}
 514         }
 515
 516     def add_server(self, name, image, flavor, flavors, ports=None, networks=None,
 517                    scheduler_hints=None, user=None, key_name=None, user_data=None, metadata=None,
 518                    additional_properties=None, availability_zone=None):
 519         """add to the template a Nova Server """
 520         log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
 521                   "ports %s", name, image, flavor, ports)
 522
 523         self.resources[name] = {
 524             'type': 'OS::Nova::Server',
 525             'depends_on': []
 526         }
 527
 528         server_properties = {
 529             'name': name,
 530             'image': image,
 531             'flavor': {},
 532             'networks': []  # list of dictionaries
 533         }
 534         if availability_zone:
 535             server_properties["availability_zone"] = availability_zone
 536
 537         if flavor in flavors:
 538             self.resources[name]['depends_on'].append(flavor)
 539             server_properties["flavor"] = {'get_resource': flavor}
 540         else:
 541             server_properties["flavor"] = flavor
 542
 543         if user:
 544             server_properties['admin_user'] = user
 545
 546         if key_name:
 547             self.resources[name]['depends_on'].append(key_name)
 548             server_properties['key_name'] = {'get_resource': key_name}
 549
 550         if ports:
 551             self.resources[name]['depends_on'].extend(ports)
 552             for port in ports:
 553                 server_properties['networks'].append(
 554                     {'port': {'get_resource': port}}
 555                 )
 556
 557         if networks:
 558             for i, _ in enumerate(networks):
 559                 server_properties['networks'].append({'network': networks[i]})
 560
 561         if scheduler_hints:
 562             server_properties['scheduler_hints'] = scheduler_hints
 563
 564         if user_data:
 565             server_properties['user_data'] = user_data
 566
 567         if metadata:
 568             assert isinstance(metadata, collections.Mapping)
 569             server_properties['metadata'] = metadata
 570
 571         if additional_properties:
 572             assert isinstance(additional_properties, collections.Mapping)
 573             for prop in additional_properties:
 574                 server_properties[prop] = additional_properties[prop]
 575
 576         server_properties['config_drive'] = True
 577
 578         self.resources[name]['properties'] = server_properties
 579
 580         self._template['outputs'][name] = {
 581             'description': 'VM UUID',
 582             'value': {'get_resource': name}
 583         }
 584
 585     def create(self, block=True, timeout=3600):
 586         """Creates a stack in the target based on the stored template
 587
 588         :param block: (bool) Wait for Heat create to finish
 589         :param timeout: (int) Timeout in seconds for Heat create,
 590                default 3600s
 591         :return A dict with the requested output values from the template
 592         """
 593         log.info("Creating stack '%s' START", self.name)
 594
 595         start_time = time.time()
 596         stack = HeatStack(self.name)
 597         stack.create(self._template, self.heat_parameters, block, timeout)
 598
 599         if not block:
 600             log.info("Creating stack '%s' DONE in %d secs",
 601                      self.name, time.time() - start_time)
 602             return stack
 603
 604         if stack.status != self.HEAT_STATUS_COMPLETE:
 605             raise exceptions.HeatTemplateError(stack_name=self.name)
 606
 607         log.info("Creating stack '%s' DONE in %d secs",
 608                  self.name, time.time() - start_time)
 609         return stack