self.authority = None
self.logger = sfi_logger
self.logger.enable_console()
+ ### various auxiliary material that we keep at hand
self.command=None
+ # need to call this other than just 'config' as we have a command/method with that name
+ self.config_instance=None
+ self.config_file=None
+ self.client_bootstrap=None
### suitable if no reasonable command has been provided
def print_commands_help (self, options):
print line
else:
print line
- self.create_parser().print_help()
- for (command, (doc, args_string, example)) in commands_dict.iteritems():
+ self.create_global_parser().print_help()
+ # preserve order from the code
+ for command in commands_list:
+ (doc, args_string, example) = commands_dict[command]
if verbose:
print line
doc=doc.replace("\n","\n"+35*' ')
print "\n==================== Specific usage for %s"%self.command
self.command_parser.print_help()
if example:
- print "\n==================== %s example"%self.command
+ print "\n==================== %s example(s)"%self.command
print example
+ def create_global_parser(self):
+ # Generate command line parser
+ parser = OptionParser(add_help_option=False,
+ usage="sfi [sfi_options] command [cmd_options] [cmd_args]",
+ description="Commands: %s"%(" ".join(commands_list)))
+ parser.add_option("-r", "--registry", dest="registry",
+ help="root registry", metavar="URL", default=None)
+ parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL",
+ help="slice API - in general a SM URL, but can be used to talk to an aggregate")
+ parser.add_option("-R", "--raw", dest="raw", default=None,
+ help="Save raw, unparsed server response to a file")
+ parser.add_option("", "--rawformat", dest="rawformat", type="choice",
+ help="raw file format ([text]|pickled|json)", default="text",
+ choices=("text","pickled","json"))
+ parser.add_option("", "--rawbanner", dest="rawbanner", default=None,
+ help="text string to write before and after raw output")
+ parser.add_option("-d", "--dir", dest="sfi_dir",
+ help="config & working directory - default is %default",
+ metavar="PATH", default=Sfi.default_sfi_dir())
+ parser.add_option("-u", "--user", dest="user",
+ help="user name", metavar="HRN", default=None)
+ parser.add_option("-a", "--auth", dest="auth",
+ help="authority name", metavar="HRN", default=None)
+ parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
+ help="verbose mode - cumulative")
+ parser.add_option("-D", "--debug",
+ action="store_true", dest="debug", default=False,
+ help="Debug (xml-rpc) protocol messages")
+ # would it make sense to use ~/.ssh/id_rsa as a default here ?
+ parser.add_option("-k", "--private-key",
+ action="store", dest="user_private_key", default=None,
+ help="point to the private key file to use if not yet installed in sfi_dir")
+ parser.add_option("-t", "--timeout", dest="timeout", default=None,
+ help="Amout of time to wait before timing out the request")
+ parser.add_option("-h", "--help",
+ action="store_true", dest="help", default=False,
+ help="one page summary on commands & exit")
+ parser.disable_interspersed_args()
+
+ return parser
+
+
def create_command_parser(self, command):
if command not in commands_dict:
msg="Invalid command\n"
parser.add_option ("-h","--help",dest='help',action='store_true',default=False,
help="Summary of one command usage")
+ if command in ("config"):
+ parser.add_option('-m', '--myslice', dest='myslice', action='store_true', default=False,
+ help='how myslice config variables as well')
+
if command in ("add", "update"):
parser.add_option('-x', '--xrn', dest='xrn', metavar='<xrn>', help='object hrn/urn (mandatory)')
parser.add_option('-t', '--type', dest='type', metavar='<type>', help='object type', default=None)
metavar="slice_hrn", help="delegate cred. for slice HRN")
parser.add_option("-a", "--auths", dest='delegate_auths',action='append',default=[],
metavar='auth_hrn', help="delegate cred for auth HRN")
- # this primarily is a shorthand for -a my_hrn^
+ # this primarily is a shorthand for -a my_hrn
parser.add_option("-p", "--pi", dest='delegate_pi', default=None, action='store_true',
help="delegate your PI credentials, so s.t. like -a your_hrn^")
parser.add_option("-A","--to-authority",dest='delegate_to_authority',action='store_true',default=False,
return parser
- def create_parser(self):
-
- # Generate command line parser
- parser = OptionParser(add_help_option=False,
- usage="sfi [sfi_options] command [cmd_options] [cmd_args]",
- description="Commands: %s"%(" ".join(commands_list)))
- parser.add_option("-r", "--registry", dest="registry",
- help="root registry", metavar="URL", default=None)
- parser.add_option("-s", "--sliceapi", dest="sm", default=None, metavar="URL",
- help="slice API - in general a SM URL, but can be used to talk to an aggregate")
- parser.add_option("-R", "--raw", dest="raw", default=None,
- help="Save raw, unparsed server response to a file")
- parser.add_option("", "--rawformat", dest="rawformat", type="choice",
- help="raw file format ([text]|pickled|json)", default="text",
- choices=("text","pickled","json"))
- parser.add_option("", "--rawbanner", dest="rawbanner", default=None,
- help="text string to write before and after raw output")
- parser.add_option("-d", "--dir", dest="sfi_dir",
- help="config & working directory - default is %default",
- metavar="PATH", default=Sfi.default_sfi_dir())
- parser.add_option("-u", "--user", dest="user",
- help="user name", metavar="HRN", default=None)
- parser.add_option("-a", "--auth", dest="auth",
- help="authority name", metavar="HRN", default=None)
- parser.add_option("-v", "--verbose", action="count", dest="verbose", default=0,
- help="verbose mode - cumulative")
- parser.add_option("-D", "--debug",
- action="store_true", dest="debug", default=False,
- help="Debug (xml-rpc) protocol messages")
- # would it make sense to use ~/.ssh/id_rsa as a default here ?
- parser.add_option("-k", "--private-key",
- action="store", dest="user_private_key", default=None,
- help="point to the private key file to use if not yet installed in sfi_dir")
- parser.add_option("-t", "--timeout", dest="timeout", default=None,
- help="Amout of time to wait before timing out the request")
- parser.add_option("-h", "--help",
- action="store_true", dest="help", default=False,
- help="one page summary on commands & exit")
- parser.disable_interspersed_args()
-
- return parser
-
-
#
# Main: parse arguments and dispatch to command
#
return method(command_options, command_args)
def main(self):
- self.sfi_parser = self.create_parser()
+ self.sfi_parser = self.create_global_parser()
(options, args) = self.sfi_parser.parse_args()
if options.help:
self.print_commands_help(options)
config.add_section('sfi')
# sface users should be able to use this same file to configure their stuff
config.add_section('sface')
- # manifold users should be able to specify their backend server here for sfi delegate
+ # manifold users should be able to specify the details
+ # of their backend server here for 'sfi myslice'
config.add_section('myslice')
config.load(config_file)
# back up old config
self.logger.log_exc("Could not read config file %s"%config_file)
sys.exit(1)
+ self.config_instance=config
errors = 0
# Set SliceMgr URL
if (self.options.sm is not None):
if errors:
sys.exit(1)
- def show_config (self):
- print "From configuration file %s"%self.config_file
- flags=[
- ('SFI_USER','user'),
- ('SFI_AUTH','authority'),
- ('SFI_SM','sm_url'),
- ('SFI_REGISTRY','reg_url'),
- ]
- for (external_name, internal_name) in flags:
- print "%s='%s'"%(external_name,getattr(self,internal_name))
-
#
# Get various credential and spec files
#
# Registry-related commands
#==========================================================================
+ @register_command("","")
+ def config (self, options, args):
+ "Display contents of current config"
+ print "# From configuration file %s"%self.config_file
+ flags=[ ('sfi', [ ('registry','reg_url'),
+ ('auth','authority'),
+ ('user','user'),
+ ('sm','sm_url'),
+ ]),
+ ]
+ if options.myslice:
+ flags.append ( ('myslice', ['backend', 'delegate', 'platform', 'username'] ) )
+
+ for (section, tuples) in flags:
+ print "[%s]"%section
+ try:
+ for (external_name, internal_name) in tuples:
+ print "%-20s = %s"%(external_name,getattr(self,internal_name))
+ except:
+ for name in tuples:
+ varname="%s_%s"%(section.upper(),name.upper())
+ value=getattr(self.config_instance,varname)
+ print "%-20s = %s"%(name,value)
+
@register_command("","")
def version(self, options, args):
"""
display an SFA server version (GetVersion)
-or version information about sfi itself
+ or version information about sfi itself
"""
if options.version_local:
version=version_core()
save_records_to_file(options.file, record_dicts, options.fileformat)
return
- @register_command("[record]","")
+ @register_command("[xml-filename]","")
def add(self, options, args):
- "add record into registry by using the command options (Recommended) or from xml file (Register)"
+ """add record into registry (Register)
+ from command line options (recommended)
+ old-school method involving an xml file still supported"""
+
auth_cred = self.my_authority_credential_string()
if options.show_credential:
show_credentials(auth_cred)
record_dict['last_name'] = record_dict['hrn']
return self.registry().Register(record_dict, auth_cred)
- @register_command("[record]","")
+ @register_command("[xml-filename]","")
def update(self, options, args):
- "update record into registry by using the command options (Recommended) or from xml file (Update)"
+ """update record into registry (Update)
+ from command line options (recommended)
+ old-school method involving an xml file still supported"""
record_dict = {}
if len(args) > 0:
record_filepath = args[0]
show_credentials(cred)
return self.registry().Update(record_dict, cred)
- @register_command("name","")
+ @register_command("hrn","")
def remove(self, options, args):
"remove registry record by name (Remove)"
auth_cred = self.my_authority_credential_string()
return
# show rspec for named slice
- @register_command("[slice_hrn]","")
+ @register_command("","")
def resources(self, options, args):
"""
discover available resources (ListResources)
@register_command("slice_hrn","")
def describe(self, options, args):
"""
- shows currently allocated/provisioned resources of the named slice or set of slivers (Describe)
+ shows currently allocated/provisioned resources
+ of the named slice or set of slivers (Describe)
"""
server = self.sliceapi()
self.logger.info("writing %s gid to %s" % (target_hrn, filename))
GID(string=gid).save_to_file(filename)
-
- @register_command("to_hrn","")
+ ####################
+ @register_command("to_hrn","""$ sfi delegate -u -p -s ple.inria.heartbeat -s ple.inria.omftest ple.upmc.slicebrowser
+
+ will locally create a set of delegated credentials for the benefit of ple.upmc.slicebrowser
+ the set of credentials in the scope for this call would be
+ (*) ple.inria.thierry_parmentelat.user_for_ple.upmc.slicebrowser.user.cred
+ as per -u/--user
+ (*) ple.inria.pi_for_ple.upmc.slicebrowser.user.cred
+ as per -p/--pi
+ (*) ple.inria.heartbeat.slice_for_ple.upmc.slicebrowser.user.cred
+ (*) ple.inria.omftest.slice_for_ple.upmc.slicebrowser.user.cred
+ because of the two -s options
+
+""")
def delegate (self, options, args):
"""
(locally) create delegate credential for use by given hrn
+ make sure to check for 'sfi myslice' instead if you plan
+ on using MySlice
"""
if len(args) != 1:
self.print_help()
self.logger.info("delegated credential for %s to %s and wrote to %s"%(message,to_hrn,filename))
####################
- @register_command("","""$ less +/myslice myslice sfi_config
+ @register_command("","""$ less +/myslice sfi_config
[myslice]
-backend = 'http://manifold.pl.sophia.inria.fr:7080'
-delegate = 'ple.upmc.slicebrowser'
-user = 'thierry'
+backend = http://manifold.pl.sophia.inria.fr:7080
+# the HRN that myslice uses, so that we are delegating to
+delegate = ple.upmc.slicebrowser
+# platform - this is a myslice concept
+platform = ple
+# username - as of this writing (May 2013) a simple login name
+username = thierry
$ sfi myslice
-
will first collect the slices that you are part of, then make sure
- all your credentials are up-to-date (that is: refresh expired ones)
+ all your credentials are up-to-date (read: refresh expired ones)
then compute delegated credentials for user 'ple.upmc.slicebrowser'
- and upload them all on myslice backend, using manifold id as
- specified in 'user'
+ and upload them all on myslice backend, using 'platform' and 'user'.
+ A password will be prompted for the upload part.
+
+$ sfi -v myslice -- or sfi -vv myslice
+ same but with more and more verbosity
+
+$ sfi m
+ is synonym to sfi myslice as no other command starts with an 'm'
"""
-)
+) # register_command
def myslice (self, options, args):
""" This helper is for refreshing your credentials at myslice; it will
if len(args)>0:
self.print_help()
sys.exit(1)
- # ManifoldUploader
- pass
- @register_command("cred","")
+ ### the rough sketch goes like this
+ # (a) rain check for sufficient config in sfi_config
+ # we don't allow to override these settings for now
+ myslice_dict={}
+ myslice_keys=['backend', 'delegate', 'platform', 'username']
+ for key in myslice_keys:
+ full_key="MYSLICE_" + key.upper()
+ value=getattr(self.config_instance,full_key,None)
+ if value: myslice_dict[key]=value
+ else: print "Unsufficient config, missing key %s in [myslice] section of sfi_config"%key
+ if len(myslice_dict) != len(myslice_keys):
+ sys.exit(1)
+
+ # (b) figure whether we are PI for the authority where we belong
+ sfi_logger.info("Resolving our own id")
+ my_records=self.registry().Resolve(self.user,self.my_credential_string)
+ if len(my_records)!=1: print "Cannot Resolve %s -- exiting"%self.user; sys.exit(1)
+ my_record=my_records[0]
+ my_auths = my_record['reg-pi-authorities']
+ sfi_logger.info("Found %d authorities that we are PI for"%len(my_auths))
+ sfi_logger.debug("They are %s"%(my_auths))
+
+ # (c) get the set of slices that we are in
+ my_slices=my_record['reg-slices']
+ sfi_logger.info("Found %d slices that we are member of"%len(my_slices))
+ sfi_logger.debug("They are: %s"%(my_slices))
+
+ # (d) make sure we have *valid* credentials for all these
+ hrn_credentials=[]
+ hrn_credentials.append ( (self.user, 'user', self.my_credential_string,) )
+ for auth_hrn in my_auths:
+ hrn_credentials.append ( (auth_hrn, 'auth', self.authority_credential_string(auth_hrn),) )
+ for slice_hrn in my_slices:
+ hrn_credentials.append ( (slice_hrn, 'slice', self.slice_credential_string (slice_hrn),) )
+
+ # (e) check for the delegated version of these
+ # xxx todo add an option -a/-A? like for 'sfi delegate' for when we ever
+ # switch to myslice using an authority instead of a user
+ delegatee_type='user'
+ delegatee_hrn=myslice_dict['delegate']
+ hrn_delegated_credentials = []
+ for (hrn, htype, credential) in hrn_credentials:
+ sfi_logger.info("Computing delegated credential for %s (%s)"%(hrn,htype))
+ hrn_delegated_credentials.append ((hrn, htype, self.client_bootstrap.delegate_credential_string (credential, delegatee_hrn, delegatee_type),))
+
+ # (f) and finally upload them to manifold server
+ # xxx todo add an option so the password can be set on the command line
+ # (but *NOT* in the config file) so other apps can leverage this
+ uploader = ManifoldUploader (logger=sfi_logger,
+ url=myslice_dict['backend'],
+ platform=myslice_dict['platform'],
+ username=myslice_dict['username'])
+ uploader.prompt_all()
+ for (hrn,htype,delegated_credential) in hrn_delegated_credentials:
+ sfi_logger.info("Uploading delegated credential for %s (%s)"%(hrn,htype))
+ uploader.upload(delegated_credential,message=hrn)
+ # at first I thought we would want to save these,
+ # like 'sfi delegate does' but on second thought
+ # it is probably not helpful as people would not
+ # need to run 'sfi delegate' at all anymore
+ return
+
+# Thierry: I'm turning this off as a command, no idea what it's used for
+# @register_command("cred","")
def trusted(self, options, args):
"""
return the trusted certs at this interface (get_trusted_certs)
self.logger.debug('Sfi.trusted -> %r'%cert.get_subject())
return
- @register_command("","")
- def config (self, options, args):
- "Display contents of current config"
- self.show_config()