Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix missing deploymentMode: SingleBinary #15744

Merged
merged 2 commits into from
Jan 14, 2025
Merged

Conversation

auyer
Copy link
Contributor

@auyer auyer commented Jan 14, 2025

What this PR does / why we need it:
This missing line causes the StatefulSet/loki to be missing.
If one would copy the "s3" or "azure" sections of this guide, it is possible to miss the "deploymentMode" config (I did it).
It was awful to figure out the mistake, because first timers will not notice the missing StatefullSet (since there is aready a deamonset).

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • Title matches the required conventional commits format, see here
    • Note that Promtail is considered to be feature complete, and future development for logs collection will be in Grafana Alloy. As such, feat PRs are unlikely to be accepted unless a case can be made for the feature actually being a bug fix to existing behavior.
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

This missing line causes the StatefulSet/loki to be missing

Signed-off-by: Rafael Passos <[email protected]>
@auyer auyer requested a review from a team as a code owner January 14, 2025 14:19
@CLAassistant
Copy link

CLAassistant commented Jan 14, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Jan 14, 2025
Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[docs team] LGTM, thanks for taking the time to update the docs.

@JStickler JStickler merged commit 26fa93c into grafana:main Jan 14, 2025
61 checks passed
loki-gh-app bot pushed a commit that referenced this pull request Jan 14, 2025
Signed-off-by: Rafael Passos <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 26fa93c)
loki-gh-app bot pushed a commit that referenced this pull request Jan 14, 2025
Signed-off-by: Rafael Passos <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 26fa93c)
loki-gh-app bot pushed a commit that referenced this pull request Jan 14, 2025
Signed-off-by: Rafael Passos <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 26fa93c)
loki-gh-app bot pushed a commit that referenced this pull request Jan 14, 2025
Signed-off-by: Rafael Passos <[email protected]>
Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 26fa93c)
@auyer
Copy link
Contributor Author

auyer commented Jan 14, 2025

Thanks! This was the fastest merge I've ever seen 🥇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-3.0.x backport release-3.1.x backport release-3.2.x backport release-3.3.x size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants