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.

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

Conversation

56quarters
Copy link
Contributor

PR Description

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.

Which issue(s) this PR fixes

N/A

Notes to the Reviewer

N/A

PR Checklist

  • Documentation added

@56quarters 56quarters force-pushed the 56quarters/rules-docs branch from f225be0 to dea0579 Compare April 23, 2024 15:46
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>
@56quarters 56quarters force-pushed the 56quarters/rules-docs branch from dea0579 to 52c887c Compare April 23, 2024 15:47
@56quarters
Copy link
Contributor Author

The warning, rendered
Screenshot 2024-04-23 at 11-47-25 mimir rules kubernetes Grafana Labs

@56quarters 56quarters marked this pull request as ready for review April 23, 2024 15:48
@56quarters 56quarters added backport release/v1.0 type/docs Docs Squad label across all Grafana Labs repos labels Apr 23, 2024
@@ -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

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

@rfratto rfratto added the backport-to-agent PR should be backported to the agent repo. label Apr 23, 2024
Signed-off-by: Nick Pillitteri <nick.pillitteri@grafana.com>
@rfratto rfratto merged commit 321df4c into main Apr 23, 2024
13 checks passed
@rfratto rfratto deleted the 56quarters/rules-docs branch April 23, 2024 17:06
github-actions bot pushed a commit that referenced this pull request Apr 23, 2024
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>
(cherry picked from commit 321df4c)
rfratto pushed a commit that referenced this pull request Apr 23, 2024
…652)

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.

(cherry picked from commit 321df4c)

Signed-off-by: Nick Pillitteri <nick.pillitteri@grafana.com>
hainenber pushed a commit to hainenber/alloy that referenced this pull request May 1, 2024
…#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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators May 24, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport release/v1.0 backport-to-agent PR should be backported to the agent repo. frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants