sfa/managers/driver.py

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