docs(archival): document s3store endpoint options - #11370
Draft
goanpeca wants to merge 1 commit into
Draft
Conversation
|
|
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.
What changed?
Added a short "S3-compatible endpoints" subsection to
common/archiver/s3store/README.mddocumenting theendpointands3ForcePathStyleoptions of thes3storearchival provider, with a small config snippet and a pointer toconfig/development-cass-s3.yaml. Docs only, no code changes.Why?
Both options already exist and are already honored:
common/config/config.godeclares them onS3Archiver(endpoint,s3ForcePathStyle), and bothhistory_archiver.goandvisibility_archiver.gopass them straight through tos3.Options.BaseEndpointands3.Options.UsePathStyle.config/development-cass-s3.yamldepends on them to talk to localstack. The README configuration sample never mentions either key, so anyone pointing archival at an S3 API other than the AWS default has to read the source or reverse-engineer the dev config to discover they are supported.How did you test it?
Markdown-only change. I did verify that the snippet I documented unmarshals into
config.S3Archiverexactly as written, so the key names and casing in the README match the yaml tags incommon/config/config.go.