XSEDE Capability Delivery Plan for "SGW-02: Science Gateway community file transfers"

Use Case SGW-02: Science Gateway community file transfers

Area: Community Building
URLs: Public, Review

Executive Summary: A science gateway developer needs to write code that enables the gateway to transfer files to and from XSEDE resources on behalf of gateway users.

First CDP: 2018-08-23
Current CDP: 2018-08-23
Current Implementation Status: 
Issues to be Addressed: 
Issues Remaining: 
Time & Effort Summary: 

Proposed effort:  est. 2 person-weeks

  • One week of writing time for XCI-436, plus any effort needed to coordinate with SGCI to make the information available to gateway developers via SGCI.
  • One week to test the documentation to verify that it works as described.
Significant Revisions:
This capability is currently supported by the following 5 components:
Component User facing? Component’s role in the capability
AMIE no The AMIE messaging service is used in XSEDE to coordinate user identities and credentials between the XSEDE allocations system and the accounting systems for individual Service Provider (SP) resources. It tells SPs about specific XSEDE allocations (usage permissions) and each user identity that is added or removed from each allocations. The SP is responsible for adjusting the local accounting system to implement each allocation on local resources. Each science gateway has a single user identity (a "community account") that can be added to one or more allocations to make use of a resource.
Globus Auth yes Globus Auth provides Web single sign-on (SSO) for XSEDE users and can be used as a login function by science gateways. Gateways that use Globus Auth for their login function can then use OAuth2 access tokens returned at login time to access other Globus services, including the Globus Transfer API, which provides a managed file transfer service.
Globus Transfer no The Globus Transfer service, accessed via the Transfer API, provides a managed file transfer service that can be used by science gateways. The Transfer API allows gateways to submit transfer requests that are then managed by the Transfer service without further gateway involvement. The status of each transfer request is also available via the Transfer API. The Transfer API requires authentication via OAuth2 access tokens issued by Globus Auth.
XSEDE Central Database (XCDB) no The XSEDE Central Database (XCDB) stores information about all XSEDE allocations (usage grants) and the XSEDE user identities that are allowed to make use of each allocation.
XSEDE User Portal (XUP) yes The XSEDE User Portal (XUP) is the primary interface for XSEDE user registration, allocation proposals, and account management. It is also the primary source of documentation for science gateways using XSEDE.