yardstick/benchmark/contexts/heat.py

   1 ##############################################################################
   2 # Copyright (c) 2015 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 import os
  11 import sys
  12 import pkg_resources
  13
  14 from yardstick.benchmark.contexts.base import Context
  15 from yardstick.benchmark.contexts.model import Server
  16 from yardstick.benchmark.contexts.model import PlacementGroup
  17 from yardstick.benchmark.contexts.model import Network
  18 from yardstick.benchmark.contexts.model import update_scheduler_hints
  19 from yardstick.orchestrator.heat import HeatTemplate
  20
  21
  22 class HeatContext(Context):
  23     '''Class that represents a context in the logical model'''
  24
  25     __context_type__ = "Heat"
  26
  27     def __init__(self):
  28         self.name = None
  29         self.stack = None
  30         self.networks = []
  31         self.servers = []
  32         self.placement_groups = []
  33         self.keypair_name = None
  34         self.secgroup_name = None
  35         self._server_map = {}
  36         self._image = None
  37         self._flavor = None
  38         self._user = None
  39         self.template_file = None
  40         self.heat_parameters = None
  41         super(self.__class__, self).__init__()
  42
  43     def init(self, attrs):
  44         '''initializes itself from the supplied arguments'''
  45         self.name = attrs["name"]
  46
  47         if "user" in attrs:
  48             self._user = attrs["user"]
  49
  50         if "heat_template" in attrs:
  51             self.template_file = attrs["heat_template"]
  52             self.heat_parameters = attrs.get("heat_parameters", None)
  53             return
  54
  55         self.keypair_name = self.name + "-key"
  56         self.secgroup_name = self.name + "-secgroup"
  57
  58         # Temporarily removing security group due to
  59         # ssh problems with ODL scenarios.
  60         scenario = os.environ.get('DEPLOY_SCENARIO', None)
  61         if scenario and scenario.startswith('os-odl'):
  62             print "INFO: ODL scenario - removing security group."
  63             self.secgroup_name = None
  64
  65         if "image" in attrs:
  66             self._image = attrs["image"]
  67
  68         if "flavor" in attrs:
  69             self._flavor = attrs["flavor"]
  70
  71         if "placement_groups" in attrs:
  72             for name, pgattrs in attrs["placement_groups"].items():
  73                 pg = PlacementGroup(name, self, pgattrs["policy"])
  74                 self.placement_groups.append(pg)
  75
  76         for name, netattrs in attrs["networks"].items():
  77             network = Network(name, self, netattrs)
  78             self.networks.append(network)
  79
  80         for name, serverattrs in attrs["servers"].items():
  81             server = Server(name, self, serverattrs)
  82             self.servers.append(server)
  83             self._server_map[server.dn] = server
  84
  85     @property
  86     def image(self):
  87         '''returns application's default image name'''
  88         return self._image
  89
  90     @property
  91     def flavor(self):
  92         '''returns application's default flavor name'''
  93         return self._flavor
  94
  95     @property
  96     def user(self):
  97         '''return login user name corresponding to image'''
  98         return self._user
  99
 100     def _add_resources_to_template(self, template):
 101         '''add to the template the resources represented by this context'''
 102         template.add_keypair(self.keypair_name)
 103         if self.secgroup_name:
 104             template.add_security_group(self.secgroup_name)
 105
 106         for network in self.networks:
 107             template.add_network(network.stack_name)
 108             template.add_subnet(network.subnet_stack_name, network.stack_name,
 109                                 network.subnet_cidr)
 110
 111             if network.router:
 112                 template.add_router(network.router.stack_name,
 113                                     network.router.external_gateway_info,
 114                                     network.subnet_stack_name)
 115                 template.add_router_interface(network.router.stack_if_name,
 116                                               network.router.stack_name,
 117                                               network.subnet_stack_name)
 118
 119         # create a list of servers sorted by increasing no of placement groups
 120         list_of_servers = sorted(self.servers,
 121                                  key=lambda s: len(s.placement_groups))
 122
 123         #
 124         # add servers with scheduler hints derived from placement groups
 125         #
 126
 127         # create list of servers with availability policy
 128         availability_servers = []
 129         for server in list_of_servers:
 130             for pg in server.placement_groups:
 131                 if pg.policy == "availability":
 132                     availability_servers.append(server)
 133                     break
 134
 135         # add servers with availability policy
 136         added_servers = []
 137         for server in availability_servers:
 138             scheduler_hints = {}
 139             for pg in server.placement_groups:
 140                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 141             # workround for openstack nova bug, check JIRA: YARDSTICK-200
 142             # for details
 143             if len(availability_servers) == 2:
 144                 if len(scheduler_hints["different_host"]) == 0:
 145                     scheduler_hints.pop("different_host", None)
 146                     server.add_to_template(template,
 147                                            self.networks,
 148                                            scheduler_hints)
 149                     added_servers.append(server.stack_name)
 150                 else:
 151                     scheduler_hints["different_host"] = \
 152                         scheduler_hints["different_host"][0]
 153                     server.add_to_template(template,
 154                                            self.networks,
 155                                            scheduler_hints)
 156                     added_servers.append(server.stack_name)
 157             else:
 158                 server.add_to_template(template,
 159                                        self.networks,
 160                                        scheduler_hints)
 161                 added_servers.append(server.stack_name)
 162
 163         # create list of servers with affinity policy
 164         affinity_servers = []
 165         for server in list_of_servers:
 166             for pg in server.placement_groups:
 167                 if pg.policy == "affinity":
 168                     affinity_servers.append(server)
 169                     break
 170
 171         # add servers with affinity policy
 172         for server in affinity_servers:
 173             if server.stack_name in added_servers:
 174                 continue
 175             scheduler_hints = {}
 176             for pg in server.placement_groups:
 177                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 178             server.add_to_template(template, self.networks, scheduler_hints)
 179             added_servers.append(server.stack_name)
 180
 181         # add remaining servers with no placement group configured
 182         for server in list_of_servers:
 183             if len(server.placement_groups) == 0:
 184                 server.add_to_template(template, self.networks, {})
 185
 186     def deploy(self):
 187         '''deploys template into a stack using cloud'''
 188         print "Deploying context '%s'" % self.name
 189
 190         heat_template = HeatTemplate(self.name, self.template_file,
 191                                      self.heat_parameters)
 192
 193         if self.template_file is None:
 194             self._add_resources_to_template(heat_template)
 195
 196         try:
 197             self.stack = heat_template.create()
 198         except KeyboardInterrupt:
 199             sys.exit("\nStack create interrupted")
 200         except RuntimeError as err:
 201             sys.exit("error: failed to deploy stack: '%s'" % err.args)
 202         except Exception as err:
 203             sys.exit("error: failed to deploy stack: '%s'" % err)
 204
 205         # copy some vital stack output into server objects
 206         for server in self.servers:
 207             if len(server.ports) > 0:
 208                 # TODO(hafe) can only handle one internal network for now
 209                 port = server.ports.values()[0]
 210                 server.private_ip = self.stack.outputs[port["stack_name"]]
 211
 212             if server.floating_ip:
 213                 server.public_ip = \
 214                     self.stack.outputs[server.floating_ip["stack_name"]]
 215
 216         print "Context '%s' deployed" % self.name
 217
 218     def undeploy(self):
 219         '''undeploys stack from cloud'''
 220         if self.stack:
 221             print "Undeploying context '%s'" % self.name
 222             self.stack.delete()
 223             self.stack = None
 224             print "Context '%s' undeployed" % self.name
 225
 226     def _get_server(self, attr_name):
 227         '''lookup server info by name from context
 228         attr_name: either a name for a server created by yardstick or a dict
 229         with attribute name mapping when using external heat templates
 230         '''
 231         key_filename = pkg_resources.resource_filename(
 232             'yardstick.resources', 'files/yardstick_key')
 233
 234         if type(attr_name) is dict:
 235             cname = attr_name["name"].split(".")[1]
 236             if cname != self.name:
 237                 return None
 238
 239             public_ip = None
 240             private_ip = None
 241             if "public_ip_attr" in attr_name:
 242                 public_ip = self.stack.outputs[attr_name["public_ip_attr"]]
 243             if "private_ip_attr" in attr_name:
 244                 private_ip = self.stack.outputs[
 245                     attr_name["private_ip_attr"]]
 246
 247             # Create a dummy server instance for holding the *_ip attributes
 248             server = Server(attr_name["name"].split(".")[0], self, {})
 249             server.public_ip = public_ip
 250             server.private_ip = private_ip
 251         else:
 252             if attr_name not in self._server_map:
 253                 return None
 254             server = self._server_map[attr_name]
 255
 256         if server is None:
 257             return None
 258
 259         result = {
 260             "user": server.context.user,
 261             "key_filename": key_filename,
 262             "private_ip": server.private_ip
 263         }
 264         # Target server may only have private_ip
 265         if server.public_ip:
 266             result["ip"] = server.public_ip
 267
 268         return result