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