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

V2.0.1 branch #66

Merged
merged 3 commits into from
Feb 29, 2024
Merged

V2.0.1 branch #66

merged 3 commits into from
Feb 29, 2024

Conversation

bsweger
Copy link
Contributor

@bsweger bsweger commented Feb 29, 2024

Resolves #65

This changeset adds an optional cloud group to admin-schema.json.
If cloud.enabled is set to true, then the cloud.host properties must also be provided.

I versioned this as v2.0.1 because it's a non-breaking change, but will add a follow-up question in the comments about how we're capturing repository_url

This changeset adds an optional cloud group to admin-schema.json.
If cloud.enabled is set to true, then the cloud.host properties
must also be provided.
@@ -0,0 +1,1421 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/Infectious-Disease-Modeling-Hubs/schemas/main/v2.0.1/tasks-schema.json",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tasks-schema.json is a copy/paste from v2.0.0: the only change is this line

"GitHub"
]
},
"repository_url": {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we know that all hubs are using GitHub, I don't think it's worth making a breaking change here, but if we ever hit v3.0, it might be helpful to split up the repository_url into its atomic components of org name and repo name.

Reason: cloud-enabled hubs need the org name and repo name as separate strings for setting up AWS permissions. As we ramp up, it's easy enough to parse because we know how GitHub URLs are formatted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a reasonable suggestion. maybe worth filing as an issue for future reference?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#67

@bsweger bsweger marked this pull request as draft February 29, 2024 14:48
@bsweger bsweger marked this pull request as ready for review February 29, 2024 14:50
Copy link
Contributor

@nickreich nickreich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. The example is helpful to see what this would look like in action.

@elray1
Copy link
Contributor

elray1 commented Feb 29, 2024

Looks good to me too! The only question I had was whether it might be worth naming the option for host.name something like "aws-s3", to be more specific in case there is ever another aws data storage option we decide to support? This is definitely more a question than an opinion; maybe S3 is the only reasonable option under aws, so we don't need that specificity.

@annakrystalli
Copy link
Member

annakrystalli commented Feb 29, 2024

Looks good to me too! Can we also add a note in NEWS.md please :)? https://github.com/Infectious-Disease-Modeling-Hubs/schemas/blob/main/NEWS.md

@annakrystalli
Copy link
Member

annakrystalli commented Feb 29, 2024

DOH already done! Was looking in the wrong place!!

@bsweger
Copy link
Contributor Author

bsweger commented Feb 29, 2024

@elray1 Good question re: being explicit about the name of the cloud storage service. AFAIK, most cloud providers only have one option for cloud object storage (e.g., AWS has S3, Azure has blob).

But I agree with your point...why not be as clear as possible while also hedging our bets for the Glorious Future? Pushed another commit....lemme know what you think!

@bsweger bsweger requested a review from elray1 February 29, 2024 16:22
Copy link
Contributor

@elray1 elray1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good :)

@bsweger
Copy link
Contributor Author

bsweger commented Feb 29, 2024

Merging this so we can create a "cloud-enabled" version of the admin schema. Still working on the corresponding hubDocs PR over here: hubverse-org/hubDocs#90

@bsweger bsweger merged commit 2bb9456 into main Feb 29, 2024
3 checks passed
@bsweger bsweger deleted the v2.0.1-branch branch February 29, 2024 18:54
@bsweger bsweger added this to the hubverse cloud sync milestone Apr 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Add a property for S3 bucket information?
4 participants