Skip to content

Commit

Permalink
mimir.rules.kubernetes: Add warning about clustering to docs
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
56quarters committed Apr 23, 2024
1 parent 5330b90 commit dea0579
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/sources/reference/components/mimir.rules.kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,17 @@ 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" >}}.

[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/


## Usage

```alloy
Expand Down

0 comments on commit dea0579

Please sign in to comment.