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