sfa/openstack/osaggregate.py

   1
   2 import os
   3 import socket
   4 import base64
   5 import string
   6 import random
   7 import time
   8 from collections import defaultdict
   9 from nova.exception import ImageNotFound
  10 from nova.api.ec2.cloud import CloudController
  11 from sfa.util.faults import SfaAPIError, SliverDoesNotExist
  12 from sfa.util.sfatime import utcparse, datetime_to_string, datetime_to_epoch
  13 from sfa.rspecs.rspec import RSpec
  14 from sfa.rspecs.elements.hardware_type import HardwareType
  15 from sfa.rspecs.elements.node import Node
  16 from sfa.rspecs.elements.sliver import Sliver
  17 from sfa.rspecs.elements.login import Login
  18 from sfa.rspecs.elements.disk_image import DiskImage
  19 from sfa.rspecs.elements.services import Services
  20 from sfa.rspecs.elements.interface import Interface
  21 from sfa.rspecs.elements.fw_rule import FWRule
  22 from sfa.util.xrn import Xrn
  23 from sfa.planetlab.plxrn import PlXrn
  24 from sfa.openstack.osxrn import OSXrn, hrn_to_os_slicename
  25 from sfa.rspecs.version_manager import VersionManager
  26 from sfa.openstack.security_group import SecurityGroup
  27 from sfa.util.sfalogging import logger
  28
  29 def pubkeys_to_user_data(pubkeys):
  30     user_data = "#!/bin/bash\n\n"
  31     for pubkey in pubkeys:
  32         pubkey = pubkey.replace('\n', '')
  33         user_data += "echo %s >> /root/.ssh/authorized_keys" % pubkey
  34         user_data += "\n"
  35         user_data += "echo >> /root/.ssh/authorized_keys"
  36         user_data += "\n"
  37     return user_data
  38
  39 def image_to_rspec_disk_image(image):
  40     img = DiskImage()
  41     img['name'] = image['name']
  42     img['description'] = image['name']
  43     img['os'] = image['name']
  44     img['version'] = image['name']
  45     return img
  46
  47 class OSAggregate:
  48
  49     def __init__(self, driver):
  50         self.driver = driver
  51
  52     def get_availability_zones(self):
  53         zones = self.driver.shell.nova_manager.dns_domains.domains()
  54         if not zones:
  55             zones = ['cloud']
  56         else:
  57             zones = [zone.name for zone in zones]
  58         return zones
  59
  60     def list_resources(self, version=None, options={}):
  61         version_manager = VersionManager()
  62         version = version_manager.get_version(version)
  63         rspec_version = version_manager._get_version(version.type, version.version, 'ad')
  64         rspec = RSpec(version=version, user_options=options)
  65         nodes = self.get_aggregate_nodes()
  66         rspec.version.add_nodes(nodes)
  67         return rspec.toxml()
  68
  69     def describe(self, urns, version=None, options={}):
  70         # update nova connection
  71         tenant_name = OSXrn(xrn=urns[0], type='slice').get_tenant_name()
  72         self.driver.shell.nova_manager.connect(tenant=tenant_name)
  73         instances = self.get_instances(urns)
  74         if len(instances) == 0:
  75             raise SliverDoesNotExist("You have not allocated any slivers here")
  76
  77         # lookup the sliver allocations
  78         sliver_ids = [sliver['sliver_id'] for sliver in slivers]
  79         constraint = SliverAllocation.sliver_id.in_(sliver_ids)
  80         sliver_allocations = dbsession.query(SliverAllocation).filter(constraint)
  81         sliver_allocation_dict = {}
  82         for sliver_allocation in sliver_allocations:
  83             sliver_allocation_dict[sliver_allocation.sliver_id] = sliver_allocation
  84
  85         geni_slivers = []
  86         rspec_nodes = []
  87         for instance in instances:
  88             rspec_nodes.append(self.instance_to_rspec_node(instance))
  89             geni_sliver = self.instance_to_geni_sliver(instance, sliver_sllocation_dict)
  90             geni_slivers.append(geni_sliver)
  91         version_manager = VersionManager()
  92         version = version_manager.get_version(version)
  93         rspec_version = version_manager._get_version(version.type, version.version, 'manifest')
  94         rspec = RSpec(version=rspec_version, user_options=options)
  95         rspec.version.add_nodes(rspec_nodes)
  96         result = {'geni_urn': Xrn(urns[0]).get_urn(),
  97                   'geni_rspec': rspec.toxml(),
  98                   'geni_slivers': geni_slivers}
  99
 100         return result
 101
 102     def get_instances(self, urns):
 103         # parse slice names and sliver ids
 104         names = set()
 105         ids = set()
 106         for urn in urns:
 107             xrn = OSXrn(xrn=urn)
 108             if xrn.type == 'slice':
 109                 names.add(xrn.get_slice_name())
 110             elif xrn.type == 'sliver':
 111                 ids.add(xrn.leaf)
 112
 113         # look up instances
 114         instances = []
 115         filter = {}
 116         if names:
 117             filter['name'] = names
 118         if ids:
 119             filter['id'] = ids
 120         servers = self.driver.shell.nova_manager.servers.findall(**filter)
 121         instances.extend(servers)
 122
 123         return instances
 124
 125     def instance_to_rspec_node(self, instance):
 126         # determine node urn
 127         node_xrn = instance.metadata.get('component_id')
 128         if not node_xrn:
 129             node_xrn = OSXrn('cloud', type='node')
 130         else:
 131             node_xrn = OSXrn(xrn=node_xrn, type='node')
 132
 133         rspec_node = Node()
 134         rspec_node['component_id'] = node_xrn.urn
 135         rspec_node['component_name'] = node_xrn.name
 136         rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
 137         rspec_node['sliver_id'] = OSXrn(name=instance.name, type='slice', id=instance.id).get_urn()
 138         if instance.metadata.get('client_id'):
 139             rspec_node['client_id'] = instance.metadata.get('client_id')
 140
 141         # get sliver details
 142         flavor = self.driver.shell.nova_manager.flavors.find(id=instance.flavor['id'])
 143         sliver = self.instance_to_sliver(flavor)
 144         # get firewall rules
 145         fw_rules = []
 146         group_name = instance.metadata.get('security_groups')
 147         if group_name:
 148             group = self.driver.shell.nova_manager.security_groups.find(name=group_name)
 149             for rule in group.rules:
 150                 port_range ="%s:%s" % (rule['from_port'], rule['to_port'])
 151                 fw_rule = FWRule({'protocol': rule['ip_protocol'],
 152                                   'port_range': port_range,
 153                                   'cidr_ip': rule['ip_range']['cidr']})
 154                 fw_rules.append(fw_rule)
 155         sliver['fw_rules'] = fw_rules
 156         rspec_node['slivers'] = [sliver]
 157
 158         # get disk image
 159         image = self.driver.shell.image_manager.get_images(id=instance.image['id'])
 160         if isinstance(image, list) and len(image) > 0:
 161             image = image[0]
 162         disk_image = image_to_rspec_disk_image(image)
 163         sliver['disk_image'] = [disk_image]
 164
 165         # get interfaces
 166         rspec_node['services'] = []
 167         rspec_node['interfaces'] = []
 168         addresses = instance.addresses
 169         # HACK: public ips are stored in the list of private, but
 170         # this seems wrong. Assume pub ip is the last in the list of
 171         # private ips until openstack bug is fixed.
 172         if addresses.get('private'):
 173             login = Login({'authentication': 'ssh-keys',
 174                            'hostname': addresses.get('private')[-1]['addr'],
 175                            'port':'22', 'username': 'root'})
 176             service = Services({'login': login})
 177             rspec_node['services'].append(service)
 178
 179         for private_ip in addresses.get('private', []):
 180             if_xrn = PlXrn(auth=self.driver.hrn,
 181                            interface='node%s' % (instance.hostId))
 182             if_client_id = Xrn(if_xrn.urn, type='interface', id="eth%s" %if_index).urn
 183             if_sliver_id = Xrn(rspec_node['sliver_id'], type='slice', id="eth%s" %if_index).urn
 184             interface = Interface({'component_id': if_xrn.urn,
 185                                    'client_id': if_client_id,
 186                                    'sliver_id': if_sliver_id})
 187             interface['ips'] =  [{'address': private_ip['addr'],
 188                                  #'netmask': private_ip['network'],
 189                                  'type': private_ip['version']}]
 190             rspec_node['interfaces'].append(interface)
 191
 192         # slivers always provide the ssh service
 193         for public_ip in addresses.get('public', []):
 194             login = Login({'authentication': 'ssh-keys',
 195                            'hostname': public_ip['addr'],
 196                            'port':'22', 'username': 'root'})
 197             service = Services({'login': login})
 198             rspec_node['services'].append(service)
 199         return rspec_node
 200
 201
 202     def instance_to_sliver(self, instance, xrn=None):
 203         if xrn:
 204             sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
 205             sliver_id = Xrn(sliver_hrn, type='sliver').urn
 206
 207         sliver = Sliver({'sliver_id': sliver_id,
 208                          'name': instance.name,
 209                          'type': instance.name,
 210                          'cpus': str(instance.vcpus),
 211                          'memory': str(instance.ram),
 212                          'storage':  str(instance.disk)})
 213         return sliver
 214
 215     def instance_to_geni_sliver(self, instance, sliver_allocations = {}):
 216         sliver_hrn = '%s.%s' % (self.driver.hrn, instance.id)
 217         sliver_id = Xrn(sliver_hrn, type='sliver').urn
 218
 219         # set sliver allocation and operational status
 220         sliver_allocation = sliver_allocations[sliver_id]
 221         if sliver_allocation:
 222             allocation_status = sliver_allocation.allocation_state
 223             if allocation_status == 'geni_allocated':
 224                 op_status =  'geni_pending_allocation'
 225             elif allocation_status == 'geni_provisioned':
 226                 state = instance.state.lower()
 227                 if state == 'active':
 228                     op_status = 'geni_ready'
 229                 elif state == 'building':
 230                     op_status = 'geni_notready'
 231                 elif state == 'failed':
 232                     op_status =' geni_failed'
 233                 else:
 234                     op_status = 'geni_unknown'
 235             else:
 236                 allocation_status = 'geni_unallocated'
 237         # required fields
 238         geni_sliver = {'geni_sliver_urn': sliver_id,
 239                        'geni_expires': None,
 240                        'geni_allocation_status': allocation_status,
 241                        'geni_operational_status': op_status,
 242                        'geni_error': None,
 243                        'plos_created_at': datetime_to_string(utcparse(instance.created)),
 244                        'plos_sliver_type': self.shell.nova_manager.flavors.find(id=instance.flavor['id']).name,
 245                         }
 246
 247
 248         return geni_sliver
 249
 250     def get_aggregate_nodes(self):
 251         zones = self.get_availability_zones()
 252         # available sliver/instance/vm types
 253         instances = self.driver.shell.nova_manager.flavors.list()
 254         if isinstance(instances, dict):
 255             instances = instances.values()
 256         # available images
 257         images = self.driver.shell.image_manager.get_images_detailed()
 258         disk_images  = [image_to_rspec_disk_image(img) for img in images if img['container_format'] in ['ami', 'ovf']]
 259         rspec_nodes = []
 260         for zone in zones:
 261             rspec_node = Node()
 262             xrn = OSXrn(zone, type='node')
 263             rspec_node['component_id'] = xrn.urn
 264             rspec_node['component_name'] = xrn.name
 265             rspec_node['component_manager_id'] = Xrn(self.driver.hrn, 'authority+cm').get_urn()
 266             rspec_node['exclusive'] = 'false'
 267             rspec_node['hardware_types'] = [HardwareType({'name': 'plos-pc'}),
 268                                                 HardwareType({'name': 'pc'})]
 269             slivers = []
 270             for instance in instances:
 271                 sliver = self.instance_to_sliver(instance)
 272                 sliver['disk_image'] = disk_images
 273                 slivers.append(sliver)
 274             rspec_node['available'] = 'true'
 275             rspec_node['slivers'] = slivers
 276             rspec_nodes.append(rspec_node)
 277
 278         return rspec_nodes
 279
 280     def create_tenant(self, tenant_name):
 281         tenants = self.driver.shell.auth_manager.tenants.findall(name=tenant_name)
 282         if not tenants:
 283             self.driver.shell.auth_manager.tenants.create(tenant_name, tenant_name)
 284             tenant = self.driver.shell.auth_manager.tenants.find(name=tenant_name)
 285         else:
 286             tenant = tenants[0]
 287         return tenant
 288
 289     def create_instance_key(self, slice_hrn, user):
 290         slice_name = Xrn(slice_hrn).leaf
 291         user_name = Xrn(user['urn']).leaf
 292         key_name = "%s_%s" % (slice_name, user_name)
 293         pubkey = user['keys'][0]
 294         key_found = False
 295         existing_keys = self.driver.shell.nova_manager.keypairs.findall(name=key_name)
 296         for existing_key in existing_keys:
 297             if existing_key.public_key != pubkey:
 298                 self.driver.shell.nova_manager.keypairs.delete(existing_key)
 299             elif existing_key.public_key == pubkey:
 300                 key_found = True
 301
 302         if not key_found:
 303             self.driver.shell.nova_manager.keypairs.create(key_name, pubkey)
 304         return key_name
 305
 306
 307     def create_security_group(self, slicename, fw_rules=[]):
 308         # use default group by default
 309         group_name = 'default'
 310         if isinstance(fw_rules, list) and fw_rules:
 311             # Each sliver get's its own security group.
 312             # Keep security group names unique by appending some random
 313             # characters on end.
 314             random_name = "".join([random.choice(string.letters+string.digits)
 315                                            for i in xrange(6)])
 316             group_name = slicename + random_name
 317             security_group = SecurityGroup(self.driver)
 318             security_group.create_security_group(group_name)
 319             for rule in fw_rules:
 320                 security_group.add_rule_to_group(group_name,
 321                                              protocol = rule.get('protocol'),
 322                                              cidr_ip = rule.get('cidr_ip'),
 323                                              port_range = rule.get('port_range'),
 324                                              icmp_type_code = rule.get('icmp_type_code'))
 325         return group_name
 326
 327     def add_rule_to_security_group(self, group_name, **kwds):
 328         security_group = SecurityGroup(self.driver)
 329         security_group.add_rule_to_group(group_name=group_name,
 330                                          protocol=kwds.get('protocol'),
 331                                          cidr_ip =kwds.get('cidr_ip'),
 332                                          icmp_type_code = kwds.get('icmp_type_code'))
 333
 334
 335
 336     def run_instances(self, instance_name, tenant_name, rspec, key_name, pubkeys):
 337         #logger.debug('Reserving an instance: image: %s, flavor: ' \
 338         #            '%s, key: %s, name: %s' % \
 339         #            (image_id, flavor_id, key_name, slicename))
 340
 341         # make sure a tenant exists for this slice
 342         tenant = self.create_tenant(tenant_name)
 343
 344         # add the sfa admin user to this tenant and update our nova client connection
 345         # to use these credentials for the rest of this session. This emsures that the instances
 346         # we create will be assigned to the correct tenant.
 347         sfa_admin_user = self.driver.shell.auth_manager.users.find(name=self.driver.shell.auth_manager.opts['OS_USERNAME'])
 348         user_role = self.driver.shell.auth_manager.roles.find(name='user')
 349         admin_role = self.driver.shell.auth_manager.roles.find(name='admin')
 350         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, admin_role, tenant)
 351         self.driver.shell.auth_manager.roles.add_user_role(sfa_admin_user, user_role, tenant)
 352         self.driver.shell.nova_manager.connect(tenant=tenant.name)
 353
 354         authorized_keys = "\n".join(pubkeys)
 355         files = {'/root/.ssh/authorized_keys': authorized_keys}
 356         rspec = RSpec(rspec)
 357         requested_instances = defaultdict(list)
 358         # iterate over clouds/zones/nodes
 359         slivers = []
 360         for node in rspec.version.get_nodes_with_slivers():
 361             instances = node.get('slivers', [])
 362             if not instances:
 363                 continue
 364             for instance in instances:
 365                 try:
 366                     metadata = {}
 367                     flavor_id = self.driver.shell.nova_manager.flavors.find(name=instance['name'])
 368                     image = instance.get('disk_image')
 369                     if image and isinstance(image, list):
 370                         image = image[0]
 371                     image_id = self.driver.shell.nova_manager.images.find(name=image['name'])
 372                     fw_rules = instance.get('fw_rules', [])
 373                     group_name = self.create_security_group(instance_name, fw_rules)
 374                     metadata['security_groups'] = group_name
 375                     if node.get('component_id'):
 376                         metadata['component_id'] = node['component_id']
 377                     if node.get('client_id'):
 378                         metadata['client_id'] = node['client_id']
 379                     server = self.driver.shell.nova_manager.servers.create(
 380                                                             flavor=flavor_id,
 381                                                             image=image_id,
 382                                                             key_name = key_name,
 383                                                             security_groups = [group_name],
 384                                                             files=files,
 385                                                             meta=metadata,
 386                                                             name=instance_name)
 387                     slivers.append(server)
 388                 except Exception, err:
 389                     logger.log_exc(err)
 390
 391         return slivers
 392
 393     def delete_instance(self, instance):
 394
 395         def _delete_security_group(inst):
 396             security_group = inst.metadata.get('security_groups', '')
 397             if security_group:
 398                 manager = SecurityGroup(self.driver)
 399                 timeout = 10.0 # wait a maximum of 10 seconds before forcing the security group delete
 400                 start_time = time.time()
 401                 instance_deleted = False
 402                 while instance_deleted == False and (time.time() - start_time) < timeout:
 403                     tmp_inst = self.driver.shell.nova_manager.servers.findall(id=inst.id)
 404                     if not tmp_inst:
 405                         instance_deleted = True
 406                     time.sleep(.5)
 407                 manager.delete_security_group(security_group)
 408
 409         thread_manager = ThreadManager()
 410         tenant = self.driver.shell.auth_manager.tenants.find(id=instance.tenant_id)
 411         self.driver.shell.nova_manager.connect(tenant=tenant.name)
 412         args = {'name': instance.name,
 413                 'id': instance.id}
 414         instances = self.driver.shell.nova_manager.servers.findall(**args)
 415         security_group_manager = SecurityGroup(self.driver)
 416         for instance in instances:
 417             # destroy instance
 418             self.driver.shell.nova_manager.servers.delete(instance)
 419             # deleate this instance's security groups
 420             thread_manager.run(_delete_security_group, instance)
 421         return 1
 422
 423     def stop_instances(self, instance_name, tenant_name, id=None):
 424         self.driver.shell.nova_manager.connect(tenant=tenant_name)
 425         args = {'name': instance_name}
 426         if id:
 427             args['id'] = id
 428         instances = self.driver.shell.nova_manager.servers.findall(**args)
 429         for instance in instances:
 430             self.driver.shell.nova_manager.servers.pause(instance)
 431         return 1
 432
 433     def start_instances(self, instance_name, tenant_name, id=None):
 434         self.driver.shell.nova_manager.connect(tenant=tenant_name)
 435         args = {'name': instance_name}
 436         if id:
 437             args['id'] = id
 438         instances = self.driver.shell.nova_manager.servers.findall(**args)
 439         for instance in instances:
 440             self.driver.shell.nova_manager.servers.resume(instance)
 441         return 1
 442
 443     def restart_instances(self, instacne_name, tenant_name, id=None):
 444         self.stop_instances(instance_name, tenant_name, id)
 445         self.start_instances(instance_name, tenant_name, id)
 446         return 1
 447
 448     def update_instances(self, project_name):
 449         pass