2 from types import StringTypes
3 from collections import defaultdict
5 from sfa.util.sfatime import utcparse, datetime_to_epoch
6 from sfa.util.sfalogging import logger
7 from sfa.util.xrn import Xrn, get_leaf, get_authority, urn_to_hrn
8 from sfa.rspecs.rspec import RSpec
9 from sfa.planetlab.vlink import VLink
10 from sfa.planetlab.topology import Topology
11 from sfa.planetlab.plxrn import PlXrn, hrn_to_pl_slicename, xrn_to_hostname, top_auth, hash_loginbase
12 from sfa.storage.model import SliverAllocation
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, rspec_requested_leases, peer):
165 leases = self.driver.shell.GetLeases({'name':slice['name'], 'clip':int(time.time())}, ['lease_id','name', 'hostname', 't_from', 't_until'])
166 grain = self.driver.shell.GetLeaseGranularity()
168 requested_leases = []
169 for lease in rspec_requested_leases:
171 slice_hrn, _ = urn_to_hrn(lease['slice_id'])
173 top_auth_hrn = top_auth(slice_hrn)
174 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
175 slice_part = slice_hrn.split('.')[-1]
176 if top_auth_hrn == self.driver.hrn:
177 login_base = slice_hrn.split('.')[-2][:12]
179 login_base = hash_loginbase(site_hrn)
181 slice_name = '_'.join([login_base, slice_part])
183 if slice_name != slice['name']:
185 elif Xrn(lease['component_id']).get_authority_urn().split(':')[0] != self.driver.hrn:
188 hostname = xrn_to_hostname(lease['component_id'])
189 # fill the requested node with nitos ids
190 requested_lease['name'] = slice['name']
191 requested_lease['hostname'] = hostname
192 requested_lease['t_from'] = int(lease['start_time'])
193 requested_lease['t_until'] = int(lease['duration']) * grain + int(lease['start_time'])
194 requested_leases.append(requested_lease)
198 # prepare actual slice leases by lease_id
201 leases_by_id[lease['lease_id']] = {'name': lease['name'], 'hostname': lease['hostname'], \
202 't_from': lease['t_from'], 't_until': lease['t_until']}
206 deleted_leases_id = []
207 for lease_id in leases_by_id:
208 if leases_by_id[lease_id] not in requested_leases:
209 deleted_leases_id.append(lease_id)
211 kept_leases_id.append(lease_id)
212 requested_leases.remove(leases_by_id[lease_id])
213 added_leases = requested_leases
218 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
219 self.driver.shell.DeleteLeases(deleted_leases_id)
220 for lease in added_leases:
221 self.driver.shell.AddLeases(lease['hostname'], slice['name'], lease['t_from'], lease['t_until'])
224 logger.log_exc('Failed to add/remove slice leases')
229 def verify_slice_nodes(self, slice_urn, slice, rspec_nodes, peer):
232 for node in rspec_nodes:
233 hostname = node.get('component_name')
234 client_id = node.get('client_id')
235 component_id = node.get('component_id').strip()
237 hostname = hostname.strip()
239 hostname = xrn_to_hostname(component_id)
241 slivers[hostname] = {'client_id': client_id, 'component_id': component_id}
243 nodes = self.driver.shell.GetNodes(slice['node_ids'], ['node_id', 'hostname', 'interface_ids'])
244 current_slivers = [node['hostname'] for node in nodes]
246 # remove nodes not in rspec
247 deleted_nodes = list(set(current_slivers).difference(slivers.keys()))
249 # add nodes from rspec
250 added_nodes = list(set(slivers.keys()).difference(current_slivers))
254 self.driver.shell.UnBindObjectFromPeer('slice', slice['slice_id'], peer['shortname'])
255 self.driver.shell.AddSliceToNodes(slice['name'], added_nodes)
256 self.driver.shell.DeleteSliceFromNodes(slice['name'], deleted_nodes)
259 logger.log_exc('Failed to add/remove slice from nodes')
261 slices = self.driver.shell.GetSlices(slice['name'], ['node_ids'])
262 resulting_nodes = self.driver.shell.GetNodes(slices[0]['node_ids'])
264 # update sliver allocations
265 for node in resulting_nodes:
266 client_id = slivers[node['hostname']]['client_id']
267 component_id = slivers[node['hostname']]['component_id']
268 sliver_hrn = '%s.%s-%s' % (self.driver.hrn, slice['slice_id'], node['node_id'])
269 sliver_id = Xrn(sliver_hrn, type='sliver').urn
270 record = SliverAllocation(sliver_id=sliver_id, client_id=client_id,
271 component_id=component_id,
272 slice_urn = slice_urn,
273 allocation_state='geni_allocated')
274 record.sync(self.driver.api.dbsession())
275 return resulting_nodes
277 def free_egre_key(self):
279 for tag in self.driver.shell.GetSliceTags({'tagname': 'egre_key'}):
280 used.add(int(tag['value']))
282 for i in range(1, 256):
287 raise KeyError("No more EGRE keys available")
291 def verify_slice_links(self, slice, requested_links, nodes):
293 if not requested_links:
296 # exit if links are not supported here
297 topology = Topology()
301 # build dict of nodes
305 nodes_dict[node['node_id']] = node
306 interface_ids.extend(node['interface_ids'])
307 # build dict of interfaces
308 interfaces = self.driver.shell.GetInterfaces(interface_ids)
310 for interface in interfaces:
311 interfaces_dict[interface['interface_id']] = interface
316 slice_tags.append({'name': 'egre_key', 'value': self.free_egre_key()})
319 slice_tags.append({'name': 'netns', 'value': '1'})
322 # need to update the attribute string?
323 slice_tags.append({'name': 'capabilities', 'value': 'CAP_NET_ADMIN'})
325 for link in requested_links:
326 # get the ip address of the first node in the link
327 ifname1 = Xrn(link['interface1']['component_id']).get_leaf()
330 ifname_parts = ifname1.split(':')
331 node_raw = ifname_parts[0]
333 if len(ifname_parts) > 1:
334 device = ifname_parts[1]
335 node_id = int(node_raw.replace('node', ''))
336 node = nodes_dict[node_id]
337 if1 = interfaces_dict[node['interface_ids'][0]]
339 topo_rspec = VLink.get_topo_rspec(link, ipaddr)
341 slice_tags.append({'name': 'topo_rspec', 'value': str([topo_rspec]), 'node_id': node_id})
343 slice_tags.append({'name': 'vini_topo', 'value': 'manual', 'node_id': node_id})
344 #self.driver.shell.AddSliceTag(slice['name'], 'topo_rspec', str([topo_rspec]), node_id)
346 self.verify_slice_attributes(slice, slice_tags, {'append': True}, admin=True)
350 def handle_peer(self, site, slice, persons, peer):
355 self.driver.shell.BindObjectToPeer('site', site['site_id'], peer['shortname'], slice['site_id'])
357 self.driver.shell.DeleteSite(site['site_id'])
363 self.driver.shell.BindObjectToPeer('slice', slice['slice_id'], peer['shortname'], slice['slice_id'])
365 self.driver.shell.DeleteSlice(slice['slice_id'])
369 for person in persons:
371 self.driver.shell.BindObjectToPeer('person',
372 person['person_id'], peer['shortname'], person['peer_person_id'])
374 for (key, remote_key_id) in zip(person['keys'], person['key_ids']):
376 self.driver.shell.BindObjectToPeer( 'key', key['key_id'], peer['shortname'], remote_key_id)
378 self.driver.shell.DeleteKey(key['key_id'])
379 logger("failed to bind key: %s to peer: %s " % (key['key_id'], peer['shortname']))
381 self.driver.shell.DeletePerson(person['person_id'])
386 def verify_site(self, slice_xrn, slice_record={}, peer=None, sfa_peer=None, options={}):
387 (slice_hrn, type) = urn_to_hrn(slice_xrn)
388 top_auth_hrn = top_auth(slice_hrn)
389 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
390 if top_auth_hrn == self.driver.hrn:
391 login_base = slice_hrn.split('.')[-2][:12]
393 login_base = hash_loginbase(site_hrn)
395 sites = self.driver.shell.GetSites({'peer_id': None},['site_id','name','abbreviated_name','login_base','hrn'])
397 # filter sites by hrn
398 site_exists = [site for site in sites if site['hrn'] == site_hrn]
401 # create new site record
402 site = {'name': 'sfa:%s' % site_hrn,
403 'abbreviated_name': site_hrn,
404 'login_base': login_base,
408 'peer_site_id': None}
410 site['site_id'] = self.driver.shell.AddSite(site)
412 self.driver.shell.SetSiteHrn(int(site['site_id']), site_hrn)
413 # Tag this as created through SFA
414 self.driver.shell.SetSiteSfaCreated(int(site['site_id']), 'True')
415 # exempt federated sites from monitor policies
416 self.driver.shell.AddSiteTag(int(site['site_id']), 'exempt_site_until', "20200101")
419 site = site_exists[0]
424 def verify_slice(self, slice_hrn, slice_record, peer, sfa_peer, expiration, options={}):
425 top_auth_hrn = top_auth(slice_hrn)
426 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
427 slice_part = slice_hrn.split('.')[-1]
428 if top_auth_hrn == self.driver.hrn:
429 login_base = slice_hrn.split('.')[-2][:12]
431 login_base = hash_loginbase(site_hrn)
434 slice_name = '_'.join([login_base, slice_part])
436 slices = self.driver.shell.GetSlices({'peer_id': None},['slice_id','name','hrn'])
437 # Filter slices by HRN
438 slice_exists = [slice for slice in slices if slice['hrn'] == slice_hrn]
439 expires = int(datetime_to_epoch(utcparse(expiration)))
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')
451 self.driver.shell.UpdateSlice(int(slice['slice_id']), {'expires': expires})
454 slice = slice_exists[0]
455 #Update expiration if necessary
456 if slice.get('expires', None) != expires:
457 self.driver.shell.UpdateSlice( int(slice['slice_id']), {'expires' : expires})
459 return self.driver.shell.GetSlices(int(slice['slice_id']))[0]
462 def verify_persons(self, slice_hrn, slice_record, users, peer, sfa_peer, options={}):
463 top_auth_hrn = top_auth(slice_hrn)
464 site_hrn = '.'.join(slice_hrn.split('.')[:-1])
465 slice_part = slice_hrn.split('.')[-1]
468 user['hrn'], _ = urn_to_hrn(user['urn'])
469 users_by_hrn[user['hrn']] = user
471 if top_auth_hrn == self.driver.hrn:
472 login_base = slice_hrn.split('.')[-2][:12]
474 login_base = hash_loginbase(site_hrn)
476 slice_name = '_'.join([login_base, slice_part])
478 persons = self.driver.shell.GetPersons({'peer_id': None},['person_id','email','hrn'])
479 site = self.driver.shell.GetSites({'peer_id': None, 'login_base': login_base})[0]
480 slice = self.driver.shell.GetSlices({'peer_id': None, 'name': slice_name})[0]
481 slice_persons = self.driver.shell.GetPersons({'peer_id': None, 'person_id': slice['person_ids']},['person_id','email','hrn'])
484 persons_by_email = {}
485 for person in persons:
486 persons_by_hrn[person['hrn']] = person
487 persons_by_email[person['email']] = person
488 slice_persons_by_hrn = {}
489 for slice_person in slice_persons:
490 slice_persons_by_hrn[slice_person['hrn']] = slice_person
492 # sort persons by HRN
493 persons_to_add = set(users_by_hrn.keys()).difference(slice_persons_by_hrn.keys())
494 persons_to_delete = set(slice_persons_by_hrn.keys()).difference(users_by_hrn.keys())
495 persons_to_keep = set(users_by_hrn.keys()).intersection(slice_persons_by_hrn.keys())
498 persons_to_verify_keys = {}
500 # Add persons or add persons to slice
501 for person_hrn in persons_to_add:
502 person_email = users_by_hrn[person_hrn].get('email', None)
503 if person_email and person_email in persons_by_email.keys():
504 # check if the user already exist in PL
505 person_id = persons_by_email[person_email]['person_id']
506 self.driver.shell.AddPersonToSlice(person_id, slice['slice_id'])
507 persons_to_verify_keys[person_id] = users_by_hrn[person_hrn]
511 'first_name': person_hrn,
512 'last_name': person_hrn,
513 'email': users_by_hrn[person_hrn].get('email', "%s@geni.net"%person_hrn.split('.')[-1]),
516 person_id = self.driver.shell.AddPerson(person)
517 self.driver.shell.AddRoleToPerson('user', int(person_id))
519 self.driver.shell.UpdatePerson(int(person_id), {'enabled': True})
520 self.driver.shell.SetPersonHrn(int(person_id), person_hrn)
521 self.driver.shell.SetPersonSfaCreated(int(person_id), 'True')
522 self.driver.shell.AddPersonToSite(int(person_id), site['site_id'])
523 self.driver.shell.AddPersonToSlice(int(person_id), slice['slice_id'])
526 for key in users_by_hrn[person_hrn].get('keys', []):
527 key = {'key':key, 'key_type':'ssh'}
528 self.driver.shell.AddPersonKey(person_id, key)
531 # Delete persons from slice
532 for person_hrn in persons_to_delete:
533 person_id = slice_persons_by_hrn[person_hrn].get('person_id')
534 slice_id = slice['slice_id']
535 self.driver.shell.DeletePersonFromSlice(person_id, slice_id)
538 # Update kept persons
539 for person_hrn in persons_to_keep:
540 person_id = slice_persons_by_hrn[person_hrn].get('person_id')
541 persons_to_verify_keys[person_id] = users_by_hrn[person_hrn]
543 self.verify_keys(persons_to_verify_keys, peer, options)
545 return persons_to_add
548 def verify_keys(self, persons_to_verify_keys, peer, options={}):
549 # we only add keys that comes from sfa to persons in PL
550 for person_id in persons_to_verify_keys:
551 person_sfa_keys = persons_to_verify_keys[person_id].get('keys', [])
552 person_pl_keys = self.driver.shell.GetKeys({'person_id': int(person_id)})
553 person_pl_keys_list = [key['key'] for key in person_pl_keys]
555 keys_to_add = set(person_sfa_keys).difference(person_pl_keys_list)
557 for key_string in keys_to_add:
558 key = {'key': key_string, 'key_type': 'ssh'}
559 self.driver.shell.AddPersonKey(int(person_id), key)
562 def verify_slice_attributes(self, slice, requested_slice_attributes, options={}, admin=False):
563 append = options.get('append', True)
564 # get list of attributes users ar able to manage
565 filter = {'category': '*slice*'}
567 filter['|roles'] = ['user']
568 slice_attributes = self.driver.shell.GetTagTypes(filter)
569 valid_slice_attribute_names = [attribute['tagname'] for attribute in slice_attributes]
571 # get sliver attributes
572 added_slice_attributes = []
573 removed_slice_attributes = []
574 # we need to keep the slice hrn anyway
575 ignored_slice_attribute_names = ['hrn']
576 existing_slice_attributes = self.driver.shell.GetSliceTags({'slice_id': slice['slice_id']})
578 # get attributes that should be removed
579 for slice_tag in existing_slice_attributes:
580 if slice_tag['tagname'] in ignored_slice_attribute_names:
581 # If a slice already has a admin only role it was probably given to them by an
582 # admin, so we should ignore it.
583 ignored_slice_attribute_names.append(slice_tag['tagname'])
586 # If an existing slice attribute was not found in the request it should
588 attribute_found=False
589 for requested_attribute in requested_slice_attributes:
590 if requested_attribute['name'] == slice_tag['tagname'] and \
591 requested_attribute['value'] == slice_tag['value']:
595 if not attribute_found and not append:
596 removed_slice_attributes.append(slice_tag)
598 # get attributes that should be added:
599 for requested_attribute in requested_slice_attributes:
600 # if the requested attribute wasn't found we should add it
601 if requested_attribute['name'] in valid_slice_attribute_names:
602 attribute_found = False
603 for existing_attribute in existing_slice_attributes:
604 if requested_attribute['name'] == existing_attribute['tagname'] and \
605 requested_attribute['value'] == existing_attribute['value']:
608 if not attribute_found:
609 added_slice_attributes.append(requested_attribute)
612 # remove stale attributes
613 for attribute in removed_slice_attributes:
615 self.driver.shell.DeleteSliceTag(attribute['slice_tag_id'])
617 logger.warn('Failed to remove sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
618 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))
620 # add requested_attributes
621 for attribute in added_slice_attributes:
623 self.driver.shell.AddSliceTag(slice['name'], attribute['name'], attribute['value'], attribute.get('node_id', None))
625 logger.warn('Failed to add sliver attribute. name: %s, value: %s, node_id: %s\nCause:%s'\
626 % (slice['name'], attribute['value'], attribute.get('node_id'), str(e)))