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

docs: update ruleNamesapce to rulesNamespaceOverride #12190

Merged
merged 1 commit into from
May 11, 2023

Conversation

parth-gr
Copy link
Member

@parth-gr parth-gr commented May 4, 2023

Description of your changes:
there were some places where rulenamesapce was present updated to rulesNamespaceOverride

Which issue is resolved by this Pull Request:
Resolves #12163

Checklist:

  • Commit Message Formatting: Commit titles and messages follow guidelines in the developer guide.
  • Skip Tests for Docs: If this is only a documentation change, add the label skip-ci on the PR.
  • Reviewed the developer guide on Submitting a Pull Request
  • Pending release notes updated with breaking and/or notable changes for the next minor release.
  • Documentation has been updated, if necessary.
  • Unit tests have been added, if necessary.
  • Integration tests have been added, if necessary.

# externalMgrEndpoints:
#- ip: ip
# externalMgrPrometheusPort: 9283
#- ip: ip
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need to add indentation back to these last two lines

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DOne

@@ -48,10 +48,10 @@ If this value is empty, each pod will get an ephemeral directory to store their
* `enabled`: Whether to enable prometheus based monitoring for external or internal cluster
* `externalMgrEndpoints`: external cluster manager endpoints
* `externalMgrPrometheusPort`: external prometheus manager module port. See [external cluster configuration](#external-cluster) for more details.
* `rulesNamespace`: Namespace to deploy prometheusRule. If empty, namespace of the cluster will be used.
* `rulesNamespaceOverride`: Namespace to deploy prometheusRule. If empty, namespace of the cluster will be used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually this setting isn't in the cluster CRD anymore, it's only a helm setting, so we need to delete this and its sub-bullets

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay

deploy/examples/cluster-external.yaml Show resolved Hide resolved
@parth-gr parth-gr requested a review from travisn May 8, 2023 13:27
@parth-gr parth-gr force-pushed the doc-update-rulenamespace branch 4 times, most recently from b887425 to 9cb1e5a Compare May 9, 2023 07:16
@parth-gr
Copy link
Member Author

parth-gr commented May 9, 2023

And what was the reason for removing the rulesNmespace?
from cluster yamls

@parth-gr parth-gr requested a review from travisn May 9, 2023 07:27
@travisn
Copy link
Member

travisn commented May 9, 2023

And what was the reason for removing the rulesNmespace? from cluster yamls

See #9837 for background on the change

Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more typo

Recommended:
* If you have a single Rook cluster, set the `rulesNamespace` to the same namespace as the cluster or keep it empty.
* If you have multiple Rook clusters in the same Kubernetes cluster, choose the same namespace to set `rulesNamespace` for all the clusters (ideally, namespace with prometheus deployed). Otherwise, you will get duplicate alerts with duplicate alert definitions.
* `externalMgrPrometheusPort`: external prometheus manager module port. See [external cluster configuration](#external-cluster) for more details.`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `externalMgrPrometheusPort`: external prometheus manager module port. See [external cluster configuration](#external-cluster) for more details.`
* `externalMgrPrometheusPort`: external prometheus manager module port. See [external cluster configuration](#external-cluster) for more details.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!
Thanks

Copy link
Member

@travisn travisn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more typo

there were some places where rulenamesapce was present updated to rulesNamespaceOverride

Closes: rook#12163
Signed-off-by: parth-gr <paarora@redhat.com>
@parth-gr parth-gr requested a review from travisn May 11, 2023 11:56
@travisn travisn merged commit 27504b0 into rook:master May 11, 2023
44 checks passed
travisn added a commit that referenced this pull request May 15, 2023
docs: update ruleNamesapce to rulesNamespaceOverride (backport #12190)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to set monitoring.rulesNamespace
2 participants