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 from __future__ import print_function
  14 from six.moves import range
  15
  16 import collections
  17 import datetime
  18 import getpass
  19 import logging
  20
  21 import socket
  22 import time
  23
  24 import heatclient.client
  25 import pkg_resources
  26
  27 from oslo_utils import encodeutils
  28
  29 import yardstick.common.openstack_utils as op_utils
  30 from yardstick.common import template_format
  31
  32 log = logging.getLogger(__name__)
  33
  34
  35 HEAT_KEY_UUID_LENGTH = 8
  36
  37 PROVIDER_SRIOV = "sriov"
  38
  39
  40 def get_short_key_uuid(uuid):
  41     return str(uuid)[:HEAT_KEY_UUID_LENGTH]
  42
  43
  44 class HeatObject(object):
  45     """base class for template and stack"""
  46
  47     def __init__(self):
  48         self._heat_client = None
  49         self.uuid = None
  50
  51     @property
  52     def heat_client(self):
  53         """returns a heat client instance"""
  54
  55         if self._heat_client is None:
  56             sess = op_utils.get_session()
  57             heat_endpoint = op_utils.get_endpoint(service_type='orchestration')
  58             self._heat_client = heatclient.client.Client(
  59                 op_utils.get_heat_api_version(),
  60                 endpoint=heat_endpoint, session=sess)
  61
  62         return self._heat_client
  63
  64     def status(self):
  65         """returns stack state as a string"""
  66         heat_client = self.heat_client
  67         stack = heat_client.stacks.get(self.uuid)
  68         return stack.stack_status
  69
  70
  71 class HeatStack(HeatObject):
  72     """Represents a Heat stack (deployed template) """
  73     stacks = []
  74
  75     def __init__(self, name):
  76         super(HeatStack, self).__init__()
  77         self.uuid = None
  78         self.name = name
  79         self.outputs = None
  80         HeatStack.stacks.append(self)
  81
  82     @staticmethod
  83     def stacks_exist():
  84         """check if any stack has been deployed"""
  85         return len(HeatStack.stacks) > 0
  86
  87     def _delete(self):
  88         """deletes a stack from the target cloud using heat"""
  89         if self.uuid is None:
  90             return
  91
  92         log.info("Deleting stack '%s', uuid:%s", self.name, self.uuid)
  93         heat = self.heat_client
  94         template = heat.stacks.get(self.uuid)
  95         start_time = time.time()
  96         template.delete()
  97
  98         for status in iter(self.status, u'DELETE_COMPLETE'):
  99             log.debug("stack state %s", status)
 100             if status == u'DELETE_FAILED':
 101                 raise RuntimeError(
 102                     heat.stacks.get(self.uuid).stack_status_reason)
 103
 104             time.sleep(2)
 105
 106         end_time = time.time()
 107         log.info("Deleted stack '%s' in %d secs", self.name,
 108                  end_time - start_time)
 109         self.uuid = None
 110
 111     def delete(self, block=True, retries=3):
 112         """deletes a stack in the target cloud using heat (with retry)
 113         Sometimes delete fail with "InternalServerError" and the next attempt
 114         succeeds. So it is worthwhile to test a couple of times.
 115         """
 116         if self.uuid is None:
 117             return
 118
 119         if not block:
 120             self._delete()
 121             return
 122
 123         for _ in range(retries):
 124             try:
 125                 self._delete()
 126                 break
 127             except RuntimeError as err:
 128                 log.warning(err.args)
 129                 time.sleep(2)
 130
 131         # if still not deleted try once more and let it fail everything
 132         if self.uuid is not None:
 133             self._delete()
 134
 135         HeatStack.stacks.remove(self)
 136
 137     @staticmethod
 138     def delete_all():
 139         for stack in HeatStack.stacks[:]:
 140             stack.delete()
 141
 142     def update(self):
 143         """update a stack"""
 144         raise RuntimeError("not implemented")
 145
 146
 147 class HeatTemplate(HeatObject):
 148     """Describes a Heat template and a method to deploy template to a stack"""
 149
 150     DESCRIPTION_TEMPLATE = """\
 151 Stack built by the yardstick framework for %s on host %s %s.
 152 All referred generated resources are prefixed with the template
 153 name (i.e. %s).\
 154 """
 155
 156     def _init_template(self):
 157         timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 158         self._template = {
 159             'heat_template_version': '2013-05-23',
 160             'description': self.DESCRIPTION_TEMPLATE % (
 161                 getpass.getuser(),
 162                 socket.gethostname(),
 163                 timestamp,
 164                 self.name
 165             ),
 166             'resources': {},
 167             'outputs': {}
 168         }
 169
 170         # short hand for resources part of template
 171         self.resources = self._template['resources']
 172
 173     def __init__(self, name, template_file=None, heat_parameters=None):
 174         super(HeatTemplate, self).__init__()
 175         self.name = name
 176         self.state = "NOT_CREATED"
 177         self.keystone_client = None
 178         self.heat_parameters = {}
 179
 180         # heat_parameters is passed to heat in stack create, empty dict when
 181         # yardstick creates the template (no get_param in resources part)
 182         if heat_parameters:
 183             self.heat_parameters = heat_parameters
 184
 185         if template_file:
 186             with open(template_file) as stream:
 187                 print("Parsing external template:", template_file)
 188                 template_str = stream.read()
 189             self._template = template_format.parse(template_str)
 190             self._parameters = heat_parameters
 191         else:
 192             self._init_template()
 193
 194         # holds results of requested output after deployment
 195         self.outputs = {}
 196
 197         log.debug("template object '%s' created", name)
 198
 199     def add_flavor(self, name, vcpus=1, ram=1024, disk=1, ephemeral=0,
 200                    is_public=True, rxtx_factor=1.0, swap=0,
 201                    extra_specs=None):
 202         """add to the template a Flavor description"""
 203         if name is None:
 204             name = 'auto'
 205         log.debug("adding Nova::Flavor '%s' vcpus '%d' ram '%d' disk '%d' " +
 206                   "ephemeral '%d' is_public '%s' rxtx_factor '%d' " +
 207                   "swap '%d' extra_specs '%s' ",
 208                   name, vcpus, ram, disk, ephemeral, is_public,
 209                   rxtx_factor, swap, str(extra_specs))
 210
 211         if extra_specs:
 212             assert isinstance(extra_specs, collections.Mapping)
 213
 214         self.resources[name] = {
 215             'type': 'OS::Nova::Flavor',
 216             'properties': {'name': name,
 217                            'disk': disk,
 218                            'vcpus': vcpus,
 219                            'swap': swap,
 220                            'flavorid': name,
 221                            'rxtx_factor': rxtx_factor,
 222                            'ram': ram,
 223                            'is_public': is_public,
 224                            'ephemeral': ephemeral,
 225                            'extra_specs': extra_specs}
 226         }
 227
 228         self._template['outputs'][name] = {
 229             'description': 'Flavor %s ID' % name,
 230             'value': {'get_resource': name}
 231         }
 232
 233     def add_volume(self, name, size=10):
 234         """add to the template a volume description"""
 235         log.debug("adding Cinder::Volume '%s' size '%d' ", name, size)
 236
 237         self.resources[name] = {
 238             'type': 'OS::Cinder::Volume',
 239             'properties': {'name': name,
 240                            'size': size}
 241         }
 242
 243         self._template['outputs'][name] = {
 244             'description': 'Volume %s ID' % name,
 245             'value': {'get_resource': name}
 246         }
 247
 248     def add_volume_attachment(self, server_name, volume_name, mountpoint=None):
 249         """add to the template an association of volume to instance"""
 250         log.debug("adding Cinder::VolumeAttachment server '%s' volume '%s' ", server_name,
 251                   volume_name)
 252
 253         name = "%s-%s" % (server_name, volume_name)
 254
 255         volume_id = op_utils.get_volume_id(volume_name)
 256         if not volume_id:
 257             volume_id = {'get_resource': volume_name}
 258         self.resources[name] = {
 259             'type': 'OS::Cinder::VolumeAttachment',
 260             'properties': {'instance_uuid': {'get_resource': server_name},
 261                            'volume_id': volume_id}
 262         }
 263
 264         if mountpoint:
 265             self.resources[name]['properties']['mountpoint'] = mountpoint
 266
 267     def add_network(self, name, physical_network='physnet1', provider=None,
 268                     segmentation_id=None, port_security_enabled=None):
 269         """add to the template a Neutron Net"""
 270         log.debug("adding Neutron::Net '%s'", name)
 271         if provider is None:
 272             self.resources[name] = {
 273                 'type': 'OS::Neutron::Net',
 274                 'properties': {
 275                     'name': name,
 276                 }
 277             }
 278         else:
 279             self.resources[name] = {
 280                 'type': 'OS::Neutron::ProviderNet',
 281                 'properties': {
 282                     'name': name,
 283                     'network_type': 'vlan',
 284                     'physical_network': physical_network,
 285                 },
 286             }
 287             if segmentation_id:
 288                 self.resources[name]['properties']['segmentation_id'] = segmentation_id
 289         # if port security is not defined then don't add to template:
 290         # some deployments don't have port security plugin installed
 291         if port_security_enabled is not None:
 292             self.resources[name]['properties']['port_security_enabled'] = port_security_enabled
 293
 294     def add_server_group(self, name, policies):     # pragma: no cover
 295         """add to the template a ServerGroup"""
 296         log.debug("adding Nova::ServerGroup '%s'", name)
 297         policies = policies if isinstance(policies, list) else [policies]
 298         self.resources[name] = {
 299             'type': 'OS::Nova::ServerGroup',
 300             'properties': {'name': name,
 301                            'policies': policies}
 302         }
 303
 304     def add_subnet(self, name, network, cidr, enable_dhcp='true', gateway_ip=None):
 305         """add to the template a Neutron Subnet
 306         """
 307         log.debug("adding Neutron::Subnet '%s' in network '%s', cidr '%s'",
 308                   name, network, cidr)
 309         self.resources[name] = {
 310             'type': 'OS::Neutron::Subnet',
 311             'depends_on': network,
 312             'properties': {
 313                 'name': name,
 314                 'cidr': cidr,
 315                 'network_id': {'get_resource': network},
 316                 'enable_dhcp': enable_dhcp,
 317             }
 318         }
 319         if gateway_ip == 'null':
 320             self.resources[name]['properties']['gateway_ip'] = None
 321         elif gateway_ip is not None:
 322             self.resources[name]['properties']['gateway_ip'] = gateway_ip
 323
 324         self._template['outputs'][name] = {
 325             'description': 'subnet %s ID' % name,
 326             'value': {'get_resource': name}
 327         }
 328         self._template['outputs'][name + "-cidr"] = {
 329             'description': 'subnet %s cidr' % name,
 330             'value': {'get_attr': [name, 'cidr']}
 331         }
 332         self._template['outputs'][name + "-gateway_ip"] = {
 333             'description': 'subnet %s gateway_ip' % name,
 334             'value': {'get_attr': [name, 'gateway_ip']}
 335         }
 336
 337     def add_router(self, name, ext_gw_net, subnet_name):
 338         """add to the template a Neutron Router and interface"""
 339         log.debug("adding Neutron::Router:'%s', gw-net:'%s'", name, ext_gw_net)
 340         self.resources[name] = {
 341             'type': 'OS::Neutron::Router',
 342             'depends_on': [subnet_name],
 343             'properties': {
 344                 'name': name,
 345                 'external_gateway_info': {
 346                     'network': ext_gw_net
 347                 }
 348             }
 349         }
 350
 351     def add_router_interface(self, name, router_name, subnet_name):
 352         """add to the template a Neutron RouterInterface and interface"""
 353         log.debug("adding Neutron::RouterInterface '%s' router:'%s', "
 354                   "subnet:'%s'", name, router_name, subnet_name)
 355         self.resources[name] = {
 356             'type': 'OS::Neutron::RouterInterface',
 357             'depends_on': [router_name, subnet_name],
 358             'properties': {
 359                 'router_id': {'get_resource': router_name},
 360                 'subnet_id': {'get_resource': subnet_name}
 361             }
 362         }
 363
 364     def add_port(self, name, network_name, subnet_name, vnic_type, sec_group_id=None,
 365                  provider=None, allowed_address_pairs=None):
 366         """add to the template a named Neutron Port
 367         """
 368         log.debug("adding Neutron::Port '%s', network:'%s', subnet:'%s', vnic_type:'%s', "
 369                   "secgroup:%s", name, network_name, subnet_name, vnic_type, sec_group_id)
 370         self.resources[name] = {
 371             'type': 'OS::Neutron::Port',
 372             'depends_on': [subnet_name],
 373             'properties': {
 374                 'name': name,
 375                 'binding:vnic_type': vnic_type,
 376                 'fixed_ips': [{'subnet': {'get_resource': subnet_name}}],
 377                 'network_id': {'get_resource': network_name},
 378                 'replacement_policy': 'AUTO',
 379             }
 380         }
 381
 382         if provider == PROVIDER_SRIOV:
 383             self.resources[name]['properties']['binding:vnic_type'] = \
 384                 'direct'
 385
 386         if sec_group_id:
 387             self.resources[name]['depends_on'].append(sec_group_id)
 388             self.resources[name]['properties']['security_groups'] = \
 389                 [sec_group_id]
 390
 391         if allowed_address_pairs:
 392             self.resources[name]['properties'][
 393                 'allowed_address_pairs'] = allowed_address_pairs
 394
 395         self._template['outputs'][name] = {
 396             'description': 'Address for interface %s' % name,
 397             'value': {'get_attr': [name, 'fixed_ips', 0, 'ip_address']}
 398         }
 399         self._template['outputs'][name + "-subnet_id"] = {
 400             'description': 'Address for interface %s' % name,
 401             'value': {'get_attr': [name, 'fixed_ips', 0, 'subnet_id']}
 402         }
 403         self._template['outputs'][name + "-mac_address"] = {
 404             'description': 'MAC Address for interface %s' % name,
 405             'value': {'get_attr': [name, 'mac_address']}
 406         }
 407         self._template['outputs'][name + "-device_id"] = {
 408             'description': 'Device ID for interface %s' % name,
 409             'value': {'get_attr': [name, 'device_id']}
 410         }
 411         self._template['outputs'][name + "-network_id"] = {
 412             'description': 'Network ID for interface %s' % name,
 413             'value': {'get_attr': [name, 'network_id']}
 414         }
 415
 416     def add_floating_ip(self, name, network_name, port_name, router_if_name,
 417                         secgroup_name=None):
 418         """add to the template a Nova FloatingIP resource
 419         see: https://bugs.launchpad.net/heat/+bug/1299259
 420         """
 421         log.debug("adding Nova::FloatingIP '%s', network '%s', port '%s', "
 422                   "rif '%s'", name, network_name, port_name, router_if_name)
 423
 424         self.resources[name] = {
 425             'type': 'OS::Nova::FloatingIP',
 426             'depends_on': [port_name, router_if_name],
 427             'properties': {
 428                 'pool': network_name
 429             }
 430         }
 431
 432         if secgroup_name:
 433             self.resources[name]["depends_on"].append(secgroup_name)
 434
 435         self._template['outputs'][name] = {
 436             'description': 'floating ip %s' % name,
 437             'value': {'get_attr': [name, 'ip']}
 438         }
 439
 440     def add_floating_ip_association(self, name, floating_ip_name, port_name):
 441         """add to the template a Nova FloatingIP Association resource
 442         """
 443         log.debug("adding Nova::FloatingIPAssociation '%s', server '%s', "
 444                   "floating_ip '%s'", name, port_name, floating_ip_name)
 445
 446         self.resources[name] = {
 447             'type': 'OS::Neutron::FloatingIPAssociation',
 448             'depends_on': [port_name],
 449             'properties': {
 450                 'floatingip_id': {'get_resource': floating_ip_name},
 451                 'port_id': {'get_resource': port_name}
 452             }
 453         }
 454
 455     def add_keypair(self, name, key_uuid):
 456         """add to the template a Nova KeyPair"""
 457         log.debug("adding Nova::KeyPair '%s'", name)
 458         self.resources[name] = {
 459             'type': 'OS::Nova::KeyPair',
 460             'properties': {
 461                 'name': name,
 462                 # resource_string returns bytes, so we must decode to unicode
 463                 'public_key': encodeutils.safe_decode(
 464                     pkg_resources.resource_string(
 465                         'yardstick.resources',
 466                         'files/yardstick_key-' +
 467                         get_short_key_uuid(key_uuid) + '.pub'),
 468                     'utf-8')
 469             }
 470         }
 471
 472     def add_servergroup(self, name, policy):
 473         """add to the template a Nova ServerGroup"""
 474         log.debug("adding Nova::ServerGroup '%s', policy '%s'", name, policy)
 475         if policy not in ["anti-affinity", "affinity"]:
 476             raise ValueError(policy)
 477
 478         self.resources[name] = {
 479             'type': 'OS::Nova::ServerGroup',
 480             'properties': {
 481                 'name': name,
 482                 'policies': [policy]
 483             }
 484         }
 485
 486         self._template['outputs'][name] = {
 487             'description': 'ID Server Group %s' % name,
 488             'value': {'get_resource': name}
 489         }
 490
 491     def add_security_group(self, name):
 492         """add to the template a Neutron SecurityGroup"""
 493         log.debug("adding Neutron::SecurityGroup '%s'", name)
 494         self.resources[name] = {
 495             'type': 'OS::Neutron::SecurityGroup',
 496             'properties': {
 497                 'name': name,
 498                 'description': "Group allowing icmp and upd/tcp on all ports",
 499                 'rules': [
 500                     {'remote_ip_prefix': '0.0.0.0/0',
 501                      'protocol': 'tcp',
 502                      'port_range_min': '1',
 503                      'port_range_max': '65535'},
 504                     {'remote_ip_prefix': '0.0.0.0/0',
 505                      'protocol': 'udp',
 506                      'port_range_min': '1',
 507                      'port_range_max': '65535'},
 508                     {'remote_ip_prefix': '0.0.0.0/0',
 509                      'protocol': 'icmp'}
 510                 ]
 511             }
 512         }
 513
 514         self._template['outputs'][name] = {
 515             'description': 'ID of Security Group',
 516             'value': {'get_resource': name}
 517         }
 518
 519     def add_server(self, name, image, flavor, flavors, ports=None,
 520                    networks=None, scheduler_hints=None, user=None,
 521                    key_name=None, user_data=None, metadata=None,
 522                    additional_properties=None):
 523         """add to the template a Nova Server"""
 524         log.debug("adding Nova::Server '%s', image '%s', flavor '%s', "
 525                   "ports %s", name, image, flavor, ports)
 526
 527         self.resources[name] = {
 528             'type': 'OS::Nova::Server',
 529             'depends_on': []
 530         }
 531
 532         server_properties = {
 533             'name': name,
 534             'image': image,
 535             'flavor': {},
 536             'networks': []  # list of dictionaries
 537         }
 538
 539         if flavor in flavors:
 540             self.resources[name]['depends_on'].append(flavor)
 541             server_properties["flavor"] = {'get_resource': flavor}
 542         else:
 543             server_properties["flavor"] = flavor
 544
 545         if user:
 546             server_properties['admin_user'] = user
 547
 548         if key_name:
 549             self.resources[name]['depends_on'].append(key_name)
 550             server_properties['key_name'] = {'get_resource': key_name}
 551
 552         if ports:
 553             self.resources[name]['depends_on'].extend(ports)
 554             for port in ports:
 555                 server_properties['networks'].append(
 556                     {'port': {'get_resource': port}}
 557                 )
 558
 559         if networks:
 560             for i, _ in enumerate(networks):
 561                 server_properties['networks'].append({'network': networks[i]})
 562
 563         if scheduler_hints:
 564             server_properties['scheduler_hints'] = scheduler_hints
 565
 566         if user_data:
 567             server_properties['user_data'] = user_data
 568
 569         if metadata:
 570             assert isinstance(metadata, collections.Mapping)
 571             server_properties['metadata'] = metadata
 572
 573         if additional_properties:
 574             assert isinstance(additional_properties, collections.Mapping)
 575             for prop in additional_properties:
 576                 server_properties[prop] = additional_properties[prop]
 577
 578         server_properties['config_drive'] = True
 579
 580         self.resources[name]['properties'] = server_properties
 581
 582         self._template['outputs'][name] = {
 583             'description': 'VM UUID',
 584             'value': {'get_resource': name}
 585         }
 586
 587     HEAT_WAIT_LOOP_INTERVAL = 2
 588     HEAT_CREATE_COMPLETE_STATUS = u'CREATE_COMPLETE'
 589
 590     def create(self, block=True, timeout=3600):
 591         """
 592         creates a template in the target cloud using heat
 593         returns a dict with the requested output values from the template
 594
 595         :param block: Wait for Heat create to finish
 596         :type block: bool
 597         :param: timeout: timeout in seconds for Heat create, default 3600s
 598         :type timeout: int
 599         """
 600         log.info("Creating stack '%s'", self.name)
 601
 602         # create stack early to support cleanup, e.g. ctrl-c while waiting
 603         stack = HeatStack(self.name)
 604
 605         heat_client = self.heat_client
 606         start_time = time.time()
 607         stack.uuid = self.uuid = heat_client.stacks.create(
 608             stack_name=self.name, template=self._template,
 609             parameters=self.heat_parameters)['stack']['id']
 610
 611         if not block:
 612             self.outputs = stack.outputs = {}
 613             end_time = time.time()
 614             log.info("Created stack '%s' in %.3e secs",
 615                      self.name, end_time - start_time)
 616             return stack
 617
 618         time_limit = start_time + timeout
 619         for status in iter(self.status, self.HEAT_CREATE_COMPLETE_STATUS):
 620             log.debug("stack state %s", status)
 621             if status == u'CREATE_FAILED':
 622                 stack_status_reason = heat_client.stacks.get(self.uuid).stack_status_reason
 623                 heat_client.stacks.delete(self.uuid)
 624                 raise RuntimeError(stack_status_reason)
 625             if time.time() > time_limit:
 626                 raise RuntimeError("Heat stack create timeout")
 627
 628             time.sleep(self.HEAT_WAIT_LOOP_INTERVAL)
 629
 630         end_time = time.time()
 631         outputs = heat_client.stacks.get(self.uuid).outputs
 632         log.info("Created stack '%s' in %.3e secs",
 633                  self.name, end_time - start_time)
 634
 635         # keep outputs as unicode
 636         self.outputs = {output["output_key"]: output["output_value"] for output
 637                         in outputs}
 638
 639         stack.outputs = self.outputs
 640         return stack