Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposed GitHub and XSEDE API synchronization design #28

Open
jpnavarro opened this issue Apr 8, 2022 · 0 comments
Open

Proposed GitHub and XSEDE API synchronization design #28

jpnavarro opened this issue Apr 8, 2022 · 0 comments

Comments

@jpnavarro
Copy link
Contributor

jpnavarro commented Apr 8, 2022

XSEDE generates SGCI resource descriptions from RDR and IPF information that can be accessed at:
https://info.xsede.org/wh1/warehouse-views/v1/resources-sgci/v1.0.0/

The SGCI resource description GitHub repository is at:
https://github.com/SGCI/sgci-resource-inventory/tree/master/data

In both, the "host" attribute is the unique key.

Proposed design to synchronize from XSEDE to GitHub: daily compare API and GitHub descriptions, and generate a GitHub pull request for description where the API description doesn't exist in GitHub, where it is different than GitHub without considering whitespace, or has disappeared in the XSEDE API (deleted resource).

Proposed design for an enhanced XSEDE API that combines GitHub only descriptions and XSEDE generated descriptions:

https://info.xsede.org/wh1/warehouse-views/v1/resources-sgci/v1.0.0/?include=github
Dynamically generates SGCI resource descriptions from RDR and IPF plus any GitHub resources that don't come from XSEDE. The GitHub cache used by this API is refreshed hourly.

Note that XSEDE's descriptions can take up to a day to make it to GitHub depending on how frequently pull requests are processed, and that GitHub descriptions can take up to an hour to show up in the enhanced XSEDE API.

If the team can agree on this design, XSEDE can implement it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant