XSEDE Capability Delivery Plan for "SGW-05: Obtain information about a community resource"

Use Case SGW-05: Obtain information about a community resource

Area: Community Building
URLs: Public, Review

Executive Summary: A science gateway developer needs to enable a gateway to obtain detailed configuration or status information about a community resource so the gateway can use the resource efficiently. A community resource is a resource provided to the community by a service provider (e.g., a compute cluster, a storage system). Configuration information is information about how the resource is configured on a seldom-changing basis. (E.g., system architecture, job queue names, queue requirements, data transfer endpoints, storage systems.) Status information is the dynamic status of the resource. (E.g., current number of jobs in a queue, estimated queue wait times, current free storage.)

Organization: 
XSEDE
First CDP: 2021-08-02
Current Implementation Status: 
Significant Revisions:
  • 2021-08-02 15:57 (current revision)
This capability is currently supported by the following 4 components:
Component User facing? Component’s role in the capability
Information Services yes Implements APIs that return community resource information. Specific APIs (https://software.xsede.org/apis) include: * glue2-db-api: raw community resource information published by SPs * glue2-views-api: combined resource information published by SPs * goendpoints-api: Globus endpoint information * outages: System outages information * rdr-db: Resource Description Repository information * resource-api: research enhancing resource information * resource-status-api: XSEDE integration status information * warehouse-views: combines information from multiple sources
Research Software Portal (RSP) yes Providers links to developer resources (https://software.xsede.org/community/software-developers), including to documentation about APIs (https://software.xsede.org/apis) that developers can use to access community resource information.
Resource Description Repository (RDR) yes Provides API (https://rdr.xsede.org/apipie) that science gateways can access with manually entered resource description information.
XSEDE User Portal (XUP) yes Provides links to developer resources (https://www.xsede.org/ecosystem/developer-resources), including to documentation about APIs that developers can use to access community resource information.