Skip to content

Commit

Permalink
mimir.rules.kubernetes: Add warning about clustering to docs (grafana…
Browse files Browse the repository at this point in the history
…#648)

The component doesn't support running in clustered mode. When multiple
clustered Alloy instances run the component, they will end up conflicting
with each other making API requests to the Mimir ruler.

Signed-off-by: Nick Pillitteri <nick.pillitteri@grafana.com>
  • Loading branch information
56quarters authored and hainenber committed May 1, 2024
1 parent 043bd12 commit 7aa5b05
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/sources/reference/components/mimir.rules.kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,15 @@ 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][]. Using this component as part of a cluster of
{{< param "PRODUCT_NAME" >}} instances will cause them to all attempt to update rules using the
Mimir API, conflicting with each other. When using this component, it must be run in a separate
single-instance deployment of {{< param "PRODUCT_NAME" >}}.

[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

0 comments on commit 7aa5b05

Please sign in to comment.