From 7aa5b05753da24b03208768f3b452eaac33d319e Mon Sep 17 00:00:00 2001 From: Nick Pillitteri <56quarters@users.noreply.github.com> Date: Tue, 23 Apr 2024 13:06:22 -0400 Subject: [PATCH] mimir.rules.kubernetes: Add warning about clustering to docs (#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 --- .../reference/components/mimir.rules.kubernetes.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/sources/reference/components/mimir.rules.kubernetes.md b/docs/sources/reference/components/mimir.rules.kubernetes.md index 7db6dd2d3f..1e52cb2621 100644 --- a/docs/sources/reference/components/mimir.rules.kubernetes.md +++ b/docs/sources/reference/components/mimir.rules.kubernetes.md @@ -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/