sfa/plc/slices.py

   1 ### $Id$
   2 ### $URL$
   3
   4 import datetime
   5 import time
   6 import traceback
   7 import sys
   8
   9 from types import StringTypes
  10 from sfa.util.namespace import *
  11 from sfa.util.rspec import *
  12 from sfa.util.specdict import *
  13 from sfa.util.faults import *
  14 from sfa.util.storage import *
  15 from sfa.util.record import SfaRecord
  16 from sfa.util.policy import Policy
  17 from sfa.util.prefixTree import prefixTree
  18 from sfa.util.debug import log
  19
  20 MAXINT =  2L**31-1
  21
  22 class Slices(SimpleStorage):
  23
  24     rspec_to_slice_tag = {'max_rate':'net_max_rate'}
  25
  26     def __init__(self, api, ttl = .5, origin_hrn=None):
  27         self.api = api
  28         self.ttl = ttl
  29         self.threshold = None
  30         path = self.api.config.SFA_DATA_DIR
  31         filename = ".".join([self.api.interface, self.api.hrn, "slices"])
  32         filepath = path + os.sep + filename
  33         self.slices_file = filepath
  34         SimpleStorage.__init__(self, self.slices_file)
  35         self.policy = Policy(self.api)
  36         self.load()
  37         self.origin_hrn = origin_hrn
  38
  39     def get_slivers(self, xrn, node=None):
  40         hrn, type = urn_to_hrn(xrn)
  41
  42         slice_name = hrn_to_pl_slicename(hrn)
  43         # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
  44         # of doing all of this?
  45         #return self.api.GetSliceTicket(self.auth, slice_name)
  46
  47         # from PLCAPI.GetSlivers.get_slivers()
  48         slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
  49         slices = self.api.plshell.GetSlices(self.api.plauth, slice_name, slice_fields)
  50         # Build up list of users and slice attributes
  51         person_ids = set()
  52         all_slice_tag_ids = set()
  53         for slice in slices:
  54             person_ids.update(slice['person_ids'])
  55             all_slice_tag_ids.update(slice['slice_tag_ids'])
  56         person_ids = list(person_ids)
  57         all_slice_tag_ids = list(all_slice_tag_ids)
  58         # Get user information
  59         all_persons_list = self.api.plshell.GetPersons(self.api.plauth, {'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
  60         all_persons = {}
  61         for person in all_persons_list:
  62             all_persons[person['person_id']] = person
  63
  64         # Build up list of keys
  65         key_ids = set()
  66         for person in all_persons.values():
  67             key_ids.update(person['key_ids'])
  68         key_ids = list(key_ids)
  69         # Get user account keys
  70         all_keys_list = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key_id', 'key', 'key_type'])
  71         all_keys = {}
  72         for key in all_keys_list:
  73             all_keys[key['key_id']] = key
  74         # Get slice attributes
  75         all_slice_tags_list = self.api.plshell.GetSliceTags(self.api.plauth, all_slice_tag_ids)
  76         all_slice_tags = {}
  77         for slice_tag in all_slice_tags_list:
  78             all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
  79
  80         slivers = []
  81         for slice in slices:
  82             keys = []
  83             for person_id in slice['person_ids']:
  84                 if person_id in all_persons:
  85                     person = all_persons[person_id]
  86                     if not person['enabled']:
  87                         continue
  88                     for key_id in person['key_ids']:
  89                         if key_id in all_keys:
  90                             key = all_keys[key_id]
  91                             keys += [{'key_type': key['key_type'],
  92                                     'key': key['key']}]
  93             attributes = []
  94             # All (per-node and global) attributes for this slice
  95             slice_tags = []
  96             for slice_tag_id in slice['slice_tag_ids']:
  97                 if slice_tag_id in all_slice_tags:
  98                     slice_tags.append(all_slice_tags[slice_tag_id])
  99             # Per-node sliver attributes take precedence over global
 100             # slice attributes, so set them first.
 101             # Then comes nodegroup slice attributes
 102             # Followed by global slice attributes
 103             sliver_attributes = []
 104
 105             if node is not None:
 106                 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
 107                     sliver_attributes.append(sliver_attribute['tagname'])
 108                     attributes.append({'tagname': sliver_attribute['tagname'],
 109                                     'value': sliver_attribute['value']})
 110
 111             # set nodegroup slice attributes
 112             for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
 113                 # Do not set any nodegroup slice attributes for
 114                 # which there is at least one sliver attribute
 115                 # already set.
 116                 if slice_tag not in slice_tags:
 117                     attributes.append({'tagname': slice_tag['tagname'],
 118                         'value': slice_tag['value']})
 119
 120             for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
 121                 # Do not set any global slice attributes for
 122                 # which there is at least one sliver attribute
 123                 # already set.
 124                 if slice_tag['tagname'] not in sliver_attributes:
 125                     attributes.append({'tagname': slice_tag['tagname'],
 126                                    'value': slice_tag['value']})
 127
 128             # XXX Sanity check; though technically this should be a system invariant
 129             # checked with an assertion
 130             if slice['expires'] > MAXINT:  slice['expires']= MAXINT
 131
 132             slivers.append({
 133                 'hrn': hrn,
 134                 'name': slice['name'],
 135                 'slice_id': slice['slice_id'],
 136                 'instantiation': slice['instantiation'],
 137                 'expires': slice['expires'],
 138                 'keys': keys,
 139                 'attributes': attributes
 140             })
 141
 142         return slivers
 143
 144     def get_peer(self, xrn):
 145         hrn, type = urn_to_hrn(xrn)
 146         # Becaues of myplc federation,  we first need to determine if this
 147         # slice belongs to out local plc or a myplc peer. We will assume it
 148         # is a local site, unless we find out otherwise
 149         peer = None
 150
 151         # get this slice's authority (site)
 152         slice_authority = get_authority(hrn)
 153
 154         # get this site's authority (sfa root authority or sub authority)
 155         site_authority = get_authority(slice_authority).lower()
 156
 157         # check if we are already peered with this site_authority, if so
 158         peers = self.api.plshell.GetPeers(self.api.plauth, {}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
 159         for peer_record in peers:
 160             names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
 161             if site_authority in names:
 162                 peer = peer_record['shortname']
 163
 164         return peer
 165
 166     def get_sfa_peer(self, xrn):
 167         hrn, type = urn_to_hrn(xrn)
 168
 169         # return the authority for this hrn or None if we are the authority
 170         sfa_peer = None
 171         slice_authority = get_authority(hrn)
 172         site_authority = get_authority(slice_authority)
 173
 174         if site_authority != self.api.hrn:
 175             sfa_peer = site_authority
 176
 177         return sfa_peer
 178
 179     def refresh(self):
 180         """
 181         Update the cached list of slices
 182         """
 183         # Reload components list
 184         now = datetime.datetime.now()
 185         if not self.has_key('threshold') or not self.has_key('timestamp') or \
 186            now > datetime.datetime.fromtimestamp(time.mktime(time.strptime(self['threshold'], self.api.time_format))):
 187             if self.api.interface in ['aggregate']:
 188                 self.refresh_slices_aggregate()
 189             elif self.api.interface in ['slicemgr']:
 190                 self.refresh_slices_smgr()
 191
 192     def refresh_slices_aggregate(self):
 193         slices = self.api.plshell.GetSlices(self.api.plauth, {'peer_id': None}, ['name'])
 194         slice_hrns = [slicename_to_hrn(self.api.hrn, slice['name']) for slice in slices]
 195
 196          # update timestamp and threshold
 197         timestamp = datetime.datetime.now()
 198         hr_timestamp = timestamp.strftime(self.api.time_format)
 199         delta = datetime.timedelta(hours=self.ttl)
 200         threshold = timestamp + delta
 201         hr_threshold = threshold.strftime(self.api.time_format)
 202
 203         slice_details = {'hrn': slice_hrns,
 204                          'timestamp': hr_timestamp,
 205                          'threshold': hr_threshold
 206                         }
 207         self.update(slice_details)
 208         self.write()
 209
 210
 211     def refresh_slices_smgr(self):
 212         slice_hrns = []
 213         credential = self.api.getCredential()
 214         for aggregate in self.api.aggregates:
 215             success = False
 216             try:
 217                 slices = self.api.aggregates[aggregate].get_slices(credential)
 218                 slice_hrns.extend(slices)
 219                 success = True
 220             except:
 221                 print >> log, "%s" % (traceback.format_exc())
 222                 print >> log, "Error calling slices at aggregate %(aggregate)s" % locals()
 223
 224         # update timestamp and threshold
 225         timestamp = datetime.datetime.now()
 226         hr_timestamp = timestamp.strftime(self.api.time_format)
 227         delta = datetime.timedelta(hours=self.ttl)
 228         threshold = timestamp + delta
 229         hr_threshold = threshold.strftime(self.api.time_format)
 230
 231         slice_details = {'hrn': slice_hrns,
 232                          'timestamp': hr_timestamp,
 233                          'threshold': hr_threshold
 234                         }
 235         self.update(slice_details)
 236         self.write()
 237
 238
 239     def verify_site(self, registry, credential, slice_hrn, peer, sfa_peer):
 240         authority = get_authority(slice_hrn)
 241         authority_urn = hrn_to_urn(authority, 'authority')
 242         site_records = registry.resolve(credential, authority_urn)
 243
 244         site = {}
 245         for site_record in site_records:
 246             if site_record['type'] == 'authority':
 247                 site = site_record
 248         if not site:
 249             raise RecordNotFound(authority)
 250         remote_site_id = site.pop('site_id')
 251
 252         login_base = get_leaf(authority)
 253         sites = self.api.plshell.GetSites(self.api.plauth, login_base)
 254         if not sites:
 255             site_id = self.api.plshell.AddSite(self.api.plauth, site)
 256             if peer:
 257                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
 258             # mark this site as an sfa peer record
 259             if sfa_peer:
 260                 peer_dict = {'type': 'authority', 'hrn': authority, 'peer_authority': sfa_peer, 'pointer': site_id}
 261                 registry.register_peer_object(credential, peer_dict)
 262         else:
 263             site_id = sites[0]['site_id']
 264             remote_site_id = sites[0]['peer_site_id']
 265             old_site = sites[0]
 266             #the site is alredy on the remote agg. Let us update(e.g. max_slices field) it with the latest info.
 267             self.sync_site(old_site, site, peer)
 268
 269
 270         return (site_id, remote_site_id)
 271
 272     def verify_slice(self, registry, credential, slice_hrn, site_id, remote_site_id, peer, sfa_peer):
 273         slice = {}
 274         slice_record = None
 275         authority = get_authority(slice_hrn)
 276         slice_records = registry.resolve(credential, slice_hrn)
 277
 278         for record in slice_records:
 279             if record['type'] in ['slice']:
 280                 slice_record = record
 281         if not slice_record:
 282             raise RecordNotFound(hrn)
 283         slicename = hrn_to_pl_slicename(slice_hrn)
 284         parts = slicename.split("_")
 285         login_base = parts[0]
 286         slices = self.api.plshell.GetSlices(self.api.plauth, [slicename])
 287         if not slices:
 288             slice_fields = {}
 289             slice_keys = ['name', 'url', 'description']
 290             for key in slice_keys:
 291                 if key in slice_record and slice_record[key]:
 292                     slice_fields[key] = slice_record[key]
 293
 294             # add the slice
 295             slice_id = self.api.plshell.AddSlice(self.api.plauth, slice_fields)
 296             slice = slice_fields
 297             slice['slice_id'] = slice_id
 298
 299             # mark this slice as an sfa peer record
 300             if sfa_peer:
 301                 peer_dict = {'type': 'slice', 'hrn': slice_hrn, 'peer_authority': sfa_peer, 'pointer': slice_id}
 302                 registry.register_peer_object(credential, peer_dict)
 303
 304             #this belongs to a peer
 305             if peer:
 306                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice_id, peer, slice_record['pointer'])
 307             slice['node_ids'] = []
 308         else:
 309             slice = slices[0]
 310             slice_id = slice['slice_id']
 311             site_id = slice['site_id']
 312             #the slice is alredy on the remote agg. Let us update(e.g. expires field) it with the latest info.
 313             self.sync_slice(slice, slice_record, peer)
 314
 315         slice['peer_slice_id'] = slice_record['pointer']
 316         self.verify_persons(registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer)
 317
 318         return slice
 319
 320     def verify_persons(self, registry, credential, slice_record, site_id, remote_site_id, peer, sfa_peer):
 321         # get the list of valid slice users from the registry and make
 322         # sure they are added to the slice
 323         slicename = hrn_to_pl_slicename(slice_record['hrn'])
 324         researchers = slice_record.get('researcher', [])
 325         for researcher in researchers:
 326             person_record = {}
 327             person_records = registry.resolve(credential, researcher)
 328             for record in person_records:
 329                 if record['type'] in ['user'] and record['enabled']:
 330                     person_record = record
 331             if not person_record:
 332                 return 1
 333             person_dict = person_record
 334             local_person=False
 335             if peer:
 336                 peer_id = self.api.plshell.GetPeers(self.api.plauth, {'shortname': peer}, ['peer_id'])[0]['peer_id']
 337                 persons = self.api.plshell.GetPersons(self.api.plauth, {'email': [person_dict['email']], 'peer_id': peer_id}, ['person_id', 'key_ids'])
 338                 if not persons:
 339                     persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
 340                     if persons:
 341                        local_person=True
 342
 343             else:
 344                 persons = self.api.plshell.GetPersons(self.api.plauth, [person_dict['email']], ['person_id', 'key_ids'])
 345
 346             if not persons:
 347                 person_id=self.api.plshell.AddPerson(self.api.plauth, person_dict)
 348                 self.api.plshell.UpdatePerson(self.api.plauth, person_id, {'enabled' : True})
 349
 350                 # mark this person as an sfa peer record
 351                 if sfa_peer:
 352                     peer_dict = {'type': 'user', 'hrn': researcher, 'peer_authority': sfa_peer, 'pointer': person_id}
 353                     registry.register_peer_object(credential, peer_dict)
 354
 355                 if peer:
 356                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 357                 key_ids = []
 358             else:
 359                 person_id = persons[0]['person_id']
 360                 key_ids = persons[0]['key_ids']
 361
 362
 363             # if this is a peer person, we must unbind them from the peer or PLCAPI will throw
 364             # an error
 365             if peer:
 366                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
 367                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', site_id,  peer)
 368
 369             self.api.plshell.AddPersonToSlice(self.api.plauth, person_dict['email'], slicename)
 370             self.api.plshell.AddPersonToSite(self.api.plauth, person_dict['email'], site_id)
 371             if peer and not local_person:
 372                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 373             if peer:
 374                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', site_id, peer, remote_site_id)
 375
 376             self.verify_keys(registry, credential, person_dict, key_ids, person_id, peer, local_person)
 377
 378     def verify_keys(self, registry, credential, person_dict, key_ids, person_id,  peer, local_person):
 379         keylist = self.api.plshell.GetKeys(self.api.plauth, key_ids, ['key'])
 380         keys = [key['key'] for key in keylist]
 381
 382         #add keys that arent already there
 383         key_ids = person_dict['key_ids']
 384         for personkey in person_dict['keys']:
 385             if personkey not in keys:
 386                 key = {'key_type': 'ssh', 'key': personkey}
 387                 if peer:
 388                     self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'person', person_id, peer)
 389                 key_id = self.api.plshell.AddPersonKey(self.api.plauth, person_dict['email'], key)
 390                 if peer and not local_person:
 391                     self.api.plshell.BindObjectToPeer(self.api.plauth, 'person', person_id, peer, person_dict['pointer'])
 392                 if peer:
 393                     try: self.api.plshell.BindObjectToPeer(self.api.plauth, 'key', key_id, peer, key_ids.pop(0))
 394
 395                     except: pass
 396
 397     def create_slice_aggregate(self, xrn, rspec):
 398         hrn, type = urn_to_hrn(xrn)
 399         # Determine if this is a peer slice
 400         peer = self.get_peer(hrn)
 401         sfa_peer = self.get_sfa_peer(hrn)
 402
 403         spec = RSpec(rspec)
 404         # Get the slice record from sfa
 405         slicename = hrn_to_pl_slicename(hrn)
 406         slice = {}
 407         slice_record = None
 408         registry = self.api.registries[self.api.hrn]
 409         credential = self.api.getCredential()
 410
 411         site_id, remote_site_id = self.verify_site(registry, credential, hrn, peer, sfa_peer)
 412         slice = self.verify_slice(registry, credential, hrn, site_id, remote_site_id, peer, sfa_peer)
 413
 414         # find out where this slice is currently running
 415         nodelist = self.api.plshell.GetNodes(self.api.plauth, slice['node_ids'], ['hostname'])
 416         hostnames = [node['hostname'] for node in nodelist]
 417
 418         # get netspec details
 419         nodespecs = spec.getDictsByTagName('NodeSpec')
 420
 421         # dict in which to store slice attributes to set for the nodes
 422         nodes = {}
 423         for nodespec in nodespecs:
 424             if isinstance(nodespec['name'], list):
 425                 for nodename in nodespec['name']:
 426                     nodes[nodename] = {}
 427                     for k in nodespec.keys():
 428                         rspec_attribute_value = nodespec[k]
 429                         if (self.rspec_to_slice_tag.has_key(k)):
 430                             slice_tag_name = self.rspec_to_slice_tag[k]
 431                             nodes[nodename][slice_tag_name] = rspec_attribute_value
 432             elif isinstance(nodespec['name'], StringTypes):
 433                 nodename = nodespec['name']
 434                 nodes[nodename] = {}
 435                 for k in nodespec.keys():
 436                     rspec_attribute_value = nodespec[k]
 437                     if (self.rspec_to_slice_tag.has_key(k)):
 438                         slice_tag_name = self.rspec_to_slice_tag[k]
 439                         nodes[nodename][slice_tag_name] = rspec_attribute_value
 440
 441                 for k in nodespec.keys():
 442                     rspec_attribute_value = nodespec[k]
 443                     if (self.rspec_to_slice_tag.has_key(k)):
 444                         slice_tag_name = self.rspec_to_slice_tag[k]
 445                         nodes[nodename][slice_tag_name] = rspec_attribute_value
 446
 447         node_names = nodes.keys()
 448         # remove nodes not in rspec
 449         deleted_nodes = list(set(hostnames).difference(node_names))
 450         # add nodes from rspec
 451         added_nodes = list(set(node_names).difference(hostnames))
 452
 453         if peer:
 454             self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', slice['slice_id'], peer)
 455
 456         self.api.plshell.AddSliceToNodes(self.api.plauth, slicename, added_nodes)
 457
 458         # Add recognized slice tags
 459         for node_name in node_names:
 460             node = nodes[node_name]
 461             for slice_tag in node.keys():
 462                 value = node[slice_tag]
 463                 if (isinstance(value, list)):
 464                     value = value[0]
 465
 466                 self.api.plshell.AddSliceTag(self.api.plauth, slicename, slice_tag, value, node_name)
 467
 468         self.api.plshell.DeleteSliceFromNodes(self.api.plauth, slicename, deleted_nodes)
 469         if peer:
 470             self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', slice['slice_id'], peer, slice['peer_slice_id'])
 471
 472         return 1
 473
 474     def sync_site(self, old_record, new_record, peer):
 475         if old_record['max_slices'] != new_record['max_slices'] or old_record['max_slivers'] != new_record['max_slivers']:
 476             if peer:
 477                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'site', old_record['site_id'], peer)
 478             if old_record['max_slices'] != new_record['max_slices']:
 479                 self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slices' : new_record['max_slices']})
 480             if old_record['max_slivers'] != new_record['max_slivers']:
 481                 self.api.plshell.UpdateSite(self.api.plauth, old_record['site_id'], {'max_slivers' : new_record['max_slivers']})
 482             if peer:
 483                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'site', old_record['site_id'], peer, old_record['peer_site_id'])
 484         return 1
 485
 486     def sync_slice(self, old_record, new_record, peer):
 487         if old_record['expires'] != new_record['expires']:
 488             if peer:
 489                 self.api.plshell.UnBindObjectFromPeer(self.api.plauth, 'slice', old_record['slice_id'], peer)
 490             self.api.plshell.UpdateSlice(self.api.plauth, old_record['slice_id'], {'expires' : new_record['expires']})
 491             if peer:
 492                 self.api.plshell.BindObjectToPeer(self.api.plauth, 'slice', old_record['slice_id'], peer, old_record['peer_slice_id'])
 493         return 1