Changes between Version 8 and Version 9 of FeddSkelPlugin


Ignore:
Timestamp:
Jun 27, 2010 11:35:52 AM (14 years ago)
Author:
faber
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • FeddSkelPlugin

    v8 v9  
    11= The Plug-in Skeleton =
    22
    3 The federation distribution includes a functional skeletion that illustrates handling the [FeddPluginCalls interface calls] though it does not manipulate any external testbed.  It does illustrate most of the support for creating plug-ins, including reading configuration files, creating access control databases that map to local permission structures, storing persistent state and allocating local resources.  The skeleton merely assigns an non-negative integer to each request.  The range of integers is set from a configuration file.
     3The federation distribution includes a functional skeleton that illustrates handling the [FeddPluginCalls interface calls] though it does not manipulate any external testbed.  It does illustrate most of the support for creating plug-ins, including reading configuration files, creating access control databases that map to local permission structures, storing persistent state and allocating local resources.  The skeleton merely assigns an non-negative integer to each request.  The range of integers is set from a configuration file.
    44
    5 This page describes how to set-up and run the skeleton plug-in, as well as what it does.
     5This page describes how to set-up and run the skeleton plug-in, as well as what it does.  First, [FeddDownload install] the fedd software and its dependencies.  Then configure it as below.
    66
    77== Configuration ==
    … …  
    3737In a real installation, including such passwords in the configuration file implies that the configuration file must be secured.
    3838
    39 The next section explains the contents of the configuration files in more detail, but you can skip ahead to running the plug-in if you perfer.
     39The next sections explains the contents of the configuration files in more detail, but you can skip ahead to [FeddSkelPlugin#RunningTheSkeleton running the plug-in] if you perfer.
    4040
    4141== Configuration File Contents ==
    … …  
    7474The two or three parameters in this section control overall operation of the plug-in, specifically what prinicpal ID (that is which [FeddAbout#GlobalIdentifiers:Fedids fedid]) it uses and what TCP port it provides services on.  '''cert_file''' and '''cert_pwd''' select the X.509 certificate and encyrption password, if any, used to identify the plug-in.  The '''services''' parameter controls which ports and transports are used.  The sample file serves SOAP traffic on port 13230. [FeddConfig#GlobalOptions Other choices] are possible.
    7575
     76The '''access_type''' parameter chooses the type of access controller to run, in this case '''skel''' for the skeleton controller.
     77
    7678== The Access Database ==
    7779
    … …  
    8284The rest of the line gives that user access permissions and the local permission state '''Local_attr'''.  This is more to show how to assign such allocations, which will be meaningful in real installations.  For example, see the configurations of other plug-ins.
    8385
     86== Running the Skeleton ==
    8487
     88To start the plug-in, assuming that the configuration files are in {{{/usr/local/etc/skel}}} run the command:
    8589
    86    
     90{{{
     91$ fedd.py --config=/usr/local/etc/skel.conf --debug
     92}}}
     93
     94This assumes you have properly installed fedd and that fedd.py is in your path.  You will see a few log messages indicating that the access and state databases have been read or are not yet created.
     95
     96To see the skeleton do something