Documentation: Add a missing field to the extended config s3 example #2991
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 this PR does / why we need it:
Loki does not do a great job complaining when the S3 configuration is invalid - instead, apparently it tries to hang indefinitely. It then naturally follows that good documentation is required, so that we don't lose hours combing through code, force deleting pods, and the like.
This PR addresses a gap in documentation, where how to get a bucket name into the config is not demonstrated. Notably, the code suggests that this new parameter can be used to evenly distribute logs to multiple buckets, so we add that to the example.
Which issue(s) this PR fixes:
Fixes life-stealing frustrations and dental bills from gnashed teeth.
Special notes for your reviewer:
Checklist