chore: [release-3.1.x] docs: add additional clarification for single binary helm installation #14235
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
![loki-gh-app[bot]](https://avatars.githubusercontent.com/u/7195757?s=60&v=4){kind=small}
#14144) Co-authored-by: J Stickler <[email protected]> (cherry picked from commit de24945)
loki-gh-app
bot
added
backport
size/XS
type/docs
JStickler
approved these changes
Sep 23, 2024
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.
Backport de24945 from #14144
I added an explicit declaration of the need for the replication factor when using a single replica.
What this PR does / why we need it:
It's easy to overlook when learning and writing a minimalized template, especially when combing through other portions of the documentation where it's not specified.
Which issue(s) this PR fixes:
Fixes #8899 < closed, but adds clarity. similar issues exist on grafana community and stack overflow but I couldn't track them down again
Special notes for your reviewer:
I got caught up on this for quite some time, not understanding the architecture, and while trying to do my first install, and I got this roadblock and spent some time trying to figure it out.
Checklist
CONTRIBUTING.mdguide (required)featPRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.docs/sources/setup/upgrade/_index.mdproduction/helm/loki/Chart.yamland updateproduction/helm/loki/CHANGELOG.mdandproduction/helm/loki/README.md. Example PRdeprecated-config.yamlanddeleted-config.yamlfiles respectively in thetools/deprecated-config-checkerdirectory. Example PR