sfa/openstack/nova_driver.py

   1 import time
   2 import datetime
   3
   4 from sfa.util.faults import MissingSfaInfo, UnknownSfaType, \
   5     RecordNotFound, SfaNotImplemented, SliverDoesNotExist, \
   6     SfaInvalidArgument
   7
   8 from sfa.util.sfalogging import logger
   9 from sfa.util.defaultdict import defaultdict
  10 from sfa.util.sfatime import utcparse, datetime_to_string, datetime_to_epoch
  11 from sfa.util.xrn import Xrn, hrn_to_urn, get_leaf, urn_to_sliver_id
  12 from sfa.util.cache import Cache
  13 from sfa.trust.credential import Credential
  14 # used to be used in get_ticket
  15 #from sfa.trust.sfaticket import SfaTicket
  16
  17 from sfa.rspecs.version_manager import VersionManager
  18 from sfa.rspecs.rspec import RSpec
  19
  20 # the driver interface, mostly provides default behaviours
  21 from sfa.managers.driver import Driver
  22 from sfa.openstack.nova_shell import NovaShell
  23 from sfa.openstack.euca_shell import EucaShell
  24 from sfa.openstack.osaggregate import OSAggregate
  25 from sfa.plc.plslices import PlSlices
  26 from sfa.util.osxrn import OSXrn
  27
  28
  29 def list_to_dict(recs, key):
  30     """
  31     convert a list of dictionaries into a dictionary keyed on the
  32     specified dictionary key
  33     """
  34     return dict ( [ (rec[key],rec) for rec in recs ] )
  35
  36 #
  37 # PlShell is just an xmlrpc serverproxy where methods
  38 # can be sent as-is; it takes care of authentication
  39 # from the global config
  40 #
  41 class NovaDriver (Driver):
  42
  43     # the cache instance is a class member so it survives across incoming requests
  44     cache = None
  45
  46     def __init__ (self, config):
  47         Driver.__init__ (self, config)
  48         self.shell = NovaShell (config)
  49         self.euca_shell = EucaShell(config)
  50         self.cache=None
  51         if config.SFA_AGGREGATE_CACHING:
  52             if NovaDriver.cache is None:
  53                 NovaDriver.cache = Cache()
  54             self.cache = NovaDriver.cache
  55
  56     ########################################
  57     ########## registry oriented
  58     ########################################
  59
  60     ########## disabled users
  61     def is_enabled (self, record):
  62         # all records are enabled
  63         return True
  64
  65     def augment_records_with_testbed_info (self, sfa_records):
  66         return self.fill_record_info (sfa_records)
  67
  68     ##########
  69     def register (self, sfa_record, hrn, pub_key):
  70         type = sfa_record['type']
  71
  72         #pl_record = self.sfa_fields_to_pl_fields(type     dd , hrn, sfa_record)
  73
  74         if type == 'slice':
  75             # add slice description, name, researchers, PI
  76             name = Xrn(hrn).get_leaf()
  77             researchers = sfa_record.get('researchers', [])
  78             pis = sfa_record.get('pis', [])
  79             project_manager = None
  80             description = sfa_record.get('description', None)
  81             if pis:
  82                 project_manager = Xrn(pis[0], 'user').get_leaf()
  83             elif researchers:
  84                 project_manager = Xrn(researchers[0], 'user').get_leaf()
  85             if not project_manager:
  86                 err_string = "Cannot create a project without a project manager. " + \
  87                              "Please specify at least one PI or researcher for project: " + \
  88                              name
  89                 raise SfaInvalidArgument(err_string)
  90
  91             users = [Xrn(user, 'user').get_leaf() for user in \
  92                      pis + researchers]
  93             self.shell.auth_manager.create_project(name, project_manager, description, users)
  94
  95         elif type == 'user':
  96             # add person roles, projects and keys
  97             name = Xrn(hrn).get_leaf()
  98             self.shell.auth_manager.create_user(name)
  99             projects = sfa_records.get('slices', [])
 100             for project in projects:
 101                 project_name = Xrn(project).get_leaf()
 102                 self.shell.auth_manager.add_to_project(name, project_name)
 103             keys = sfa_records.get('keys', [])
 104             for key in keys:
 105                 key_dict = {
 106                     'user_id': name,
 107                     'name': name,
 108                     'public': key,
 109                 }
 110                 self.shell.db.key_pair_create(key_dict)
 111
 112         return name
 113
 114     ##########
 115     # xxx actually old_sfa_record comes filled with plc stuff as well in the original code
 116     def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
 117         pointer = old_sfa_record['pointer']
 118         type = old_sfa_record['type']
 119
 120         # new_key implemented for users only
 121         if new_key and type not in [ 'user' ]:
 122             raise UnknownSfaType(type)
 123
 124         elif type == "slice":
 125             # can update description, researchers and PI
 126             pass
 127         elif type == "user":
 128             # can update  slices, keys and roles
 129             pass
 130         return True
 131
 132
 133     ##########
 134     def remove (self, sfa_record):
 135         type=sfa_record['type']
 136         name = Xrn(sfa_record['hrn']).get_leaf()
 137         if type == 'user':
 138             if self.shell.auth_manager.get_user(name):
 139                 self.shell.auth_manager.delete_user(name)
 140         elif type == 'slice':
 141             if self.shell.auth_manager.get_project(name):
 142                 self.shell.auth_manager.delete_project(name)
 143         return True
 144
 145
 146     ####################
 147     def fill_record_info(self, records):
 148         """
 149         Given a (list of) SFA record, fill in the PLC specific
 150         and SFA specific fields in the record.
 151         """
 152         if not isinstance(records, list):
 153             records = [records]
 154
 155         for record in records:
 156             name = Xrn(record['hrn']).get_leaf()
 157             os_record = None
 158             if record['type'] == 'user':
 159                 os_record = self.shell.auth_manager.get_user(name)
 160                 projects = self.shell.db.project_get_by_user(name)
 161                 record['slices'] = [self.hrn + "." + proj.name for \
 162                                     proj in projects]
 163                 record['roles'] = self.shell.db.user_get_roles(name)
 164                 keys = self.shell.db.key_pair_get_all_by_user(name)
 165                 record['keys'] = [key.public_key for key in keys]
 166             elif record['type'] == 'slice':
 167                 os_record = self.shell.auth_manager.get_project(name)
 168                 record['description'] = os_record.description
 169                 record['PI'] = [self.hrn + "." + os_record.project_manager.name]
 170                 record['geni_creator'] = record['PI']
 171                 record['researcher'] = [self.hrn + "." + user for \
 172                                          user in os_record.member_ids]
 173             else:
 174                 continue
 175             record['geni_urn'] = hrn_to_urn(record['hrn'], record['type'])
 176             record['geni_certificate'] = record['gid']
 177             record['name'] = os_record.name
 178             #if os_record.created_at is not None:
 179             #    record['date_created'] = datetime_to_string(utcparse(os_record.created_at))
 180             #if os_record.updated_at is not None:
 181             #    record['last_updated'] = datetime_to_string(utcparse(os_record.updated_at))
 182
 183         return records
 184
 185
 186     ####################
 187     # plcapi works by changes, compute what needs to be added/deleted
 188     def update_relation (self, subject_type, target_type, subject_id, target_ids):
 189         # hard-wire the code for slice/user for now, could be smarter if needed
 190         if subject_type =='slice' and target_type == 'user':
 191             subject=self.shell.project_get(subject_id)[0]
 192             current_target_ids = [user.name for user in subject.members]
 193             add_target_ids = list ( set (target_ids).difference(current_target_ids))
 194             del_target_ids = list ( set (current_target_ids).difference(target_ids))
 195             logger.debug ("subject_id = %s (type=%s)"%(subject_id,type(subject_id)))
 196             for target_id in add_target_ids:
 197                 self.shell.project_add_member(target_id,subject_id)
 198                 logger.debug ("add_target_id = %s (type=%s)"%(target_id,type(target_id)))
 199             for target_id in del_target_ids:
 200                 logger.debug ("del_target_id = %s (type=%s)"%(target_id,type(target_id)))
 201                 self.shell.project_remove_member(target_id, subject_id)
 202         else:
 203             logger.info('unexpected relation to maintain, %s -> %s'%(subject_type,target_type))
 204
 205
 206     ########################################
 207     ########## aggregate oriented
 208     ########################################
 209
 210     def testbed_name (self): return "openstack"
 211
 212     # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
 213     def aggregate_version (self):
 214         version_manager = VersionManager()
 215         ad_rspec_versions = []
 216         request_rspec_versions = []
 217         for rspec_version in version_manager.versions:
 218             if rspec_version.content_type in ['*', 'ad']:
 219                 ad_rspec_versions.append(rspec_version.to_dict())
 220             if rspec_version.content_type in ['*', 'request']:
 221                 request_rspec_versions.append(rspec_version.to_dict())
 222         return {
 223             'testbed':self.testbed_name(),
 224             'geni_request_rspec_versions': request_rspec_versions,
 225             'geni_ad_rspec_versions': ad_rspec_versions,
 226             }
 227
 228     def list_slices (self, creds, options):
 229         # look in cache first
 230         if self.cache:
 231             slices = self.cache.get('slices')
 232             if slices:
 233                 logger.debug("OpenStackDriver.list_slices returns from cache")
 234                 return slices
 235
 236         # get data from db
 237         projs = self.shell.auth_manager.get_projects()
 238         slice_urns = [OSXrn(proj.name, 'slice').urn for proj in projs]
 239
 240         # cache the result
 241         if self.cache:
 242             logger.debug ("OpenStackDriver.list_slices stores value in cache")
 243             self.cache.add('slices', slice_urns)
 244
 245         return slice_urns
 246
 247     # first 2 args are None in case of resource discovery
 248     def list_resources (self, slice_urn, slice_hrn, creds, options):
 249         cached_requested = options.get('cached', True)
 250
 251         version_manager = VersionManager()
 252         # get the rspec's return format from options
 253         rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
 254         version_string = "rspec_%s" % (rspec_version)
 255
 256         #panos adding the info option to the caching key (can be improved)
 257         if options.get('info'):
 258             version_string = version_string + "_"+options.get('info', 'default')
 259
 260         # look in cache first
 261         if cached_requested and self.cache and not slice_hrn:
 262             rspec = self.cache.get(version_string)
 263             if rspec:
 264                 logger.debug("OpenStackDriver.ListResources: returning cached advertisement")
 265                 return rspec
 266
 267         #panos: passing user-defined options
 268         #print "manager options = ",options
 269         aggregate = OSAggregate(self)
 270         rspec =  aggregate.get_rspec(slice_xrn=slice_urn, version=rspec_version,
 271                                      options=options)
 272
 273         # cache the result
 274         if self.cache and not slice_hrn:
 275             logger.debug("OpenStackDriver.ListResources: stores advertisement in cache")
 276             self.cache.add(version_string, rspec)
 277
 278         return rspec
 279
 280     def sliver_status (self, slice_urn, slice_hrn):
 281         # find out where this slice is currently running
 282         project_name = Xrn(slice_urn).get_leaf()
 283         project = self.shell.auth_manager.get_project(project_name)
 284         instances = self.shell.db.instance_get_all_by_project(project_name)
 285         if len(instances) == 0:
 286             raise SliverDoesNotExist("You have not allocated any slivers here")
 287
 288         result = {}
 289         top_level_status = 'unknown'
 290         if instances:
 291             top_level_status = 'ready'
 292         result['geni_urn'] = slice_urn
 293         result['plos_login'] = 'root'
 294         result['plos_expires'] = None
 295
 296         resources = []
 297         for instance in instances:
 298             res = {}
 299             # instances are accessed by ip, not hostname. We need to report the ip
 300             # somewhere so users know where to ssh to.
 301             res['plos_hostname'] = instance.hostname
 302             res['plos_created_at'] = datetime_to_string(utcparse(instance.created_at))
 303             res['plos_boot_state'] = instance.vm_state
 304             res['plos_sliver_type'] = instance.instance_type.name
 305             sliver_id =  Xrn(slice_urn).get_sliver_id(instance.project_id, \
 306                                                       instance.hostname, instance.id)
 307             res['geni_urn'] = sliver_id
 308
 309             if instance.vm_state == 'running':
 310                 res['boot_state'] = 'ready';
 311             else:
 312                 res['boot_state'] = 'unknown'
 313             resources.append(res)
 314
 315         result['geni_status'] = top_level_status
 316         result['geni_resources'] = resources
 317         return result
 318
 319     def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
 320
 321         project_name = get_leaf(slice_hrn)
 322         aggregate = OSAggregate(self)
 323         # parse rspec
 324         rspec = RSpec(rspec_string)
 325
 326         # ensure project and users exist in local db
 327         aggregate.create_project(project_name, users, options=options)
 328
 329         # collect publick keys
 330         pubkeys = []
 331         project_key = None
 332         for user in users:
 333             pubkeys.extend(user['keys'])
 334             # assume first user is the caller and use their context
 335             # for the ec2/euca api connection. Also, use the first users
 336             # key as the project key.
 337             if not project_key:
 338                 username = Xrn(user['urn']).get_leaf()
 339                 user_keys = self.shell.db.key_pair_get_all_by_user(username)
 340                 if user_keys:
 341                     project_key = user_keys[0].name
 342
 343         # ensure person records exists
 344         self.euca_shell.init_context(project_name)
 345         aggregate.run_instances(project_name, rspec_string, project_key, pubkeys)
 346
 347         return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
 348
 349     def delete_sliver (self, slice_urn, slice_hrn, creds, options):
 350         # we need to do this using the context of one of the slice users
 351         project_name = Xrn(slice_urn).get_leaf()
 352         self.euca_shell.init_context(project_name)
 353         name = OSXrn(xrn=slice_urn).name
 354         aggregate = OSAggregate(self)
 355         return aggregate.delete_instances(name)
 356
 357     def update_sliver(self, slice_urn, slice_hrn, rspec, creds, options):
 358         name = OSXrn(xrn=slice_urn).name
 359         aggregate = OSAggregate(self)
 360         return aggregate.update_instances(name)
 361
 362     def renew_sliver (self, slice_urn, slice_hrn, creds, expiration_time, options):
 363         return True
 364
 365     def start_slice (self, slice_urn, slice_hrn, creds):
 366         return 1
 367
 368     def stop_slice (self, slice_urn, slice_hrn, creds):
 369         name = OSXrn(xrn=slice_urn).name
 370         aggregate = OSAggregate(self)
 371         return aggregate.stop_instances(name)
 372
 373     def reset_slice (self, slice_urn, slice_hrn, creds):
 374         raise SfaNotImplemented ("reset_slice not available at this interface")
 375
 376     # xxx this code is quite old and has not run for ages
 377     # it is obviously totally broken and needs a rewrite
 378     def get_ticket (self, slice_urn, slice_hrn, creds, rspec_string, options):
 379         raise SfaNotImplemented,"OpenStackDriver.get_ticket needs a rewrite"
 380 # please keep this code for future reference
 381 #        slices = PlSlices(self)
 382 #        peer = slices.get_peer(slice_hrn)
 383 #        sfa_peer = slices.get_sfa_peer(slice_hrn)
 384 #
 385 #        # get the slice record
 386 #        credential = api.getCredential()
 387 #        interface = api.registries[api.hrn]
 388 #        registry = api.server_proxy(interface, credential)
 389 #        records = registry.Resolve(xrn, credential)
 390 #
 391 #        # make sure we get a local slice record
 392 #        record = None
 393 #        for tmp_record in records:
 394 #            if tmp_record['type'] == 'slice' and \
 395 #               not tmp_record['peer_authority']:
 396 #    #Error (E0602, GetTicket): Undefined variable 'SliceRecord'
 397 #                slice_record = SliceRecord(dict=tmp_record)
 398 #        if not record:
 399 #            raise RecordNotFound(slice_hrn)
 400 #
 401 #        # similar to CreateSliver, we must verify that the required records exist
 402 #        # at this aggregate before we can issue a ticket
 403 #        # parse rspec
 404 #        rspec = RSpec(rspec_string)
 405 #        requested_attributes = rspec.version.get_slice_attributes()
 406 #
 407 #        # ensure site record exists
 408 #        site = slices.verify_site(slice_hrn, slice_record, peer, sfa_peer)
 409 #        # ensure slice record exists
 410 #        slice = slices.verify_slice(slice_hrn, slice_record, peer, sfa_peer)
 411 #        # ensure person records exists
 412 #    # xxx users is undefined in this context
 413 #        persons = slices.verify_persons(slice_hrn, slice, users, peer, sfa_peer)
 414 #        # ensure slice attributes exists
 415 #        slices.verify_slice_attributes(slice, requested_attributes)
 416 #
 417 #        # get sliver info
 418 #        slivers = slices.get_slivers(slice_hrn)
 419 #
 420 #        if not slivers:
 421 #            raise SliverDoesNotExist(slice_hrn)
 422 #
 423 #        # get initscripts
 424 #        initscripts = []
 425 #        data = {
 426 #            'timestamp': int(time.time()),
 427 #            'initscripts': initscripts,
 428 #            'slivers': slivers
 429 #        }
 430 #
 431 #        # create the ticket
 432 #        object_gid = record.get_gid_object()
 433 #        new_ticket = SfaTicket(subject = object_gid.get_subject())
 434 #        new_ticket.set_gid_caller(api.auth.client_gid)
 435 #        new_ticket.set_gid_object(object_gid)
 436 #        new_ticket.set_issuer(key=api.key, subject=self.hrn)
 437 #        new_ticket.set_pubkey(object_gid.get_pubkey())
 438 #        new_ticket.set_attributes(data)
 439 #        new_ticket.set_rspec(rspec)
 440 #        #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
 441 #        new_ticket.encode()
 442 #        new_ticket.sign()
 443 #
 444 #        return new_ticket.save_to_string(save_parents=True)