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

Updated documentation for S3-compatible object stores #592

Merged
merged 6 commits into from
Feb 13, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/source/how_to_guides/configure_cloud_storage_credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,30 @@ export S3_ENDPOINT_URL='https://<accountid>.r2.cloudflarestorage.com'
```
````

One can also set credentials through environment variables. For example, with Backblaze:

```{note}
Your endpoint url is 'https://s3.<your region>.backblazeb2.com'. The account ID can be retrieved through your [Backblaze console](https://secure.backblaze.com/b2_buckets.htm).
karan6181 marked this conversation as resolved.
Show resolved Hide resolved
```

````{tabs}
```{code-tab} py
import os
os.environ['S3_ENDPOINT_URL'] = 'https://s3.<your region>.backblazeb2.com'
karan6181 marked this conversation as resolved.
Show resolved Hide resolved
os.environ["AWS_ACCESS_KEY_ID"] = '<Backblaze key ID>'
karan6181 marked this conversation as resolved.
Show resolved Hide resolved
os.environ["AWS_SECRET_ACCESS_KEY"] = '<Backblaze application key>'
```

```{code-tab} sh
export S3_ENDPOINT_URL='https://s3.<your region>.backblazeb2.com'
karan6181 marked this conversation as resolved.
Show resolved Hide resolved
export AWS_ACCESS_KEY_ID='<Backblaze key ID>'
karan6181 marked this conversation as resolved.
Show resolved Hide resolved
export AWS_SECRET_ACCESS_KEY='<Backblaze application key>'
```
````

Note that even with S3 compatible object stores, URLs should be of the form `s3://<bucket name>/<path within the bucket>`, instead of `<endpoint url>/<bucket name>/<path within the bucket>` or in the example of Backblaze `b2://<bucket name>/<path within the bucket>`.
karan6181 marked this conversation as resolved.
Show resolved Hide resolved


## Google Cloud Storage

### MosaicML platform
Expand Down
Loading