docs: clarify S3-compatible endpoint configuration for backups#469
Open
goanpeca wants to merge 1 commit into
Open
docs: clarify S3-compatible endpoint configuration for backups#469goanpeca wants to merge 1 commit into
goanpeca wants to merge 1 commit into
Conversation
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the backups configuration documentation to more explicitly explain how to use the backup-s3 module with non-AWS, S3-compatible object stores by clarifying BACKUP_S3_ENDPOINT usage and related environment variables.
Changes:
- Expanded the S3 section intro to explicitly mention Amazon S3 plus several S3-compatible providers.
- Added an “S3-compatible endpoints” subsection with guidance and a copy/paste environment example.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge. |
Author
|
I agree with the CLA |
2607793 to
cecf15c
Compare
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.
Summary
The
backup-s3module already works with Amazon S3 and any S3-compatible object store (it builds its client fromBACKUP_S3_ENDPOINT), but the backups page does not spell out how to point it at a non-AWS endpoint or how its AWS-named credentials apply to compatible backends. This adds that guidance. Docs only, no code or behavior changes.What changed
One file,
docs/deploy/configuration/backups.md:BACKUP_S3_ENDPOINTaccepts a host with an optional port, must not include anhttp://orhttps://scheme, and usesBACKUP_S3_USE_SSLfor TLS.AWS_REGIONguidance.Notes
Examples use a placeholder endpoint and no provider is singled out.