From dea057962f325fb85d2a918bf050e164a73669eb Mon Sep 17 00:00:00 2001 From: Nick Pillitteri Date: Tue, 23 Apr 2024 11:24:13 -0400 Subject: [PATCH] mimir.rules.kubernetes: Add warning about clustering to docs 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 --- .../sources/reference/components/mimir.rules.kubernetes.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md index 7db6dd2d3f..b6f5741f85 100644 --- a/docs/sources/reference/components/mimir.rules.kubernetes.md +++ b/docs/sources/reference/components/mimir.rules.kubernetes.md @@ -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