1 from types import StringTypes
2 from collections import defaultdict
4 from sfa.util.sfatime import utcparse, datetime_to_epoch
5 from sfa.util.sfalogging import logger
6 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
7 from sfa.planetlab.plxrn import PlXrn
9 from sfa.rspecs.rspec import RSpec
11 from sfa.planetlab.vlink import VLink
12 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname, top_auth, hash_loginbase
20 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
22 def __init__(self, driver):
25 def get_slivers(self, xrn, node=None):
26 hrn, type = urn_to_hrn(xrn)
28 slice_name = hrn_to_pl_slicename(hrn)
29 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
30 # of doing all of this?
31 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
33 # from PLCAPI.GetSlivers.get_slivers()
34 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
35 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
36 # Build up list of users and slice attributes
38 all_slice_tag_ids = set()
40 person_ids.update(slice['person_ids'])
41 all_slice_tag_ids.update(slice['slice_tag_ids'])
42 person_ids = list(person_ids)
43 all_slice_tag_ids = list(all_slice_tag_ids)
44 # Get user information
45 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
47 for person in all_persons_list:
48 all_persons[person['person_id']] = person
50 # Build up list of keys
52 for person in all_persons.values():
53 key_ids.update(person['key_ids'])
54 key_ids = list(key_ids)
55 # Get user account keys
56 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
58 for key in all_keys_list:
59 all_keys[key['key_id']] = key
60 # Get slice attributes
61 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
63 for slice_tag in all_slice_tags_list:
64 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
69 for person_id in slice['person_ids']:
70 if person_id in all_persons:
71 person = all_persons[person_id]
72 if not person['enabled']:
74 for key_id in person['key_ids']:
75 if key_id in all_keys:
76 key = all_keys[key_id]
77 keys += [{'key_type': key['key_type'],
80 # All (per-node and global) attributes for this slice
82 for slice_tag_id in slice['slice_tag_ids']:
83 if slice_tag_id in all_slice_tags:
84 slice_tags.append(all_slice_tags[slice_tag_id])
85 # Per-node sliver attributes take precedence over global
86 # slice attributes, so set them first.
87 # Then comes nodegroup slice attributes
88 # Followed by global slice attributes
89 sliver_attributes = []
92 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
93 sliver_attributes.append(sliver_attribute['tagname'])
94 attributes.append({'tagname': sliver_attribute['tagname'],
95 'value': sliver_attribute['value']})
97 # set nodegroup slice attributes
98 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
99 # Do not set any nodegroup slice attributes for
100 # which there is at least one sliver attribute
102 if slice_tag not in slice_tags:
103 attributes.append({'tagname': slice_tag['tagname'],
104 'value': slice_tag['value']})
106 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
107 # Do not set any global slice attributes for
108 # which there is at least one sliver attribute
110 if slice_tag['tagname'] not in sliver_attributes:
111 attributes.append({'tagname': slice_tag['tagname'],
112 'value': slice_tag['value']})
114 # XXX Sanity check; though technically this should be a system invariant
115 # checked with an assertion
116 if slice['expires'] > MAXINT: slice['expires']= MAXINT
120 'name': slice['name'],
121 'slice_id': slice['slice_id'],
122 'instantiation': slice['instantiation'],
123 'expires': slice['expires'],
125 'attributes': attributes
130 def get_peer(self, xrn):
131 hrn, type = urn_to_hrn(xrn)
132 # Becaues of myplc federation, we first need to determine if this
133 # slice belongs to out local plc or a myplc peer. We will assume it
134 # is a local site, unless we find out otherwise
137 # get this slice's authority (site)
138 slice_authority = get_authority(hrn)
140 # get this site's authority (sfa root authority or sub authority)
141 site_authority = get_authority(slice_authority).lower()
143 # check if we are already peered with this site_authority, if so
144 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
145 for peer_record in peers:
146 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
147 if site_authority in names:
152 def get_sfa_peer(self, xrn):
153 hrn, type = urn_to_hrn(xrn)
155 # return the authority for this hrn or None if we are the authority
157 slice_authority = get_authority(hrn)
158 site_authority = get_authority(slice_authority)
160 if site_authority != self.driver.hrn:
161 sfa_peer = site_authority
165 def verify_slice_leases(self, slice, rspec_requested_leases, peer):
167 leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
168 grain = self.driver.shell.GetLeaseGranularity()
170 requested_leases = []
171 for lease in rspec_requested_leases:
173 slice_hrn, _ = urn_to_hrn(lease['slice_id'])
175 top_auth_hrn = top_auth(slice_hrn)
176 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
177 slice_part = slice_hrn.split('.')[-1]
178 if top_auth_hrn == self.driver.hrn:
179 login_base = slice_hrn.split('.')[-2][:12]
181 login_base = hash_loginbase(site_hrn)
183 slice_name = '_'.join([login_base, slice_part])
185 if slice_name != slice['name']:
187 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
190 hostname = xrn_to_hostname(lease['component_id'])
191 # fill the requested node with nitos ids
192 requested_lease['name'] = slice['name']
193 requested_lease['hostname'] = hostname
194 requested_lease['t_from'] = int(lease['start_time'])
195 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
196 requested_leases.append(requested_lease)
200 # prepare actual slice leases by lease_id
203 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
204 't_from': lease['t_from'], 't_until': lease['t_until']}
208 deleted_leases_id = []
209 for lease_id in leases_by_id:
210 if leases_by_id[lease_id] not in requested_leases:
211 deleted_leases_id.append(lease_id)
213 kept_leases_id.append(lease_id)
214 requested_leases.remove(leases_by_id[lease_id])
215 added_leases = requested_leases
220 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
221 self.driver.shell.DeleteLeases(deleted_leases_id)
222 for lease in added_leases:
223 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
226 logger.log_exc('Failed to add/remove slice leases')
231 def verify_slice_nodes(self, slice, slivers, peer):
233 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
234 current_slivers = [node['hostname'] for node in nodes]
236 requested_slivers = []
240 if node.get('component_name'):
241 hostname = node.get('component_name').strip()
242 elif node.get('component_id'):
243 hostname = xrn_to_hostname(node.get('component_id').strip())
244 if node.get('client_id'):
245 tags.append({'slicename': slice['name'],
246 'tagname': 'client_id',
247 'value': node['client_id'],
250 requested_slivers.append(hostname)
252 # remove nodes not in rspec
253 deleted_nodes = list(set(current_slivers).difference(requested_slivers))
255 # add nodes from rspec
256 added_nodes = list(set(requested_slivers).difference(current_slivers))
260 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
261 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
262 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
265 logger.log_exc('Failed to add/remove slice from nodes')
270 self.driver.shell.AddSliceTag(tag['slicename'], tag['tagname'], tag['value'], tag['node'])
272 logger.log_exc('Failed to add slice tag')
275 def free_egre_key(self):
277 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
278 used.add(int(tag['value']))
280 for i in range(1, 256):
285 raise KeyError("No more EGRE keys available")
289 def verify_slice_links(self, slice, requested_links, nodes):
290 # nodes is undefined here
291 if not requested_links:
294 # build dict of nodes
298 nodes_dict[node['node_id']] = node
299 interface_ids.extend(node['interface_ids'])
300 # build dict of interfaces
301 interfaces = self.driver.shell.GetInterfaces(interface_ids)
303 for interface in interfaces:
304 interfaces_dict[interface['interface_id']] = interface
309 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
312 slice_tags.append({'name': 'netns', 'value': '1'})
315 # need to update the attribute string?
316 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
318 for link in requested_links:
319 # get the ip address of the first node in the link
320 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
321 (node_raw, device) = ifname1.split(':')
322 node_id = int(node_raw.replace('node', ''))
323 node = nodes_dict[node_id]
324 if1 = interfaces_dict[node['interface_ids'][0]]
326 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
328 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
330 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
331 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
333 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
337 def handle_peer(self, site, slice, persons, peer):
342 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
344 self.driver.shell.DeleteSite(site['site_id'])
350 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
352 self.driver.shell.DeleteSlice(slice['slice_id'])
356 for person in persons:
358 self.driver.shell.BindObjectToPeer('person',
359 person['person_id'], peer['shortname'], person['peer_person_id'])
361 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
363 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
365 self.driver.shell.DeleteKey(key['key_id'])
366 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
368 self.driver.shell.DeletePerson(person['person_id'])
373 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
374 #(slice_hrn, type) = urn_to_hrn(slice_xrn)
375 #top_auth_hrn = top_auth(slice_hrn)
376 #site_hrn = '.'.join(slice_hrn.split('.')[:-1])
377 #if top_auth_hrn == self.driver.hrn:
378 # login_base = slice_hrn.split('.')[-2][:12]
380 # login_base = hash_loginbase(site_hrn)
383 # filter sites by hrn
386 plxrn = PlXrn(xrn=slice_xrn)
387 slice_hrn = plxrn.get_hrn()
388 type = plxrn.get_type()
389 site_hrn = plxrn.get_authority_hrn()
390 authority_name = plxrn.pl_authname()
391 slicename = plxrn.pl_slicename()
392 login_base = plxrn.pl_login_base()
393 sites = self.driver.shell.GetSites({'peer_id': None},['site_id','name','abbreviated_name','login_base','hrn'])
394 site_exists = [site for site in sites if site['hrn'] == site_hrn]
396 # create new site record
397 site = {'name': 'sfa:%s' % site_hrn,
398 'abbreviated_name': site_hrn,
399 'login_base': login_base,
403 'peer_site_id': None}
405 site['site_id'] = self.driver.shell.AddSite(site)
407 self.driver.shell.SetSiteHrn(int(site['site_id']), site_hrn)
408 # Tag this as created through SFA
409 self.driver.shell.SetSiteSfaCreated(int(site['site_id']), 'True')
410 # exempt federated sites from monitor policies
411 self.driver.shell.AddSiteTag(int(site['site_id']), 'exempt_site_until', "20200101")
414 site = site_exists[0]
418 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
419 #top_auth_hrn = top_auth(slice_hrn)
420 #site_hrn = '.'.join(slice_hrn.split('.')[:-1])
421 #slice_part = slice_hrn.split('.')[-1]
422 #if top_auth_hrn == self.driver.hrn:
423 # login_base = slice_hrn.split('.')[-2][:12]
425 # login_base = hash_loginbase(site_hrn)
428 #slice_name = '_'.join([login_base, slice_part])
429 plxrn = PlXrn(xrn=slice_xrn)
430 slice_hrn = plxrn.get_hrn()
431 type = plxrn.get_type()
432 site_hrn = plxrn.get_authority_hrn()
433 authority_name = plxrn.pl_authname()
434 slicename = plxrn.pl_slicename()
435 login_base = plxrn.pl_login_base()
437 slices = self.driver.shell.GetSlices({'peer_id': None},['slice_id','name','hrn'])
438 # Filter slices by HRN
439 slice_exists = [slice for slice in slices if slice['hrn'] == slice_hrn]
441 slice = {'name': slice_name,
442 'url': slice_record.get('url', slice_hrn),
443 'description': slice_record.get('description', slice_hrn)}
445 slice['slice_id'] = self.driver.shell.AddSlice(slice)
447 self.driver.shell.SetSliceHrn(int(slice['slice_id']), slice_hrn)
448 # Tag this as created through SFA
449 self.driver.shell.SetSliceSfaCreated(int(slice['slice_id']), 'True')
452 slice = slice_exists[0]
453 if slice_record and slice_record.get('expires'):
454 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
455 if requested_expires and slice['expires'] != requested_expires:
456 self.driver.shell.UpdateSlice( int(slice['slice_id']), {'expires' : requested_expires})
458 return self.driver.shell.GetSlices(int(slice['slice_id']))[0]
460 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
461 top_auth_hrn = top_auth(slice_hrn)
462 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
463 slice_part = slice_hrn.split('.')[-1]
466 user['hrn'], _ = urn_to_hrn(user['urn'])
467 users_by_hrn[user['hrn']] = user
469 if top_auth_hrn == self.driver.hrn:
470 login_base = slice_hrn.split('.')[-2][:12]
472 login_base = hash_loginbase(site_hrn)
474 slice_name = '_'.join([login_base, slice_part])
476 persons = self.driver.shell.GetPersons({'peer_id': None},['person_id','email','hrn'])
477 site = self.driver.shell.GetSites({'peer_id': None, 'login_base': login_base})[0]
478 slice = self.driver.shell.GetSlices({'peer_id': None, 'name': slice_name})[0]
479 slice_persons = self.driver.shell.GetPersons({'peer_id': None, 'person_id': slice['person_ids']},['person_id','email','hrn'])
482 persons_by_email = {}
483 for person in persons:
484 persons_by_hrn[person['hrn']] = person
485 persons_by_email[person['email']] = person
486 slice_persons_by_hrn = {}
487 for slice_person in slice_persons:
488 slice_persons_by_hrn[slice_person['hrn']] = slice_person
490 # sort persons by HRN
491 persons_to_add = set(users_by_hrn.keys()).difference(slice_persons_by_hrn.keys())
492 persons_to_delete = set(slice_persons_by_hrn.keys()).difference(users_by_hrn.keys())
493 persons_to_keep = set(users_by_hrn.keys()).intersection(slice_persons_by_hrn.keys())
496 persons_to_verify_keys = {}
498 # Add persons or add persons to slice
499 for person_hrn in persons_to_add:
500 person_email = users_by_hrn[person_hrn].get('email', None)
501 if person_email and person_email in persons_by_email.keys():
502 # check if the user already exist in PL
503 person_id = persons_by_email[person_email]['person_id']
504 self.driver.shell.AddPersonToSlice(person_id, slice['slice_id'])
505 persons_to_verify_keys[person_id] = users_by_hrn[person_hrn]
509 'first_name': person_hrn,
510 'last_name': person_hrn,
511 'email': users_by_hrn[person_hrn].get('email', "%s@geni.net"%person_hrn.split('.')[-1]),
515 person_id = self.driver.shell.AddPerson(person)
516 self.driver.shell.AddRoleToPerson('user', int(person_id))
518 self.driver.shell.UpdatePerson(int(person_id), {'enabled': True})
519 self.driver.shell.SetPersonHrn(int(person_id), person_hrn)
520 self.driver.shell.SetPersonSfaCreated(int(person_id), 'True')
521 self.driver.shell.AddPersonToSite(int(person_id), site['site_id'])
522 self.driver.shell.AddPersonToSlice(int(person_id), slice['slice_id'])
525 for key in users_by_hrn[person_hrn].get('keys', []):
526 key = {'key':key, 'key_type':'ssh'}
527 self.driver.shell.AddPersonKey(person_id, key)
530 # Delete persons from slice
531 for person_hrn in persons_to_delete:
532 person_id = slice_persons_by_hrn[person_hrn].get('person_id')
533 slice_id = slice['slice_id']
534 self.driver.shell.DeletePersonFromSlice(person_id, slice_id)
537 # Update kept persons
538 for person_hrn in persons_to_keep:
539 person_id = slice_persons_by_hrn[person_hrn].get('person_id')
540 persons_to_verify_keys[person_id] = users_by_hrn[person_hrn]
542 self.verify_keys(persons_to_verify_keys, peer, options)
544 return persons_to_add
547 def verify_keys(self, persons_to_verify_keys, peer, options={}):
548 # we only add keys that comes from sfa to persons in PL
549 for person_id in persons_to_verify_keys:
550 person_sfa_keys = persons_to_verify_keys[person_id].get('keys', [])
551 person_pl_keys = self.driver.shell.GetKeys({'person_id': int(person_id)})
552 person_pl_keys_list = [key['key'] for key in person_pl_keys]
554 keys_to_add = set(person_sfa_keys).difference(person_pl_keys_list)
556 for key_string in keys_to_add:
557 key = {'key': key_string, 'key_type': 'ssh'}
558 self.driver.shell.AddPersonKey(int(person_id), key)
561 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
562 append = options.get('append', True)
563 # get list of attributes users ar able to manage
564 filter = {'category': '*slice*'}
566 filter['|roles'] = ['user']
567 slice_attributes = self.driver.shell.GetTagTypes(filter)
568 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
570 # get sliver attributes
571 added_slice_attributes = []
572 removed_slice_attributes = []
573 # we need to keep the slice hrn anyway
574 ignored_slice_attribute_names = ['hrn']
575 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
577 # get attributes that should be removed
578 for slice_tag in existing_slice_attributes:
579 if slice_tag['tagname'] in ignored_slice_attribute_names:
580 # If a slice already has a admin only role it was probably given to them by an
581 # admin, so we should ignore it.
582 ignored_slice_attribute_names.append(slice_tag['tagname'])
585 # If an existing slice attribute was not found in the request it should
587 attribute_found=False
588 for requested_attribute in requested_slice_attributes:
589 if requested_attribute['name'] == slice_tag['tagname'] and \
590 requested_attribute['value'] == slice_tag['value']:
594 if not attribute_found and not append:
595 removed_slice_attributes.append(slice_tag)
597 # get attributes that should be added:
598 for requested_attribute in requested_slice_attributes:
599 # if the requested attribute wasn't found we should add it
600 if requested_attribute['name'] in valid_slice_attribute_names:
601 attribute_found = False
602 for existing_attribute in existing_slice_attributes:
603 if requested_attribute['name'] == existing_attribute['tagname'] and \
604 requested_attribute['value'] == existing_attribute['value']:
607 if not attribute_found:
608 added_slice_attributes.append(requested_attribute)
611 # remove stale attributes
612 for attribute in removed_slice_attributes:
614 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
616 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
617 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
619 # add requested_attributes
620 for attribute in added_slice_attributes:
622 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
624 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
625 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))