docs: document Backblaze B2 (S3-compatible) as a model repository backend#8847
Open
goanpeca wants to merge 1 commit into
Open
docs: document Backblaze B2 (S3-compatible) as a model repository backend#8847goanpeca wants to merge 1 commit into
goanpeca wants to merge 1 commit into
Conversation
goanpeca
force-pushed
the
b2-model-repository-docs
branch
4 times, most recently
from
46dc17d to
9ae0233
Compare
Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>
goanpeca
force-pushed
the
b2-model-repository-docs
branch
from
9ae0233 to
f0dc1ca
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation guidance for using Triton’s S3 backend with S3-compatible object stores (e.g., Backblaze B2, Cloudflare R2, MinIO), including example repository URLs and credential configuration.
Changes:
- Document S3-compatible endpoints and how to format the model repository path.
- Add example environment variables for access/secret keys and region for non-AWS providers.
- Add an example credentials JSON entry for S3-compatible bucket paths.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The S3 backend also works with S3-compatible object stores such as Backblaze B2, Cloudflare R2, and MinIO. The repository path uses the private-instance form described above, with the provider's endpoint as the host, and the credentials and region are passed through the same environment variables as Amazon S3. | ||
|
|
||
| ```bash | ||
| $ tritonserver --model-repository=s3://https://s3.us-west-004.backblazeb2.com:443/bucket/path/to/model/repository ... |
| $ export AWS_ACCESS_KEY_ID="<access_key_id>" | ||
| $ export AWS_SECRET_ACCESS_KEY="<secret_access_key>" | ||
| $ export AWS_DEFAULT_REGION="us-west-004" | ||
| $ tritonserver --model-repository=s3://https://s3.us-west-004.backblazeb2.com:443/my-bucket/models ... |
|
|
||
| **Make sure, that `TRITON_AWS_MOUNT_DIRECTORY` exists on your local machine and it is empty.** | ||
|
|
||
| ##### S3-compatible object stores |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hello :)
What does the PR do?
Documents using S3-compatible object stores (for example Backblaze B2, Cloudflare R2, and MinIO) as a Triton model repository. The existing S3 backend already supports custom endpoints through the private-instance URI form, so this is a docs-only addition: a short "S3-compatible object stores" subsection under the existing
#### S3section indocs/user_guide/model_repository.md.Checklist
<commit_type>: <Title>Commit Type:
Related PRs:
None.
Where should the reviewer start?
docs/user_guide/model_repository.md, the new##### S3-compatible object storessubsection under#### S3. It reuses the private-instances3://https://<endpoint>:443/<bucket>/<path>form already documented above, the AWS credential environment variables, and the existing credential-file form.Test plan:
Built the documentation locally with the repo's Sphinx configuration and confirmed the rendered page. Separately validated the documented mechanism end to end: started
tritonserverwith--model-repositorypointed at an S3-compatible endpoint and confirmed the model loaded and reported READY. Verified against both MinIO and Backblaze B2, using the AWS environment-variable credentials and theTRITON_CLOUD_CREDENTIAL_PATHcredential-file form.Caveats:
Docs only; no code or behavior changes. Opened as draft pending a signed Triton CCLA.
Background
Triton's S3 backend communicates with any store that accepts the S3 protocol, using the custom-endpoint URI form already documented for private S3 instances. That capability was not called out for non-AWS providers, so it was not obvious that Backblaze B2, Cloudflare R2, MinIO, and similar stores work with no code changes.
Related Issues:
None.