docs: update s3 doc to indicate endpoint shouldn't include the bucket name prefix #11039
+4
−0
Conversation
This file contains 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
|
@tacole02 could you please have a look at this PR? |
|
from the Mimir dev team side, this is accurate, will wait for @tacole02's take from the docs side |
tacole02
approved these changes
Apr 7, 2025
| @@ -83,6 +83,10 @@ ruler_storage: | |||
| bucket_name: mimir-ruler | |||
| ``` | |||
|
|
|||
| {{< admonition type="note" >}} | |||
| The endpoint value must not be prefixed with your bucket name (e.g., if your bucket is "my-storage-bucket", the endpoint cannot be "my-storage-bucket.s3.amazonaws.com"). | |||
There was a problem hiding this comment.
Suggested change
| The endpoint value must not be prefixed with your bucket name (e.g., if your bucket is "my-storage-bucket", the endpoint cannot be "my-storage-bucket.s3.amazonaws.com"). | |
| Don't prefix the endpoint value with your bucket name. For example, if your bucket is named "my-storage-bucket", you cannot name the endpoint "my-storage-bucket.s3.amazonaws.com"). |
There was a problem hiding this comment.
@tacole02 I've addressed the comment, please have a look
There was a problem hiding this comment.
Looks great! Thank you so much, @joobisb !
tacole02
approved these changes
Apr 9, 2025
|
This PR looks good. Is there anything preventing its merge? |
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.
… name prefix
What this PR does
Document the s3 object storage endpoint must not prefixed with the bucket name.
Which issue(s) this PR fixes or relates to
Fixes #9177
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX].about-versioning.mdupdated with experimental features.