Grid Portlets Resource Tags Reference

Resources are registered with Grid Portlets in the deployed $CATALINA_HOME/webapps/gridportlets/WEB-INF/Resources.xml file. Resources.xml looks like the following:

    <resources>
        <!-- Include hardware-resource entries here -->
    </resources>

        

At the top level, Resources.xml contains a list of hardware resource entries specifying the computing hosts Grid Portlets will make accessible to users. Inside these entries, other entries can be included to describe what resources those hosts contain. The complete list of resource tags that are provided by Grid Portlets are described here.

	Note
	Third party applications may also provide their own resource tags, in which case you should refer to their documentation.

    <resource-attribute name="<attribute-name-1>" value="<attribute-value-1"/>
    <resource-attribute name="<attribute-name-2>" value="<attribute-value-2"/>

                

    <hardware-resource hostname="<hostname>"
                       ipaddress="<optional-ipaddress>"
                       label="<label-to-display>"
                       description="<short-description>"
                       image1url="<url-to-image-of-resource>"
                       image1label="<label-for-image>"
                       htmlurl="<url-to-html-description-relative-to-gridportlets-context>">
        <!-- Include the following types of entries here:
                <service-resource>  - Any resource extending from service-resource
                <software-resource> - Any resource extending from software-resource
                <gram-job-schedulerer>  - Any gram job managers (see note below)
                <hardware-account>  - Hardware accounts
          -->
    </hardware-resource>

        

Hardware resource entries contain the following entries:

Hardware resource entries can contain attributes for specifying urls to an image and an html description to display in the Resource Browser Portlet, see the User's Guide for more information. The url for the image can be external to your web application server. However, url for the html description is must be relative to the Grid Portlets web application context. For example, you might deploy your html description file for a particular hardware resource to $CATALINA_HOME/webapps/gridportlets/html/myresource.html and then specify that file url in your hardware resource entry as /html/myresource.html. Here's an example involving the Peyote computing cluster at the Albert Einstein Institute:

    
    <hardware-resource label="Peyote"
                       description="Front-end to the AEI Peyote Cluster"
                       hostname="peyote.aei.mpg.de"
                       image1url="http://numrel.aei.mpg.de/Research/Peyote/Hardware/peyote-cabinets.jpg"
                       image1label="Peyote Cluster Cabinets"
                       htmlurl="/html/peyote.aei.mpg.de.html">
       <!-- Other entries below... -->
    </hardware-resource>
    
            

The following section describes the service resources that can be specified under hardware resources in the resource registry.

    
        <gram-resource port="<optional port if not on standard port>""/>
    
            

Gram (Globus) Job Manager

	Note
	For now, gram-job-schedulerer is contained under hardware-resource until we are able to implement the appropriate model. The right model would be to have a job-scheduler tag containded under hardware-resource. Then gram-job-schedulerer would be contained under gram-resource and considered a remote interface to job-scheduler.

    
        <gram-job-schedulerer name="<fork|pbs|lsf|condor>">
            <!-- Include <job-queue> entries here -->
        </gram-job-schedulerer>
    
            

• fork job managers enable job submission with fork.
• pbs job managers enable job submission to PBS.
• lsf job managers enable job submission to LSF.
• condor job managers enable job submission to Condor.

Job Queues

    
            <job-queue name="<name of queue>" nodes="<number of nodes>"/>
    
            

Job schedulers contain or more job queues, though the Fork Job Manager contains only one job queue (named "default"), and therefore does not take a job-queue entry. You may place job queue entries inside the PBS, LSF, or Condor job schedueler entries.

    
        <gridftp-resource port="<optional port if not on standard port>"">
        </gridftp-resource>
    
            

    
        <gris-resource port="<optional port if not on standard port>""/>
    
            

    
        <giis-resource port="<optional port if not on standard port>""/>
    
            

    
        <myproxy-resource port="<optional port if not on standard port>"
                          portalProxyFile="<path to generated proxy file>"
                          portalCertFile="<path to public certificate>"
                          portalKeyFile="<path to private key>"/>
    
            

Grid Portlets defines the concept of a "resource account", which is itself a resource. In principle, resource accounts could be defined for specific service resources or "software resources", but only one mapping has been defined so far in Grid Portlets. This is "hardware account" and its usage is shown below.

        
            <hardware-account userid="<userid on machine>"
                              homedir="<homedir on machine>"
                              usershell="<login shell>">
                <!-- Optional userdn entries
                    <userdn>/O=Grid/O=GridSphere/CN=Jane Doe</userdn> -->
            </hardware-account>
        
                

Grid Portlets defines the concept of a "software resource" to allow administrators and developers to associate applications or libraries with particular hardware resources. Its usage is shown below.

    
        <software-resource label="<some label>"
                           path="<full path to the application or library>"/>