From 55e45862ae309dd6eb7d67b8909a65c3cc9ad449 Mon Sep 17 00:00:00 2001 From: Umanga Chapagain Date: Thu, 16 Jan 2020 12:30:08 +0530 Subject: [PATCH] Ceph: updates CephCluster CRD doc to include monitoring options adds documentation on spec to enable/disable monitoring of Ceph clusters using prometheus. prometheus still needs to be deployed separately. Signed-off-by: Umanga Chapagain --- Documentation/ceph-cluster-crd.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/ceph-cluster-crd.md b/Documentation/ceph-cluster-crd.md index c5b1675ba..7b47103da 100755 --- a/Documentation/ceph-cluster-crd.md +++ b/Documentation/ceph-cluster-crd.md @@ -112,6 +112,12 @@ If this value is empty, each pod will get an ephemeral directory to store their * `urlPrefix`: Allows to serve the dashboard under a subpath (useful when you are accessing the dashboard via a reverse proxy) * `port`: Allows to change the default port where the dashboard is served * `ssl`: Whether to serve the dashboard via SSL, ignored on Ceph versions older than `13.2.2` +* `monitoring`: Settings for monitoring Ceph using Prometheus. To enable monitoring on your cluster see the [monitoring guide](Documentation/ceph-monitoring.md#prometheus-alerts). + * `enabled`: Whether to enable prometheus based monitoring for this cluster + * `rulesNamespace`: Namespace to deploy prometheusRule. If empty, namespace of the cluster will be used. + Recommended: + * If you have a single Rook Ceph cluster, set the `rulesNamespace` to the same namespace as the cluster or keep it empty. + * If you have multiple Rook Ceph 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. * `network`: The network settings for the cluster * `hostNetwork`: uses network of the hosts instead of using the SDN below the containers. * `mon`: contains mon related options [mon settings](#mon-settings)