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

Add user storage guide #138

Merged
merged 10 commits into from
Apr 25, 2022
Merged

Add user storage guide #138

merged 10 commits into from
Apr 25, 2022

Conversation

rabernat
Copy link
Contributor

user/storage.md Show resolved Hide resolved
user/storage.md Outdated

Writing data (and reading private data) requires credentials for authentication.
2i2c does not provide credentials to individual users.
Instead you 2i2c customers should manage their own cloud storage directly.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can we think of some more concrete suggestions to put here?

Copy link
Member

@choldgraf choldgraf left a comment

Choose a reason for hiding this comment

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

I really like this - I'm always impressed at the clarity and usefulness of the Pangeo docs. Thanks so much @rabernat for porting this over.

I made several comments and suggestions throughout to improve the clarity and readability. There are also a few places where I think we might need to update the names of things (in particular the PANGEO_SCRATCH variable name...but correct me if I'm wrong). I also added a big "warning" to the instructions about GitHub credentials storage, so that we can merge this PR without blocking on the longer-term fix that @yuvipanda mentions.

IMO once the comments are resolved, we can merge this one in.

user/storage.md Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
@damianavila
Copy link
Contributor

@rabernat, Chris left a bunch of comments, can I ask for a follow-up from you since you were the original author of this PR?
Thanks!!

@rabernat
Copy link
Contributor Author

Thanks for the feedback everyone! I have a busy M-W but will try to find time to revise this on Thursday.

@yuvipanda
Copy link
Member

I'll try to get in my gh-scoped-creds documentation PR to this PR before thursday then :)

yuvipanda added a commit to yuvipanda/pilot-hubs that referenced this pull request Apr 20, 2022
Also adds docs on how to do this!

pangeo-data/pangeo-docker-images#305 adds
the required package to the pangeo docker image.

See 2i2c-org/docs#138 (comment)
for more discussion
@yuvipanda
Copy link
Member

rabernat#1 is my PR to this PR :)

user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated Show resolved Hide resolved
user/storage.md Outdated

- **[s3fs](https://s3fs.readthedocs.io/en/latest/)** - for working with AWS S3
(Simple Storage Service) and compatible APIs. Most third-party object storage
services (e.g. [Wasabi](https://wasabi.com/) and [Open Storage Newtork](https://www.openstoragenetwork.org/))
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The link checker is erroneously flagging this as a broken link

(    user/storage: line  109) broken    https://www.openstoragenetwork.org/ - HTTPSConnectionPool(host='www.openstoragenetwork.org', port=443): Max retries exceeded with url: / (Caused by SSLError(SSLCertVerificationError(1, '[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate (_ssl.c:1131)')))

Copy link
Member

Choose a reason for hiding this comment

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

I added an exception to openstoragenetwork, not sure why it wasn't working

user/storage.md Outdated Show resolved Hide resolved
conf.py Outdated Show resolved Hide resolved
Copy link
Member

@yuvipanda yuvipanda left a comment

Choose a reason for hiding this comment

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

This is good to go!

@yuvipanda yuvipanda merged commit b5d27bf into 2i2c-org:main Apr 25, 2022
@yuvipanda
Copy link
Member

Thanks, @rabernat and @choldgraf!

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

Successfully merging this pull request may close these issues.

Document object storage and scratch bucket
5 participants