4 from sfa.util.faults import MissingSfaInfo, UnknownSfaType, \
5 RecordNotFound, SfaNotImplemented, SliverDoesNotExist, \
8 from sfa.util.sfalogging import logger
9 from sfa.util.defaultdict import defaultdict
10 from sfa.util.sfatime import utcparse, datetime_to_string, datetime_to_epoch
11 from sfa.util.xrn import Xrn, hrn_to_urn, get_leaf, urn_to_sliver_id
12 from sfa.util.plxrn import PlXrn, hrn_to_pl_slicename
13 from sfa.util.cache import Cache
14 from sfa.trust.credential import Credential
15 # used to be used in get_ticket
16 #from sfa.trust.sfaticket import SfaTicket
18 from sfa.rspecs.version_manager import VersionManager
19 from sfa.rspecs.rspec import RSpec
21 # the driver interface, mostly provides default behaviours
22 from sfa.managers.driver import Driver
23 from sfa.openstack.nova_shell import NovaShell
24 from sfa.openstack.euca_shell import EucaShell
25 from sfa.openstack.osaggregate import OSAggregate
26 from sfa.planetlab.plslices import PlSlices
27 from sfa.util.osxrn import OSXrn
30 def list_to_dict(recs, key):
32 convert a list of dictionaries into a dictionary keyed on the
33 specified dictionary key
35 return dict ( [ (rec[key],rec) for rec in recs ] )
38 # PlShell is just an xmlrpc serverproxy where methods
39 # can be sent as-is; it takes care of authentication
40 # from the global config
42 class NovaDriver (Driver):
44 # the cache instance is a class member so it survives across incoming requests
47 def __init__ (self, config):
48 Driver.__init__ (self, config)
49 self.shell = NovaShell (config)
50 self.euca_shell = EucaShell(config)
52 if config.SFA_AGGREGATE_CACHING:
53 if NovaDriver.cache is None:
54 NovaDriver.cache = Cache()
55 self.cache = NovaDriver.cache
57 ########################################
58 ########## registry oriented
59 ########################################
61 ########## disabled users
62 def is_enabled (self, record):
63 # all records are enabled
66 def augment_records_with_testbed_info (self, sfa_records):
67 return self.fill_record_info (sfa_records)
70 def register (self, sfa_record, hrn, pub_key):
71 type = sfa_record['type']
73 #pl_record = self.sfa_fields_to_pl_fields(type dd , hrn, sfa_record)
76 # add slice description, name, researchers, PI
77 name = hrn_to_pl_slicename(hrn)
78 researchers = sfa_record.get('researchers', [])
79 pis = sfa_record.get('pis', [])
80 project_manager = None
81 description = sfa_record.get('description', None)
83 project_manager = Xrn(pis[0], 'user').get_leaf()
85 project_manager = Xrn(researchers[0], 'user').get_leaf()
86 if not project_manager:
87 err_string = "Cannot create a project without a project manager. " + \
88 "Please specify at least one PI or researcher for project: " + \
90 raise SfaInvalidArgument(err_string)
92 users = [Xrn(user, 'user').get_leaf() for user in \
94 self.shell.auth_manager.create_project(name, project_manager, description, users)
97 # add person roles, projects and keys
98 name = Xrn(hrn).get_leaf()
99 self.shell.auth_manager.create_user(name)
100 projects = sfa_records.get('slices', [])
101 for project in projects:
102 project_name = Xrn(project).get_leaf()
103 self.shell.auth_manager.add_to_project(name, project_name)
104 keys = sfa_records.get('keys', [])
111 self.shell.db.key_pair_create(key_dict)
116 # xxx actually old_sfa_record comes filled with plc stuff as well in the original code
117 def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
118 type = new_sfa_record['type']
120 # new_key implemented for users only
121 if new_key and type not in [ 'user' ]:
122 raise UnknownSfaType(type)
124 elif type == "slice":
125 # can update project manager and description
126 name = hrn_to_pl_slicename(hrn)
127 researchers = sfa_record.get('researchers', [])
128 pis = sfa_record.get('pis', [])
129 project_manager = None
130 description = sfa_record.get('description', None)
132 project_manager = Xrn(pis[0], 'user').get_leaf()
134 project_manager = Xrn(researchers[0], 'user').get_leaf()
135 self.shell.auth_manager.modify_project(name, project_manager, description)
138 # can techinally update access_key and secret_key,
139 # but that is not in our scope, so we do nothing.
145 def remove (self, sfa_record):
146 type=sfa_record['type']
148 name = Xrn(sfa_record['hrn']).get_leaf()
149 if self.shell.auth_manager.get_user(name):
150 self.shell.auth_manager.delete_user(name)
151 elif type == 'slice':
152 name = hrn_to_pl_slicename(sfa_record['hrn'])
153 if self.shell.auth_manager.get_project(name):
154 self.shell.auth_manager.delete_project(name)
159 def fill_record_info(self, records):
161 Given a (list of) SFA record, fill in the PLC specific
162 and SFA specific fields in the record.
164 if not isinstance(records, list):
167 for record in records:
169 if record['type'] == 'user':
170 name = Xrn(record['hrn']).get_leaf()
171 os_record = self.shell.auth_manager.get_user(name)
172 projects = self.shell.db.project_get_by_user(name)
173 record['slices'] = [self.hrn + "." + proj.name for \
175 record['roles'] = self.shell.db.user_get_roles(name)
176 keys = self.shell.db.key_pair_get_all_by_user(name)
177 record['keys'] = [key.public_key for key in keys]
178 elif record['type'] == 'slice':
179 name = hrn_to_pl_slicename(record['hrn'])
180 os_record = self.shell.auth_manager.get_project(name)
181 record['description'] = os_record.description
182 record['PI'] = [self.hrn + "." + os_record.project_manager.name]
183 record['geni_creator'] = record['PI']
184 record['researcher'] = [self.hrn + "." + user for \
185 user in os_record.member_ids]
188 record['geni_urn'] = hrn_to_urn(record['hrn'], record['type'])
189 record['geni_certificate'] = record['gid']
190 record['name'] = os_record.name
191 #if os_record.created_at is not None:
192 # record['date_created'] = datetime_to_string(utcparse(os_record.created_at))
193 #if os_record.updated_at is not None:
194 # record['last_updated'] = datetime_to_string(utcparse(os_record.updated_at))
200 # plcapi works by changes, compute what needs to be added/deleted
201 def update_relation (self, subject_type, target_type, subject_id, target_ids):
202 # hard-wire the code for slice/user for now, could be smarter if needed
203 if subject_type =='slice' and target_type == 'user':
204 subject=self.shell.project_get(subject_id)[0]
205 current_target_ids = [user.name for user in subject.members]
206 add_target_ids = list ( set (target_ids).difference(current_target_ids))
207 del_target_ids = list ( set (current_target_ids).difference(target_ids))
208 logger.debug ("subject_id = %s (type=%s)"%(subject_id,type(subject_id)))
209 for target_id in add_target_ids:
210 self.shell.project_add_member(target_id,subject_id)
211 logger.debug ("add_target_id = %s (type=%s)"%(target_id,type(target_id)))
212 for target_id in del_target_ids:
213 logger.debug ("del_target_id = %s (type=%s)"%(target_id,type(target_id)))
214 self.shell.project_remove_member(target_id, subject_id)
216 logger.info('unexpected relation to maintain, %s -> %s'%(subject_type,target_type))
219 ########################################
220 ########## aggregate oriented
221 ########################################
223 def testbed_name (self): return "openstack"
225 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
226 def aggregate_version (self):
227 version_manager = VersionManager()
228 ad_rspec_versions = []
229 request_rspec_versions = []
230 for rspec_version in version_manager.versions:
231 if rspec_version.content_type in ['*', 'ad']:
232 ad_rspec_versions.append(rspec_version.to_dict())
233 if rspec_version.content_type in ['*', 'request']:
234 request_rspec_versions.append(rspec_version.to_dict())
236 'testbed':self.testbed_name(),
237 'geni_request_rspec_versions': request_rspec_versions,
238 'geni_ad_rspec_versions': ad_rspec_versions,
241 def list_slices (self, creds, options):
242 # look in cache first
244 slices = self.cache.get('slices')
246 logger.debug("OpenStackDriver.list_slices returns from cache")
250 projs = self.shell.auth_manager.get_projects()
251 slice_urns = [OSXrn(proj.name, 'slice').urn for proj in projs]
255 logger.debug ("OpenStackDriver.list_slices stores value in cache")
256 self.cache.add('slices', slice_urns)
260 # first 2 args are None in case of resource discovery
261 def list_resources (self, slice_urn, slice_hrn, creds, options):
262 cached_requested = options.get('cached', True)
264 version_manager = VersionManager()
265 # get the rspec's return format from options
266 rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
267 version_string = "rspec_%s" % (rspec_version)
269 #panos adding the info option to the caching key (can be improved)
270 if options.get('info'):
271 version_string = version_string + "_"+options.get('info', 'default')
273 # look in cache first
274 if cached_requested and self.cache and not slice_hrn:
275 rspec = self.cache.get(version_string)
277 logger.debug("OpenStackDriver.ListResources: returning cached advertisement")
280 #panos: passing user-defined options
281 #print "manager options = ",options
282 aggregate = OSAggregate(self)
283 rspec = aggregate.get_rspec(slice_xrn=slice_urn, version=rspec_version,
287 if self.cache and not slice_hrn:
288 logger.debug("OpenStackDriver.ListResources: stores advertisement in cache")
289 self.cache.add(version_string, rspec)
293 def sliver_status (self, slice_urn, slice_hrn):
294 # find out where this slice is currently running
295 project_name = hrn_to_pl_slicename(slice_hrn)
296 project = self.shell.auth_manager.get_project(project_name)
297 instances = self.shell.db.instance_get_all_by_project(project_name)
298 if len(instances) == 0:
299 raise SliverDoesNotExist("You have not allocated any slivers here")
302 top_level_status = 'unknown'
304 top_level_status = 'ready'
305 result['geni_urn'] = slice_urn
306 result['plos_login'] = 'root'
307 result['plos_expires'] = None
310 for instance in instances:
312 # instances are accessed by ip, not hostname. We need to report the ip
313 # somewhere so users know where to ssh to.
314 res['plos_hostname'] = instance.hostname
315 res['plos_created_at'] = datetime_to_string(utcparse(instance.created_at))
316 res['plos_boot_state'] = instance.vm_state
317 res['plos_sliver_type'] = instance.instance_type.name
318 sliver_id = Xrn(slice_urn).get_sliver_id(instance.project_id, \
319 instance.hostname, instance.id)
320 res['geni_urn'] = sliver_id
322 if instance.vm_state == 'running':
323 res['boot_state'] = 'ready';
325 res['boot_state'] = 'unknown'
326 resources.append(res)
328 result['geni_status'] = top_level_status
329 result['geni_resources'] = resources
332 def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
334 project_name = hrn_to_pl_slicename(slice_hrn)
335 aggregate = OSAggregate(self)
337 rspec = RSpec(rspec_string)
339 # ensure project and users exist in local db
340 aggregate.create_project(project_name, users, options=options)
342 # collect publick keys
346 pubkeys.extend(user['keys'])
347 # assume first user is the caller and use their context
348 # for the ec2/euca api connection. Also, use the first users
349 # key as the project key.
351 username = Xrn(user['urn']).get_leaf()
352 user_keys = self.shell.db.key_pair_get_all_by_user(username)
354 project_key = user_keys[0].name
356 # ensure person records exists
357 self.euca_shell.init_context(project_name)
358 aggregate.run_instances(project_name, rspec_string, project_key, pubkeys)
360 return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
362 def delete_sliver (self, slice_urn, slice_hrn, creds, options):
363 # we need to do this using the context of one of the slice users
364 project_name = hrn_to_pl_slicename(slice_hrn)
365 self.euca_shell.init_context(project_name)
366 aggregate = OSAggregate(self)
367 return aggregate.delete_instances(project_name)
369 def update_sliver(self, slice_urn, slice_hrn, rspec, creds, options):
370 name = hrn_to_pl_slicename(slice_hrn)
371 aggregate = OSAggregate(self)
372 return aggregate.update_instances(name)
374 def renew_sliver (self, slice_urn, slice_hrn, creds, expiration_time, options):
377 def start_slice (self, slice_urn, slice_hrn, creds):
380 def stop_slice (self, slice_urn, slice_hrn, creds):
381 name = OSXrn(xrn=slice_urn).name
382 aggregate = OSAggregate(self)
383 return aggregate.stop_instances(name)
385 def reset_slice (self, slice_urn, slice_hrn, creds):
386 raise SfaNotImplemented ("reset_slice not available at this interface")
388 # xxx this code is quite old and has not run for ages
389 # it is obviously totally broken and needs a rewrite
390 def get_ticket (self, slice_urn, slice_hrn, creds, rspec_string, options):
391 raise SfaNotImplemented,"OpenStackDriver.get_ticket needs a rewrite"
392 # please keep this code for future reference
393 # slices = PlSlices(self)
394 # peer = slices.get_peer(slice_hrn)
395 # sfa_peer = slices.get_sfa_peer(slice_hrn)
397 # # get the slice record
398 # credential = api.getCredential()
399 # interface = api.registries[api.hrn]
400 # registry = api.server_proxy(interface, credential)
401 # records = registry.Resolve(xrn, credential)
403 # # make sure we get a local slice record
405 # for tmp_record in records:
406 # if tmp_record['type'] == 'slice' and \
407 # not tmp_record['peer_authority']:
408 # #Error (E0602, GetTicket): Undefined variable 'SliceRecord'
409 # slice_record = SliceRecord(dict=tmp_record)
411 # raise RecordNotFound(slice_hrn)
413 # # similar to CreateSliver, we must verify that the required records exist
414 # # at this aggregate before we can issue a ticket
416 # rspec = RSpec(rspec_string)
417 # requested_attributes = rspec.version.get_slice_attributes()
419 # # ensure site record exists
420 # site = slices.verify_site(slice_hrn, slice_record, peer, sfa_peer)
421 # # ensure slice record exists
422 # slice = slices.verify_slice(slice_hrn, slice_record, peer, sfa_peer)
423 # # ensure person records exists
424 # # xxx users is undefined in this context
425 # persons = slices.verify_persons(slice_hrn, slice, users, peer, sfa_peer)
426 # # ensure slice attributes exists
427 # slices.verify_slice_attributes(slice, requested_attributes)
430 # slivers = slices.get_slivers(slice_hrn)
433 # raise SliverDoesNotExist(slice_hrn)
438 # 'timestamp': int(time.time()),
439 # 'initscripts': initscripts,
443 # # create the ticket
444 # object_gid = record.get_gid_object()
445 # new_ticket = SfaTicket(subject = object_gid.get_subject())
446 # new_ticket.set_gid_caller(api.auth.client_gid)
447 # new_ticket.set_gid_object(object_gid)
448 # new_ticket.set_issuer(key=api.key, subject=self.hrn)
449 # new_ticket.set_pubkey(object_gid.get_pubkey())
450 # new_ticket.set_attributes(data)
451 # new_ticket.set_rspec(rspec)
452 # #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
453 # new_ticket.encode()
456 # return new_ticket.save_to_string(save_parents=True)