sfa/managers/driver.py

   1 #
   2 # an attempt to document what a driver class should provide,
   3 # and implement reasonable defaults
   4 #
   5 import sys
   6 class Driver:
   7
   8     def __init__ (self, config):
   9         # this is the hrn attached to the running server
  10         self.hrn = config.SFA_INTERFACE_HRN
  11
  12     ########################################
  13     ########## registry oriented
  14     ########################################
  15
  16     # NOTE: the is_enabled method is deprecated
  17     # it was only making things confusing, as the (PL) import mechanism would
  18     # ignore not enabled users anyway..
  19
  20     # the following is used in Resolve (registry) when run in full mode
  21     #     after looking up the sfa db, we wish to be able to display
  22     #     testbed-specific info as well
  23     # this at minima should fill in the 'researcher' field for slice records
  24     # as this information is then used to compute rights
  25     # roadmap: there is an intention to redesign the SFA database so as to clear up
  26     # this constraint, based on the principle that SFA should not rely on the
  27     # testbed database to perform such a core operation (i.e. getting rights right)
  28     def augment_records_with_testbed_info (self, sfa_records):
  29         print >>sys.stderr, "  \r\n \r\n DRIVER.PY augment_records_with_testbed_info sfa_records ",sfa_records
  30         return sfa_records
  31
  32     # incoming record, as provided by the client to the Register API call
  33     # expected retcod 'pointer'
  34     # 'pointer' is typically an int db id, that makes sense in the testbed environment
  35     # -1 if this feature is not relevant
  36     def register (self, sfa_record, hrn, pub_key) :
  37         return -1
  38
  39     # incoming record is the existing sfa_record
  40     # expected retcod boolean, error message logged if result is False
  41     def remove (self, sfa_record):
  42         return True
  43
  44     # incoming are the sfa_record:
  45     # (*) old_sfa_record is what we have in the db for that hrn
  46     # (*) new_sfa_record is what was passed in the Update call
  47     # expected retcod boolean, error message logged if result is False
  48     # NOTE 1. about keys
  49     # this is confusing because a user may have several ssh keys in
  50     # the planetlab database, but we need to pick one to generate its cert
  51     # so as much as in principle we should be able to use new_sfa_record['keys']
  52     # the manager code actually picks one (the first one), and it seems safer
  53     # to pass it along rather than depending on the driver code to do the same
  54     #
  55     # NOTE 2. about keys
  56     # when changing the ssh key through this method the gid gets changed too
  57     # should anything be passed back to the caller in this case ?
  58     def update (self, old_sfa_record, new_sfa_record, hrn, new_key):
  59         return True
  60
  61     # callack for register/update
  62     # this allows to capture changes in the relations between objects
  63     # the ids below are the ones found in the 'pointer' field
  64     # this can get typically called with
  65     # 'slice' 'user' 'researcher' slice_id user_ids
  66     # 'authority' 'user' 'pi' authority_id user_ids
  67     def update_relation (self, subject_type, target_type, relation_name, subject_id, link_ids):
  68         pass
  69
  70     ########################################
  71     ########## aggregate oriented
  72     ########################################
  73
  74     # a name for identifying the kind of testbed
  75     def testbed_name (self): return "undefined"
  76
  77     # a dictionary that gets appended to the generic answer to GetVersion
  78     # 'geni_request_rspec_versions' and 'geni_ad_rspec_versions' are mandatory
  79     def aggregate_version (self): return {}
  80
  81     # the answer to ListSlices, a list of slice urns
  82     def list_slices (self, creds, options):
  83         return []
  84
  85     # answer to ListResources
  86     # first 2 args are None in case of resource discovery
  87     # expected : rspec (xml string)
  88     def list_resources (self, slice_urn, slice_hrn, creds, options):
  89         return "dummy Driver.list_resources needs to be redefined"
  90
  91     # the answer to SliverStatus on a given slice
  92     def sliver_status (self, slice_urn, slice_hrn): return {}
  93
  94     # the answer to CreateSliver on a given slice
  95     # expected to return a valid rspec
  96     # identical to ListResources after the slice was modified
  97     def create_sliver (self, slice_urn, slice_hrn, creds, rspec_string, users, options):
  98         return "dummy Driver.create_sliver needs to be redefined"
  99
 100     # the answer to DeleteSliver on a given slice
 101     def delete_sliver (self, slice_urn, slice_hrn, creds, options):
 102         return "dummy Driver.delete_sliver needs to be redefined"
 103
 104     # the answer to RenewSliver
 105     # expected to return a boolean to indicate success
 106     def renew_sliver (self, slice_urn, slice_hrn, creds, expiration_time, options):
 107         return False
 108
 109     # the answer to start_slice/stop_slice
 110     # 1 means success, otherwise raise exception
 111     def start_slice (self, slice_urn, slice_xrn, creds):
 112         return 1
 113     def stop_slice (self, slice_urn, slice_xrn, creds):
 114         return 1
 115     # somehow this one does not have creds - not implemented in PL anyways
 116     def reset_slice (self, slice_urn, slice_xrn, creds):
 117         return 1
 118
 119     # the answer to GetTicket
 120     # expected is a ticket, i.e. a certificate, as a string
 121     def get_ticket (self, slice_urn, slice_xrn, creds, rspec, options):
 122         return "dummy Driver.get_ticket needs to be redefined"
 123