From 3fce0e443e05dc9e94ebbb35b695d8f1a372c73b Mon Sep 17 00:00:00 2001 From: parth-gr Date: Tue, 9 May 2023 12:45:59 +0530 Subject: [PATCH] docs: update ruleNamesapce to rulesNamespaceOverride there were some places where rulenamesapce was present updated to rulesNamespaceOverride Closes: rook#12163 Signed-off-by: parth-gr (cherry picked from commit 060bd00281172e4763c3c3cb14cc421d78d2b01e) --- Documentation/CRDs/Cluster/ceph-cluster-crd.md | 4 ---- Documentation/Helm-Charts/ceph-cluster-chart.md | 2 +- deploy/charts/rook-ceph-cluster/values.yaml | 2 +- deploy/examples/cluster-external.yaml | 5 ++--- 4 files changed, 4 insertions(+), 9 deletions(-) diff --git a/Documentation/CRDs/Cluster/ceph-cluster-crd.md b/Documentation/CRDs/Cluster/ceph-cluster-crd.md index c3c11a5d5..8156d3276 100755 --- a/Documentation/CRDs/Cluster/ceph-cluster-crd.md +++ b/Documentation/CRDs/Cluster/ceph-cluster-crd.md @@ -50,10 +50,6 @@ If this value is empty, each pod will get an ephemeral directory to store their If true, the prometheus mgr module and Ceph exporter are both disabled. Default is false. * `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. - 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. * `port`: The internal prometheus manager module port where the prometheus mgr module listens. The port may need to be configured when host networking is enabled. * `interval`: The interval for the prometheus module to to scrape targets. * `network`: For the network settings for the cluster, refer to the [network configuration settings](#network-configuration-settings) diff --git a/Documentation/Helm-Charts/ceph-cluster-chart.md b/Documentation/Helm-Charts/ceph-cluster-chart.md index 482071f29..df0b30200 100644 --- a/Documentation/Helm-Charts/ceph-cluster-chart.md +++ b/Documentation/Helm-Charts/ceph-cluster-chart.md @@ -72,7 +72,7 @@ The following table lists the configurable parameters of the rook-operator chart | `monitoring.enabled` | Enable Prometheus integration, will also create necessary RBAC rules to allow Operator to create ServiceMonitors. Monitoring requires Prometheus to be pre-installed | `false` | | `monitoring.prometheusRule.annotations` | Annotations applied to PrometheusRule | `{}` | | `monitoring.prometheusRule.labels` | Labels applied to PrometheusRule | `{}` | -| `monitoring.rulesNamespaceOverride` | The namespace in which to create the prometheus rules, if different from the rook cluster namespace. If you have multiple rook-ceph clusters in the same k8s cluster, choose the same namespace (ideally, namespace with prometheus deployed) to set rulesNamespace for all the clusters. Otherwise, you will get duplicate alerts with multiple alert definitions. | `nil` | +| `monitoring.rulesNamespaceOverride` | The namespace in which to create the prometheus rules, if different from the rook cluster namespace. If you have multiple rook-ceph clusters in the same k8s cluster, choose the same namespace (ideally, namespace with prometheus deployed) to set rulesNamespaceOverride for all the clusters. Otherwise, you will get duplicate alerts with multiple alert definitions. | `nil` | | `operatorNamespace` | Namespace of the main rook operator | `"rook-ceph"` | | `pspEnable` | Create & use PSP resources. Set this to the same value as the rook-ceph chart. | `false` | | `toolbox.affinity` | Toolbox affinity | `{}` | diff --git a/deploy/charts/rook-ceph-cluster/values.yaml b/deploy/charts/rook-ceph-cluster/values.yaml index 97f206f7c..eec659d5d 100644 --- a/deploy/charts/rook-ceph-cluster/values.yaml +++ b/deploy/charts/rook-ceph-cluster/values.yaml @@ -49,7 +49,7 @@ monitoring: createPrometheusRules: false # -- The namespace in which to create the prometheus rules, if different from the rook cluster namespace. # If you have multiple rook-ceph clusters in the same k8s cluster, choose the same namespace (ideally, namespace with prometheus - # deployed) to set rulesNamespace for all the clusters. Otherwise, you will get duplicate alerts with multiple alert definitions. + # deployed) to set rulesNamespaceOverride for all the clusters. Otherwise, you will get duplicate alerts with multiple alert definitions. rulesNamespaceOverride: # Monitoring settings for external clusters: # externalMgrEndpoints: diff --git a/deploy/examples/cluster-external.yaml b/deploy/examples/cluster-external.yaml index 9f386c321..f6055142a 100644 --- a/deploy/examples/cluster-external.yaml +++ b/deploy/examples/cluster-external.yaml @@ -27,7 +27,6 @@ spec: # optionally, the ceph-mgr IP address can be passed to gather metric from the prometheus exporter # monitoring: # enabled: true - # rulesNamespace: rook-ceph # externalMgrEndpoints: - #- ip: ip - # externalMgrPrometheusPort: 9283 + # - ip: ip + # externalMgrPrometheusPort: 9283