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.planetlab.plxrn import PlXrn
13 from sfa.openstack.osxrn import hrn_to_os_slicename
14 from sfa.util.cache import Cache
15 from sfa.trust.credential import Credential
16 # used to be used in get_ticket
17 #from sfa.trust.sfaticket import SfaTicket
19 from sfa.rspecs.version_manager import VersionManager
20 from sfa.rspecs.rspec import RSpec
22 # the driver interface, mostly provides default behaviours
23 from sfa.managers.driver import Driver
24 from sfa.openstack.nova_shell import NovaShell
25 from sfa.openstack.euca_shell import EucaShell
26 from sfa.openstack.osaggregate import OSAggregate
27 from sfa.planetlab.plslices import PlSlices
28 from sfa.util.osxrn import OSXrn
31 def list_to_dict(recs, key):
33 convert a list of dictionaries into a dictionary keyed on the
34 specified dictionary key
36 return dict ( [ (rec[key],rec) for rec in recs ] )
39 # PlShell is just an xmlrpc serverproxy where methods
40 # can be sent as-is; it takes care of authentication
41 # from the global config
43 class NovaDriver (Driver):
45 # the cache instance is a class member so it survives across incoming requests
48 def __init__ (self, config):
49 Driver.__init__ (self, config)
50 self.shell = NovaShell (config)
51 self.euca_shell = EucaShell(config)
53 if config.SFA_AGGREGATE_CACHING:
54 if NovaDriver.cache is None:
55 NovaDriver.cache = Cache()
56 self.cache = NovaDriver.cache
58 ########################################
59 ########## registry oriented
60 ########################################
62 ########## disabled users
63 def is_enabled (self, record):
64 # all records are enabled
67 def augment_records_with_testbed_info (self, sfa_records):
68 return self.fill_record_info (sfa_records)
71 def register (self, sfa_record, hrn, pub_key):
72 type = sfa_record['type']
74 #pl_record = self.sfa_fields_to_pl_fields(type dd , hrn, sfa_record)
77 # add slice description, name, researchers, PI
78 name = hrn_to_os_slicename(hrn)
79 researchers = sfa_record.get('researchers', [])
80 pis = sfa_record.get('pis', [])
81 project_manager = None
82 description = sfa_record.get('description', None)
84 project_manager = Xrn(pis[0], 'user').get_leaf()
86 project_manager = Xrn(researchers[0], 'user').get_leaf()
87 if not project_manager:
88 err_string = "Cannot create a project without a project manager. " + \
89 "Please specify at least one PI or researcher for project: " + \
91 raise SfaInvalidArgument(err_string)
93 users = [Xrn(user, 'user').get_leaf() for user in \
95 self.shell.auth_manager.create_project(name, project_manager, description, users)
98 # add person roles, projects and keys
99 name = Xrn(hrn).get_leaf()
100 self.shell.auth_manager.create_user(name)
101 projects = sfa_records.get('slices', [])
102 for project in projects:
103 project_name = Xrn(project).get_leaf()
104 self.shell.auth_manager.add_to_project(name, project_name)
105 keys = sfa_records.get('keys', [])
112 self.shell.db.key_pair_create(key_dict)
117 # xxx actually old_sfa_record comes filled with plc stuff as well in the original code
118 def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
119 type = new_sfa_record['type']
121 # new_key implemented for users only
122 if new_key and type not in [ 'user' ]:
123 raise UnknownSfaType(type)
125 elif type == "slice":
126 # can update project manager and description
127 name = hrn_to_os_slicename(hrn)
128 researchers = sfa_record.get('researchers', [])
129 pis = sfa_record.get('pis', [])
130 project_manager = None
131 description = sfa_record.get('description', None)
133 project_manager = Xrn(pis[0], 'user').get_leaf()
135 project_manager = Xrn(researchers[0], 'user').get_leaf()
136 self.shell.auth_manager.modify_project(name, project_manager, description)
139 # can techinally update access_key and secret_key,
140 # but that is not in our scope, so we do nothing.
146 def remove (self, sfa_record):
147 type=sfa_record['type']
149 name = Xrn(sfa_record['hrn']).get_leaf()
150 if self.shell.auth_manager.get_user(name):
151 self.shell.auth_manager.delete_user(name)
152 elif type == 'slice':
153 name = hrn_to_os_slicename(sfa_record['hrn'])
154 if self.shell.auth_manager.get_project(name):
155 self.shell.auth_manager.delete_project(name)
160 def fill_record_info(self, records):
162 Given a (list of) SFA record, fill in the PLC specific
163 and SFA specific fields in the record.
165 if not isinstance(records, list):
168 for record in records:
170 if record['type'] == 'user':
171 name = Xrn(record['hrn']).get_leaf()
172 os_record = self.shell.auth_manager.get_user(name)
173 projects = self.shell.db.project_get_by_user(name)
174 record['slices'] = [self.hrn + "." + proj.name for \
176 record['roles'] = self.shell.db.user_get_roles(name)
177 keys = self.shell.db.key_pair_get_all_by_user(name)
178 record['keys'] = [key.public_key for key in keys]
179 elif record['type'] == 'slice':
180 name = hrn_to_os_slicename(record['hrn'])
181 os_record = self.shell.auth_manager.get_project(name)
182 record['description'] = os_record.description
183 record['PI'] = [self.hrn + "." + os_record.project_manager.name]
184 record['geni_creator'] = record['PI']
185 record['researcher'] = [self.hrn + "." + user for \
186 user in os_record.member_ids]
189 record['geni_urn'] = hrn_to_urn(record['hrn'], record['type'])
190 record['geni_certificate'] = record['gid']
191 record['name'] = os_record.name
192 #if os_record.created_at is not None:
193 # record['date_created'] = datetime_to_string(utcparse(os_record.created_at))
194 #if os_record.updated_at is not None:
195 # record['last_updated'] = datetime_to_string(utcparse(os_record.updated_at))
201 # plcapi works by changes, compute what needs to be added/deleted
202 def update_relation (self, subject_type, target_type, subject_id, target_ids):
203 # hard-wire the code for slice/user for now, could be smarter if needed
204 if subject_type =='slice' and target_type == 'user':
205 subject=self.shell.project_get(subject_id)[0]
206 current_target_ids = [user.name for user in subject.members]
207 add_target_ids = list ( set (target_ids).difference(current_target_ids))
208 del_target_ids = list ( set (current_target_ids).difference(target_ids))
209 logger.debug ("subject_id = %s (type=%s)"%(subject_id,type(subject_id)))
210 for target_id in add_target_ids:
211 self.shell.project_add_member(target_id,subject_id)
212 logger.debug ("add_target_id = %s (type=%s)"%(target_id,type(target_id)))
213 for target_id in del_target_ids:
214 logger.debug ("del_target_id = %s (type=%s)"%(target_id,type(target_id)))
215 self.shell.project_remove_member(target_id, subject_id)
217 logger.info('unexpected relation to maintain, %s -> %s'%(subject_type,target_type))
220 ########################################
221 ########## aggregate oriented
222 ########################################
224 def testbed_name (self): return "openstack"
226 # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
227 def aggregate_version (self):
228 version_manager = VersionManager()
229 ad_rspec_versions = []
230 request_rspec_versions = []
231 for rspec_version in version_manager.versions:
232 if rspec_version.content_type in ['*', 'ad']:
233 ad_rspec_versions.append(rspec_version.to_dict())
234 if rspec_version.content_type in ['*', 'request']:
235 request_rspec_versions.append(rspec_version.to_dict())
237 'testbed':self.testbed_name(),
238 'geni_request_rspec_versions': request_rspec_versions,
239 'geni_ad_rspec_versions': ad_rspec_versions,
242 def list_slices (self, creds, options):
243 # look in cache first
245 slices = self.cache.get('slices')
247 logger.debug("OpenStackDriver.list_slices returns from cache")
251 projs = self.shell.auth_manager.get_projects()
252 slice_urns = [OSXrn(proj.name, 'slice').urn for proj in projs]
256 logger.debug ("OpenStackDriver.list_slices stores value in cache")
257 self.cache.add('slices', slice_urns)
261 # first 2 args are None in case of resource discovery
262 def list_resources (self, slice_urn, slice_hrn, creds, options):
263 cached_requested = options.get('cached', True)
265 version_manager = VersionManager()
266 # get the rspec's return format from options
267 rspec_version = version_manager.get_version(options.get('geni_rspec_version'))
268 version_string = "rspec_%s" % (rspec_version)
270 #panos adding the info option to the caching key (can be improved)
271 if options.get('info'):
272 version_string = version_string + "_"+options.get('info', 'default')
274 # look in cache first
275 if cached_requested and self.cache and not slice_hrn:
276 rspec = self.cache.get(version_string)
278 logger.debug("OpenStackDriver.ListResources: returning cached advertisement")
281 #panos: passing user-defined options
282 #print "manager options = ",options
283 aggregate = OSAggregate(self)
284 rspec = aggregate.get_rspec(slice_xrn=slice_urn, version=rspec_version,
288 if self.cache and not slice_hrn:
289 logger.debug("OpenStackDriver.ListResources: stores advertisement in cache")
290 self.cache.add(version_string, rspec)
294 def sliver_status (self, slice_urn, slice_hrn):
295 # find out where this slice is currently running
296 project_name = hrn_to_os_slicename(slice_hrn)
297 project = self.shell.auth_manager.get_project(project_name)
298 instances = self.shell.db.instance_get_all_by_project(project_name)
299 if len(instances) == 0:
300 raise SliverDoesNotExist("You have not allocated any slivers here")
303 top_level_status = 'unknown'
305 top_level_status = 'ready'
306 result['geni_urn'] = slice_urn
307 result['plos_login'] = 'root'
308 result['plos_expires'] = None
311 for instance in instances:
313 # instances are accessed by ip, not hostname. We need to report the ip
314 # somewhere so users know where to ssh to.
315 res['plos_hostname'] = instance.hostname
316 res['plos_created_at'] = datetime_to_string(utcparse(instance.created_at))
317 res['plos_boot_state'] = instance.vm_state
318 res['plos_sliver_type'] = instance.instance_type.name
319 sliver_id = Xrn(slice_urn).get_sliver_id(instance.project_id, \
320 instance.hostname, instance.id)
321 res['geni_urn'] = sliver_id
323 if instance.vm_state == 'running':
324 res['boot_state'] = 'ready';
326 res['boot_state'] = 'unknown'
327 resources.append(res)
329 result['geni_status'] = top_level_status
330 result['geni_resources'] = resources
333 def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
335 project_name = hrn_to_os_slicename(slice_hrn)
336 aggregate = OSAggregate(self)
338 rspec = RSpec(rspec_string)
340 # ensure project and users exist in local db
341 aggregate.create_project(project_name, users, options=options)
343 # collect publick keys
347 pubkeys.extend(user['keys'])
348 # assume first user is the caller and use their context
349 # for the ec2/euca api connection. Also, use the first users
350 # key as the project key.
352 username = Xrn(user['urn']).get_leaf()
353 user_keys = self.shell.db.key_pair_get_all_by_user(username)
355 project_key = user_keys[0].name
357 # ensure person records exists
358 self.euca_shell.init_context(project_name)
359 aggregate.run_instances(project_name, rspec_string, project_key, pubkeys)
361 return aggregate.get_rspec(slice_xrn=slice_urn, version=rspec.version)
363 def delete_sliver (self, slice_urn, slice_hrn, creds, options):
364 # we need to do this using the context of one of the slice users
365 project_name = hrn_to_os_slicename(slice_hrn)
366 self.euca_shell.init_context(project_name)
367 aggregate = OSAggregate(self)
368 return aggregate.delete_instances(project_name)
370 def update_sliver(self, slice_urn, slice_hrn, rspec, creds, options):
371 name = hrn_to_os_slicename(slice_hrn)
372 aggregate = OSAggregate(self)
373 return aggregate.update_instances(name)
375 def renew_sliver (self, slice_urn, slice_hrn, creds, expiration_time, options):
378 def start_slice (self, slice_urn, slice_hrn, creds):
381 def stop_slice (self, slice_urn, slice_hrn, creds):
382 name = OSXrn(xrn=slice_urn).name
383 aggregate = OSAggregate(self)
384 return aggregate.stop_instances(name)
386 def reset_slice (self, slice_urn, slice_hrn, creds):
387 raise SfaNotImplemented ("reset_slice not available at this interface")
389 # xxx this code is quite old and has not run for ages
390 # it is obviously totally broken and needs a rewrite
391 def get_ticket (self, slice_urn, slice_hrn, creds, rspec_string, options):
392 raise SfaNotImplemented,"OpenStackDriver.get_ticket needs a rewrite"
393 # please keep this code for future reference
394 # slices = PlSlices(self)
395 # peer = slices.get_peer(slice_hrn)
396 # sfa_peer = slices.get_sfa_peer(slice_hrn)
398 # # get the slice record
399 # credential = api.getCredential()
400 # interface = api.registries[api.hrn]
401 # registry = api.server_proxy(interface, credential)
402 # records = registry.Resolve(xrn, credential)
404 # # make sure we get a local slice record
406 # for tmp_record in records:
407 # if tmp_record['type'] == 'slice' and \
408 # not tmp_record['peer_authority']:
409 # #Error (E0602, GetTicket): Undefined variable 'SliceRecord'
410 # slice_record = SliceRecord(dict=tmp_record)
412 # raise RecordNotFound(slice_hrn)
414 # # similar to CreateSliver, we must verify that the required records exist
415 # # at this aggregate before we can issue a ticket
417 # rspec = RSpec(rspec_string)
418 # requested_attributes = rspec.version.get_slice_attributes()
420 # # ensure site record exists
421 # site = slices.verify_site(slice_hrn, slice_record, peer, sfa_peer)
422 # # ensure slice record exists
423 # slice = slices.verify_slice(slice_hrn, slice_record, peer, sfa_peer)
424 # # ensure person records exists
425 # # xxx users is undefined in this context
426 # persons = slices.verify_persons(slice_hrn, slice, users, peer, sfa_peer)
427 # # ensure slice attributes exists
428 # slices.verify_slice_attributes(slice, requested_attributes)
431 # slivers = slices.get_slivers(slice_hrn)
434 # raise SliverDoesNotExist(slice_hrn)
439 # 'timestamp': int(time.time()),
440 # 'initscripts': initscripts,
444 # # create the ticket
445 # object_gid = record.get_gid_object()
446 # new_ticket = SfaTicket(subject = object_gid.get_subject())
447 # new_ticket.set_gid_caller(api.auth.client_gid)
448 # new_ticket.set_gid_object(object_gid)
449 # new_ticket.set_issuer(key=api.key, subject=self.hrn)
450 # new_ticket.set_pubkey(object_gid.get_pubkey())
451 # new_ticket.set_attributes(data)
452 # new_ticket.set_rspec(rspec)
453 # #new_ticket.set_parent(api.auth.hierarchy.get_auth_ticket(auth_hrn))
454 # new_ticket.encode()
457 # return new_ticket.save_to_string(save_parents=True)