self.authority = None
self.logger = sfi_logger
self.logger.enable_console()
+ ### various auxiliary material that we keep at hand
self.command=None
- self.config=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()
+ self.create_parser_global().print_help()
# preserve order from the code
for command in commands_list:
(doc, args_string, example) = commands_dict[command]
doc=doc.replace("\n","\n"+35*' ')
print format3%(command,args_string,doc)
if verbose:
- self.create_command_parser(command).print_help()
+ self.create_parser_command(command).print_help()
### now if a known command was found we can be more verbose on that one
def print_help (self):
print "\n==================== %s example(s)"%self.command
print example
- def create_command_parser(self, command):
+ def create_parser_global(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_parser_command(self, command):
if command not in commands_dict:
msg="Invalid command\n"
msg+="Commands: "
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 ("version"):
+ parser.add_option("-R","--registry-version",
+ action="store_true", dest="version_registry", default=False,
+ help="probe registry version instead of sliceapi")
+ parser.add_option("-l","--local",
+ action="store_true", dest="version_local", default=False,
+ help="display version of the local client")
+
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)
"authority in set of credentials for this call")
# show_credential option
- if command in ("list","resources", "describe", "provision", "allocate", "add","update","remove","slices","delete","status","renew"):
+ if command in ("list","resources", "describe", "provision", "allocate", "add","update","remove","delete","status","renew"):
parser.add_option("-C","--credential",dest='show_credential',action='store_true',default=False,
help="show credential(s) used in human-readable form")
# registy filter option
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,
help="""by default the mandatory argument is expected to be a user,
use this if you mean an authority instead""")
-
- if command in ("version"):
- parser.add_option("-R","--registry-version",
- action="store_true", dest="version_registry", default=False,
- help="probe registry version instead of sliceapi")
- parser.add_option("-l","--local",
- action="store_true", dest="version_local", default=False,
- help="display version of the local client")
-
- return parser
+ if command in ("myslice"):
+ parser.add_option("-p","--password",dest='password',action='store',default=None,
+ help="specify mainfold password on the command line")
+ parser.add_option("-s", "--slice", dest="delegate_slices",action='append',default=[],
+ 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 PI cred for auth HRN")
- 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_parser_global()
(options, args) = self.sfi_parser.parse_args()
if options.help:
self.print_commands_help(options)
sys.exit(1)
# second pass options parsing
self.command=command
- self.command_parser = self.create_command_parser(command)
+ self.command_parser = self.create_parser_command(command)
(command_options, command_args) = self.command_parser.parse_args(args[1:])
if command_options.help:
self.print_help()
self.logger.log_exc("Could not read config file %s"%config_file)
sys.exit(1)
- self.config=config
+ 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
#
self.private_key = client_bootstrap.private_key()
self.my_credential_string = client_bootstrap.my_credential_string ()
self.my_credential = {'geni_type': 'geni_sfa',
- 'geni_version': '3.0',
+ 'geni_version': '3',
'geni_value': self.my_credential_string}
self.my_gid = client_bootstrap.my_gid ()
self.client_bootstrap = client_bootstrap
def slice_credential(self, name):
return {'geni_type': 'geni_sfa',
- 'geni_version': '3.0',
+ 'geni_version': '3',
'geni_value': self.slice_credential_string(name)}
# xxx should be supported by sfaclientbootstrap as well
@register_command("","")
def config (self, options, args):
"Display contents of current config"
- self.show_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):
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()
# Slice-related commands
# ==================================================================
- @register_command("","")
- def slices(self, options, args):
- "list instantiated slices (ListSlices) - returns urn's"
- server = self.sliceapi()
- # creds
- creds = [self.my_credential_string]
- # options and call_id when supported
- api_options = {}
- api_options['call_id']=unique_call_id()
- if options.show_credential:
- show_credentials(creds)
- result = server.ListSlices(creds, *self.ois(server,api_options))
- value = ReturnValue.get_value(result)
- if self.options.raw:
- save_raw_to_file(result, self.options.raw, self.options.rawformat, self.options.rawbanner)
- else:
- display_list(value)
- return
-
# show rspec for named slice
@register_command("","")
def resources(self, options, args):
# just request the version the client wants
api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
else:
- api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
+ api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
else:
- api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
+ api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
result = server.ListResources (creds, api_options)
value = ReturnValue.get_value(result)
if self.options.raw:
'cached': True,
'info': options.info,
'list_leases': options.list_leases,
- 'geni_rspec_version': {'type': 'geni', 'version': '3.0'},
+ 'geni_rspec_version': {'type': 'geni', 'version': '3'},
}
if options.rspec_version:
version_manager = VersionManager()
# just request the version the client wants
api_options['geni_rspec_version'] = version_manager.get_version(options.rspec_version).to_dict()
else:
- api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3.0'}
+ api_options['geni_rspec_version'] = {'type': 'geni', 'version': '3'}
urn = Xrn(args[0], type='slice').get_urn()
result = server.Describe([urn], creds, api_options)
value = ReturnValue.get_value(result)
rspec = open(rspec_file).read()
api_options = {}
api_options ['call_id'] = unique_call_id()
+ # users
+ sfa_users = []
+ geni_users = []
+ slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
+ if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']!=[]:
+ slice_record = slice_records[0]
+ user_hrns = slice_record['reg-researchers']
+ user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns]
+ user_records = self.registry().Resolve(user_urns, [self.my_credential_string])
+ sfa_users = sfa_users_arg(user_records, slice_record)
+ geni_users = pg_users_arg(user_records)
+
+ api_options['sfa_users'] = sfa_users
+ api_options['geni_users'] = geni_users
+
result = server.Allocate(slice_urn, creds, rspec, api_options)
value = ReturnValue.get_value(result)
if self.options.raw:
# set the requtested rspec version
version_manager = VersionManager()
- rspec_version = version_manager._get_version('geni', '3.0').to_dict()
+ rspec_version = version_manager._get_version('geni', '3').to_dict()
api_options['geni_rspec_version'] = rspec_version
# users
# }]
users = []
slice_records = self.registry().Resolve(slice_urn, [self.my_credential_string])
- if slice_records and 'researcher' in slice_records[0] and slice_records[0]['researcher']!=[]:
+ if slice_records and 'reg-researchers' in slice_records[0] and slice_records[0]['reg-researchers']!=[]:
slice_record = slice_records[0]
- user_hrns = slice_record['researcher']
+ user_hrns = slice_record['reg-researchers']
user_urns = [hrn_to_urn(hrn, 'user') for hrn in user_hrns]
user_records = self.registry().Resolve(user_urns, [self.my_credential_string])
users = pg_users_arg(user_records)
self.logger.info("writing %s gid to %s" % (target_hrn, filename))
GID(string=gid).save_to_file(filename)
-
+ ####################
@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
####################
@register_command("","""$ less +/myslice sfi_config
[myslice]
-backend = 'http://manifold.pl.sophia.inria.fr:7080'
+backend = http://manifold.pl.sophia.inria.fr:7080
# the HRN that myslice uses, so that we are delegating to
-delegate = 'ple.upmc.slicebrowser'
+delegate = ple.upmc.slicebrowser
# platform - this is a myslice concept
-platform = 'ple'
+platform = ple
# username - as of this writing (May 2013) a simple login name
-user = 'thierry'
+username = thierry
$ sfi myslice
-
will first collect the slices that you are part of, then make sure
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 '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):
if len(args)>0:
self.print_help()
sys.exit(1)
- # ManifoldUploader
- pass
+ ### 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
+ self.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_all = my_record['reg-pi-authorities']
+ self.logger.info("Found %d authorities that we are PI for"%len(my_auths_all))
+ self.logger.debug("They are %s"%(my_auths_all))
+
+ my_auths = my_auths_all
+ if options.delegate_auths:
+ my_auths = list(set(my_auths_all).intersection(set(options.delegate_auths)))
+
+ self.logger.info("Delegate PI creds for authorities: %s"%my_auths )
+ # (c) get the set of slices that we are in
+ my_slices_all=my_record['reg-slices']
+ self.logger.info("Found %d slices that we are member of"%len(my_slices_all))
+ self.logger.debug("They are: %s"%(my_slices_all))
+
+ my_slices = my_slices_all
+ if options.delegate_slices:
+ my_slices = list(set(my_slices_all).intersection(set(options.delegate_slices)))
+
+ self.logger.info("Delegate slice creds for slices: %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:
+ delegated_credential = self.client_bootstrap.delegate_credential_string (credential, delegatee_hrn, delegatee_type)
+ hrn_delegated_credentials.append ((hrn, htype, delegated_credential, ))
+
+ # (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=self.logger,
+ url=myslice_dict['backend'],
+ platform=myslice_dict['platform'],
+ username=myslice_dict['username'],
+ password=options.password)
+ uploader.prompt_all()
+ (count_all,count_success)=(0,0)
+ for (hrn,htype,delegated_credential) in hrn_delegated_credentials:
+ # inspect
+ inspect=Credential(string=delegated_credential)
+ expire_datetime=inspect.get_expiration()
+ message="%s (%s) [exp:%s]"%(hrn,htype,expire_datetime)
+ if uploader.upload(delegated_credential,message=message):
+ count_success+=1
+ count_all+=1
+
+ self.logger.info("Successfully uploaded %d/%d credentials"%(count_success,count_all))
+ # 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
+ if count_success != count_all: sys.exit(1)
+ return
-# Thierry: I'm turning this off, no idea what it's used for
+# Thierry: I'm turning this off as a command, no idea what it's used for
# @register_command("cred","")
def trusted(self, options, args):
"""
git://git.onelab.eu / sfa.git / blobdiff