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.rspecs.rspec import RSpec
8 from sfa.planetlab.vlink import VLink
9 from sfa.planetlab.topology import Topology
10 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename
11 from sfa.storage.model import SliverAllocation
12 from sfa.storage.alchemy import dbsession
18 rspec_to_slice_tag = {'max_rate':'net_max_rate'}
20 def __init__(self, driver):
23 def get_slivers(self, xrn, node=None):
24 hrn, type = urn_to_hrn(xrn)
26 slice_name = hrn_to_pl_slicename(hrn)
27 # XX Should we just call PLCAPI.GetSliceTicket(slice_name) instead
28 # of doing all of this?
29 #return self.driver.shell.GetSliceTicket(self.auth, slice_name)
31 # from PLCAPI.GetSlivers.get_slivers()
32 slice_fields = ['slice_id', 'name', 'instantiation', 'expires', 'person_ids', 'slice_tag_ids']
33 slices = self.driver.shell.GetSlices(slice_name, slice_fields)
34 # Build up list of users and slice attributes
36 all_slice_tag_ids = set()
38 person_ids.update(slice['person_ids'])
39 all_slice_tag_ids.update(slice['slice_tag_ids'])
40 person_ids = list(person_ids)
41 all_slice_tag_ids = list(all_slice_tag_ids)
42 # Get user information
43 all_persons_list = self.driver.shell.GetPersons({'person_id':person_ids,'enabled':True}, ['person_id', 'enabled', 'key_ids'])
45 for person in all_persons_list:
46 all_persons[person['person_id']] = person
48 # Build up list of keys
50 for person in all_persons.values():
51 key_ids.update(person['key_ids'])
52 key_ids = list(key_ids)
53 # Get user account keys
54 all_keys_list = self.driver.shell.GetKeys(key_ids, ['key_id', 'key', 'key_type'])
56 for key in all_keys_list:
57 all_keys[key['key_id']] = key
58 # Get slice attributes
59 all_slice_tags_list = self.driver.shell.GetSliceTags(all_slice_tag_ids)
61 for slice_tag in all_slice_tags_list:
62 all_slice_tags[slice_tag['slice_tag_id']] = slice_tag
67 for person_id in slice['person_ids']:
68 if person_id in all_persons:
69 person = all_persons[person_id]
70 if not person['enabled']:
72 for key_id in person['key_ids']:
73 if key_id in all_keys:
74 key = all_keys[key_id]
75 keys += [{'key_type': key['key_type'],
78 # All (per-node and global) attributes for this slice
80 for slice_tag_id in slice['slice_tag_ids']:
81 if slice_tag_id in all_slice_tags:
82 slice_tags.append(all_slice_tags[slice_tag_id])
83 # Per-node sliver attributes take precedence over global
84 # slice attributes, so set them first.
85 # Then comes nodegroup slice attributes
86 # Followed by global slice attributes
87 sliver_attributes = []
90 for sliver_attribute in filter(lambda a: a['node_id'] == node['node_id'], slice_tags):
91 sliver_attributes.append(sliver_attribute['tagname'])
92 attributes.append({'tagname': sliver_attribute['tagname'],
93 'value': sliver_attribute['value']})
95 # set nodegroup slice attributes
96 for slice_tag in filter(lambda a: a['nodegroup_id'] in node['nodegroup_ids'], slice_tags):
97 # Do not set any nodegroup slice attributes for
98 # which there is at least one sliver attribute
100 if slice_tag not in slice_tags:
101 attributes.append({'tagname': slice_tag['tagname'],
102 'value': slice_tag['value']})
104 for slice_tag in filter(lambda a: a['node_id'] is None, slice_tags):
105 # Do not set any global slice attributes for
106 # which there is at least one sliver attribute
108 if slice_tag['tagname'] not in sliver_attributes:
109 attributes.append({'tagname': slice_tag['tagname'],
110 'value': slice_tag['value']})
112 # XXX Sanity check; though technically this should be a system invariant
113 # checked with an assertion
114 if slice['expires'] > MAXINT: slice['expires']= MAXINT
118 'name': slice['name'],
119 'slice_id': slice['slice_id'],
120 'instantiation': slice['instantiation'],
121 'expires': slice['expires'],
123 'attributes': attributes
128 def get_peer(self, xrn):
129 hrn, type = urn_to_hrn(xrn)
130 # Becaues of myplc federation, we first need to determine if this
131 # slice belongs to out local plc or a myplc peer. We will assume it
132 # is a local site, unless we find out otherwise
135 # get this slice's authority (site)
136 slice_authority = get_authority(hrn)
138 # get this site's authority (sfa root authority or sub authority)
139 site_authority = get_authority(slice_authority).lower()
141 # check if we are already peered with this site_authority, if so
142 peers = self.driver.shell.GetPeers({}, ['peer_id', 'peername', 'shortname', 'hrn_root'])
143 for peer_record in peers:
144 names = [name.lower() for name in peer_record.values() if isinstance(name, StringTypes)]
145 if site_authority in names:
150 def get_sfa_peer(self, xrn):
151 hrn, type = urn_to_hrn(xrn)
153 # return the authority for this hrn or None if we are the authority
155 slice_authority = get_authority(hrn)
156 site_authority = get_authority(slice_authority)
158 if site_authority != self.driver.hrn:
159 sfa_peer = site_authority
163 def verify_slice_leases(self, slice, requested_leases, kept_leases, peer):
165 leases = self.driver.shell.GetLeases({'name':slice['name']}, ['lease_id'])
166 grain = self.driver.shell.GetLeaseGranularity()
167 current_leases = [lease['lease_id'] for lease in leases]
168 deleted_leases = list(set(current_leases).difference(kept_leases))
172 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
173 deleted=self.driver.shell.DeleteLeases(deleted_leases)
174 for lease in requested_leases:
175 added=self.driver.shell.AddLeases(lease['hostname'], slice['name'], int(lease['start_time']), int(lease['duration']) * grain + int(lease['start_time']))
178 logger.log_exc('Failed to add/remove slice leases')
183 def verify_slice_nodes(self, slice_urn, slice, rspec_nodes, peer):
186 for node in rspec_nodes:
187 hostname = node.get('component_name')
188 client_id = node.get('client_id')
189 component_id = node.get('component_id').strip()
191 hostname = hostname.strip()
193 hostname = xrn_to_hostname(component_id)
195 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
197 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
198 current_slivers = [node['hostname'] for node in nodes]
200 # remove nodes not in rspec
201 deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
203 # add nodes from rspec
204 added_nodes = list(set(slivers.keys()).difference(current_slivers))
208 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
209 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
210 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
213 logger.log_exc('Failed to add/remove slice from nodes')
215 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
216 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
218 # update sliver allocations
219 for node in resulting_nodes:
220 client_id = slivers[node['hostname']]['client_id']
221 component_id = slivers[node['hostname']]['component_id']
222 sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
223 sliver_id = Xrn(sliver_hrn, type='sliver').urn
224 record = SliverAllocation(sliver_id=sliver_id, client_id=client_id,
225 component_id=component_id,
226 slice_urn = slice_urn,
227 allocation_state='geni_allocated')
229 return resulting_nodes
231 def free_egre_key(self):
233 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
234 used.add(int(tag['value']))
236 for i in range(1, 256):
241 raise KeyError("No more EGRE keys available")
245 def verify_slice_links(self, slice, requested_links, nodes):
247 if not requested_links:
250 # exit if links are not supported here
251 topology = Topology()
255 # build dict of nodes
259 nodes_dict[node['node_id']] = node
260 interface_ids.extend(node['interface_ids'])
261 # build dict of interfaces
262 interfaces = self.driver.shell.GetInterfaces(interface_ids)
264 for interface in interfaces:
265 interfaces_dict[interface['interface_id']] = interface
270 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
273 slice_tags.append({'name': 'netns', 'value': '1'})
276 # need to update the attribute string?
277 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
279 for link in requested_links:
280 # get the ip address of the first node in the link
281 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
282 ifname_parts = ifname1.split(':')
283 node_raw = ifname_parts[0]
285 if len(ifname_parts) > 1:
286 device = ifname_parts[1]
287 node_id = int(node_raw.replace('node', ''))
288 node = nodes_dict[node_id]
289 if1 = interfaces_dict[node['interface_ids'][0]]
291 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
293 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
295 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
296 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
298 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
302 def handle_peer(self, site, slice, persons, peer):
307 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
309 self.driver.shell.DeleteSite(site['site_id'])
315 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
317 self.driver.shell.DeleteSlice(slice['slice_id'])
321 for person in persons:
323 self.driver.shell.BindObjectToPeer('person',
324 person['person_id'], peer['shortname'], person['peer_person_id'])
326 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
328 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
330 self.driver.shell.DeleteKey(key['key_id'])
331 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
333 self.driver.shell.DeletePerson(person['person_id'])
338 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
339 (slice_hrn, type) = urn_to_hrn(slice_xrn)
340 site_hrn = get_authority(slice_hrn)
341 # login base can't be longer than 20 characters
342 slicename = hrn_to_pl_slicename(slice_hrn)
343 authority_name = slicename.split('_')[0]
344 login_base = authority_name[:20]
345 sites = self.driver.shell.GetSites(login_base)
347 # create new site record
348 site = {'name': 'geni.%s' % authority_name,
349 'abbreviated_name': authority_name,
350 'login_base': login_base,
354 'peer_site_id': None}
356 site['peer_site_id'] = slice_record.get('site_id', None)
357 site['site_id'] = self.driver.shell.AddSite(site)
358 # exempt federated sites from monitor policies
359 self.driver.shell.AddSiteTag(site['site_id'], 'exempt_site_until', "20200101")
361 # # is this still necessary?
362 # # add record to the local registry
363 # if sfa_peer and slice_record:
364 # peer_dict = {'type': 'authority', 'hrn': site_hrn, \
365 # 'peer_authority': sfa_peer, 'pointer': site['site_id']}
366 # self.registry.register_peer_object(self.credential, peer_dict)
370 # unbind from peer so we can modify if necessary. Will bind back later
371 self.driver.shell.UnBindObjectFromPeer('site', site['site_id'], peer['shortname'])
375 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, options={}):
376 slicename = hrn_to_pl_slicename(slice_hrn)
377 parts = slicename.split("_")
378 login_base = parts[0]
379 slices = self.driver.shell.GetSlices([slicename])
381 slice = {'name': slicename,
383 'description': 'No Description'}
385 slice['slice_id'] = self.driver.shell.AddSlice(slice)
386 slice['node_ids'] = []
387 slice['person_ids'] = []
388 if peer and slice_record:
389 slice['peer_slice_id'] = slice_record.get('slice_id', None)
392 if peer and slice_record:
393 slice['peer_slice_id'] = slice_record.get('slice_id', None)
394 # unbind from peer so we can modify if necessary. Will bind back later
395 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
396 #Update existing record (e.g. expires field) it with the latest info.
397 if slice_record and slice_record.get('expires'):
398 requested_expires = int(datetime_to_epoch(utcparse(slice_record['expires'])))
399 if requested_expires and slice['expires'] != requested_expires:
400 self.driver.shell.UpdateSlice( slice['slice_id'], {'expires' : requested_expires})
404 #def get_existing_persons(self, users):
405 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
407 users_by_site = defaultdict(list)
410 user['urn'] = user['urn'].lower()
411 hrn, type = urn_to_hrn(user['urn'])
412 username = get_leaf(hrn)
413 login_base = PlXrn(xrn=user['urn']).pl_login_base()
414 user['username'] = username
415 user['site'] = login_base
418 user['email'] = user['email'].lower()
419 users_by_email[user['email']] = user
420 users_dict[user['email']] = user
422 users_by_site[user['site']].append(user)
424 # start building a list of existing users
425 existing_user_ids = []
426 existing_user_ids_filter = []
428 existing_user_ids_filter.extend(users_by_email.keys())
430 for login_base in users_by_site:
431 users = users_by_site[login_base]
433 existing_user_ids_filter.append(user['username']+'@geni.net')
434 if existing_user_ids_filter:
435 # get existing users by email
436 existing_users = self.driver.shell.GetPersons({'email': existing_user_ids_filter},
437 ['person_id', 'key_ids', 'email'])
438 existing_user_ids.extend([user['email'] for user in existing_users])
441 # get a list of user sites (based on requeste user urns
442 site_list = self.driver.shell.GetSites(users_by_site.keys(), \
443 ['site_id', 'login_base', 'person_ids'])
444 # get all existing users at these sites
447 for site in site_list:
448 sites[site['site_id']] = site
449 site_user_ids.extend(site['person_ids'])
451 existing_site_persons_list = self.driver.shell.GetPersons(site_user_ids,
452 ['person_id', 'key_ids', 'email', 'site_ids'])
454 # all requested users are either existing users or new (added) users
455 for login_base in users_by_site:
456 requested_site_users = users_by_site[login_base]
457 for requested_user in requested_site_users:
459 for existing_user in existing_site_persons_list:
460 for site_id in existing_user['site_ids']:
462 site = sites[site_id]
463 if login_base == site['login_base'] and \
464 existing_user['email'].startswith(requested_user['username']+'@'):
465 existing_user_ids.append(existing_user['email'])
466 requested_user['email'] = existing_user['email']
467 users_dict[existing_user['email']] = requested_user
473 if user_found == False:
474 fake_email = requested_user['username'] + '@geni.net'
475 requested_user['email'] = fake_email
476 users_dict[fake_email] = requested_user
478 # requested slice users
479 requested_user_ids = users_dict.keys()
480 # existing slice users
481 existing_slice_users_filter = {'person_id': slice_record.get('person_ids', [])}
482 existing_slice_users = self.driver.shell.GetPersons(existing_slice_users_filter,
483 ['person_id', 'key_ids', 'email'])
484 existing_slice_user_ids = [user['email'] for user in existing_slice_users]
486 # users to be added, removed or updated
487 added_user_ids = set(requested_user_ids).difference(existing_user_ids)
488 added_slice_user_ids = set(requested_user_ids).difference(existing_slice_user_ids)
489 removed_user_ids = set(existing_slice_user_ids).difference(requested_user_ids)
490 updated_user_ids = set(existing_slice_user_ids).intersection(requested_user_ids)
492 # Remove stale users (only if we are not appending).
494 append = options.get('append', True)
496 for removed_user_id in removed_user_ids:
497 self.driver.shell.DeletePersonFromSlice(removed_user_id, slice_record['name'])
498 # update_existing users
499 updated_users_list = [user for user in users_dict.values() if user['email'] in \
501 self.verify_keys(existing_slice_users, updated_users_list, peer, options)
505 for added_user_id in added_user_ids:
506 added_user = users_dict[added_user_id]
507 hrn, type = urn_to_hrn(added_user['urn'])
509 'first_name': added_user.get('first_name', hrn),
510 'last_name': added_user.get('last_name', hrn),
511 'email': added_user_id,
512 'peer_person_id': None,
514 'key_ids': added_user.get('key_ids', []),
516 person['person_id'] = self.driver.shell.AddPerson(person)
518 person['peer_person_id'] = added_user['person_id']
519 added_persons.append(person)
522 self.driver.shell.UpdatePerson(person['person_id'], {'enabled': True})
525 self.driver.shell.AddPersonToSite(added_user_id, added_user['site'])
527 for key_string in added_user.get('keys', []):
528 key = {'key':key_string, 'key_type':'ssh'}
529 key['key_id'] = self.driver.shell.AddPersonKey(person['person_id'], key)
530 person['keys'].append(key)
532 # add the registry record
534 # peer_dict = {'type': 'user', 'hrn': hrn, 'peer_authority': sfa_peer, \
535 # 'pointer': person['person_id']}
536 # self.registry.register_peer_object(self.credential, peer_dict)
538 for added_slice_user_id in added_slice_user_ids.union(added_user_ids):
539 # add person to the slice
540 self.driver.shell.AddPersonToSlice(added_slice_user_id, slice_record['name'])
541 # if this is a peer record then it should already be bound to a peer.
542 # no need to return worry about it getting bound later
547 def verify_keys(self, persons, users, peer, options={}):
550 for person in persons:
551 key_ids.extend(person['key_ids'])
552 keylist = self.driver.shell.GetKeys(key_ids, ['key_id', 'key'])
555 keydict[key['key']] = key['key_id']
556 existing_keys = keydict.keys()
558 for person in persons:
559 persondict[person['email']] = person
565 user_keys = user.get('keys', [])
566 updated_persons.append(user)
567 for key_string in user_keys:
568 requested_keys.append(key_string)
569 if key_string not in existing_keys:
570 key = {'key': key_string, 'key_type': 'ssh'}
573 person = persondict[user['email']]
574 self.driver.shell.UnBindObjectFromPeer('person', person['person_id'], peer['shortname'])
575 key['key_id'] = self.driver.shell.AddPersonKey(user['email'], key)
577 key_index = user_keys.index(key['key'])
578 remote_key_id = user['key_ids'][key_index]
579 self.driver.shell.BindObjectToPeer('key', key['key_id'], peer['shortname'], remote_key_id)
583 self.driver.shell.BindObjectToPeer('person', person['person_id'], peer['shortname'], user['person_id'])
585 # remove old keys (only if we are not appending)
586 append = options.get('append', True)
588 removed_keys = set(existing_keys).difference(requested_keys)
589 for existing_key_id in keydict:
590 if keydict[existing_key_id] in removed_keys:
593 self.driver.shell.UnBindObjectFromPeer('key', existing_key_id, peer['shortname'])
594 self.driver.shell.DeleteKey(existing_key_id)
598 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
599 append = options.get('append', True)
600 # get list of attributes users ar able to manage
601 filter = {'category': '*slice*'}
603 filter['|roles'] = ['user']
604 slice_attributes = self.driver.shell.GetTagTypes(filter)
605 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
607 # get sliver attributes
608 added_slice_attributes = []
609 removed_slice_attributes = []
610 ignored_slice_attribute_names = []
611 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
613 # get attributes that should be removed
614 for slice_tag in existing_slice_attributes:
615 if slice_tag['tagname'] in ignored_slice_attribute_names:
616 # If a slice already has a admin only role it was probably given to them by an
617 # admin, so we should ignore it.
618 ignored_slice_attribute_names.append(slice_tag['tagname'])
620 # If an existing slice attribute was not found in the request it should
622 attribute_found=False
623 for requested_attribute in requested_slice_attributes:
624 if requested_attribute['name'] == slice_tag['tagname'] and \
625 requested_attribute['value'] == slice_tag['value']:
629 if not attribute_found and not append:
630 removed_slice_attributes.append(slice_tag)
632 # get attributes that should be added:
633 for requested_attribute in requested_slice_attributes:
634 # if the requested attribute wasn't found we should add it
635 if requested_attribute['name'] in valid_slice_attribute_names:
636 attribute_found = False
637 for existing_attribute in existing_slice_attributes:
638 if requested_attribute['name'] == existing_attribute['tagname'] and \
639 requested_attribute['value'] == existing_attribute['value']:
642 if not attribute_found:
643 added_slice_attributes.append(requested_attribute)
646 # remove stale attributes
647 for attribute in removed_slice_attributes:
649 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
651 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
652 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
654 # add requested_attributes
655 for attribute in added_slice_attributes:
657 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
659 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
660 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))