XSEDE GSI OpenSSH Service Availability Publishing
=============================================

XSEDE service providers (SPs) must publish information about GSI OpenSSH services they
want XSEDE users to be able to discover and use.

All the information that SPs publish about services, including GSI OpenSSH services, is
entered by SPs into text files on their resources. Information in these files is in
a standard format defined by the IPF package used to publish software and service
information into XSEDE central information services.

Steps for creating and updating a GSI OpenSSH service published information file.

1. Create a file for each unique GSI OpenSSH endpoint with the contents of the example
   below, by copying a previous similar file, or by copying a TeraGrid kit GSI OpenSSH
   service publishing file (see “NOTE about TeraGrid compatibility” below).
   Each unique hostname plus port is a unique GSI OpenSSH endpoint.

   All XSEDE service publishing files live in a single directory. We recommend 
   /etc/ipf/services/ (or $IPF/etc/services if your IPF was a non-RPM install),
   though you could place them anywhere. This directory must match the SERVICEPATH
   configured during the IPF installation.

   The file can have any unique name, though we recommend this name format:
      “org.globus.openssh-<version>[-<optional_suffix>].conf

   Each non-comment line should have the format “keyword = value”, where value is
   double quoted if it contains special characters.

Example of a GSI OpenSSH published information file:

______________________________________________________________________________

#%Service1.0###################################################################
##
## $SERVICEPATH/org.globus.openssh-6.0.1.conf
##

Name = org.globus.openssh
Version = 5.7
Endpoint = your_hostname.site.xsede.org:2222
Capability = login.remoteshell
Capability = login.remoteshell.gsi
SupportStatus = testing

______________________________________________________________________________


2.  Update the file with the following base fields:

    Name must be “org.globus.openssh” which is the GLUE2 Primary protocol name.

    Version should be your GSI OpenSSH server version.

    Endpoint must include the public hostname and optional port in the example format.
    Explicitly specifying the default port of 22 is recommended. Alternate or
    testing servers may run on alternate ports.

    One or more Capability lines containing one of the values in this table:
    Table of Valid Name, Version, and Capability values for GSI OpenSSH services:
    Name			Version			Capability
    org.globus.openssh 	{5,6}.y.z 		login.remoteshell
						login.remoteshell.gsi
						login.remoteshell.xu2fa
						login.remoteshell.sshpubkey
						login.remoteshell.xkrb


    A SupportStatus of development, testing, or production. If SupportStatus is
    not supplied your service status in the your resource’s RDR status.

3.  Once your IPF software provider has run confirm that your GSI OpenSSH service is
    listed at:
    https://info1.dyn.xsede.org:443/wh1/glue2-views-api/v1/services/InterfaceName/org.globus.openssh/


NOTE about TeraGrid compatibility: the standard format defined by the IPF package is 
(mostly) content and format compatible with the old TeraGrid kit service registration
format. SPs with old TeraGrid kit GSI OpenSSH service registration files can migrate them
to IPF using these instructions:

http://software.xsede.org/development/ipf/ipf-xsede/latest/INSTALL