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

Inconsistent docs for number of operational modes #1783

Closed
lindhe opened this issue Dec 6, 2024 · 1 comment · Fixed by #1787
Closed

Inconsistent docs for number of operational modes #1783

lindhe opened this issue Dec 6, 2024 · 1 comment · Fixed by #1787
Labels
bug Something isn't working documentation Issues relating to documentation, missing, non-clear etc.

Comments

@lindhe
Copy link

lindhe commented Dec 6, 2024

In the docs, it says that there are 3 operational modes but lists four:

To support that, we offer 3 operational modes (you can switch between those through `WATCH_NAMESPACE` environment variable):
- cluster-wide (`WATCH_NAMESPACE: ""`);
- multiple namespaces (`WATCH_NAMESPACE: "grafana, foo"`):
- Cluster-wide permissions are still required;
- single namespace (`WATCH_NAMESPACE: "grafana"`):
- With this mode, it's possible to use `Role` + `RoleBinding` to grant the operator the required access.
- mutliple namespaces using label selector (`WATCH_NAMESPACE_SELECTOR: "environment: dev"`):
- With this mode, it is possible detect and load all namespaces that match the label selector automatically.
New namespaces won't be automatically included until the Grafana operator is restarted.
- Cluster-wide permissions are still required;

I'm guessing it should say "we offer 4 operational modes", but I don't know.

@theSuess
Copy link
Member

theSuess commented Dec 9, 2024

Yeah, this changed with #1434, but we forgot to change the number. I'll update this now!

@theSuess theSuess added bug Something isn't working documentation Issues relating to documentation, missing, non-clear etc. labels Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Issues relating to documentation, missing, non-clear etc.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants