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.

Sign up for GitHub

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

mimir.rules.kubernetes: Add warning about clustering to docs #648

Merged
merged 2 commits into from
Apr 23, 2024
Merged

mimir.rules.kubernetes: Add warning about clustering to docs #648

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
52c887c
mimir.rules.kubernetes: Add warning about clustering to docs
56quarters Apr 23, 2024
c0cb0e4
Code review
56quarters Apr 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/sources/reference/components/mimir.rules.kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ in Kubernetes in order for {{< param "PRODUCT_NAME" >}} to access it via the Kub
[Role-based access control (RBAC)]: https://kubernetes.io/docs/reference/access-authn-authz/rbac/
{{< /admonition >}}

{{< admonition type="warning" >}}
This component does not support [clustered mode][] and must be run in a separate single-instance deployment of {{< param "PRODUCT_NAME" >}}.
Copy link
Member

@rfratto rfratto Apr 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Do we want to include a brief explanation of what the issue is if you run it in clustered mode anyway to drive home that you really shouldn't?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good idea. Will update

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in c0cb0e4


[clustered mode]: ../../../concepts/clustering/
{{< /admonition >}}

[Kubernetes label selectors]: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
[prometheus-operator]: https://prometheus-operator.dev/
[within a Pod]: https://kubernetes.io/docs/tasks/run-application/access-api-from-pod/
Expand Down
Loading