From: Zac Dover <zac.dover@gmail.com>
Date: Wed, 27 Jul 2022 14:27:42 +0000 (+1000)
Subject: doc/monitoring: add min vers of apps in mon stack
X-Git-Tag: v16.2.11~330^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=da554db618f94e9e958c91febb8c546c0453c10a;p=ceph.git

doc/monitoring: add min vers of apps in mon stack

https://tracker.ceph.com/issues/45447

This PR adds recommended versions of grafana and
prometheus and alert manager.

This PR is a second attempt at getting the information
in the following PR into the docs:
https://github.com/ceph/ceph/pull/46000/files

Himadri Maheshwari deserves the credit for the work
in this commit.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
Signed-off-by: Himadri Maheshwari <himadri.maheshwari7915@gmail.com>
(cherry picked from commit 367695f5b09f75ee723d53116e2f4a6e45dd795d)
---

diff --git a/monitoring/ceph-mixin/README.md b/monitoring/ceph-mixin/README.md
index fd0fe95ed90b..edeb9d462333 100644
--- a/monitoring/ceph-mixin/README.md
+++ b/monitoring/ceph-mixin/README.md
@@ -15,7 +15,13 @@ In `dashboards_out` you can find a collection of
 These dashboards are based on metrics collected
 from [prometheus](https://prometheus.io/) scraping the [prometheus mgr
 plugin](http://docs.ceph.com/en/latest/mgr/prometheus/) and the
-[node_exporter](https://github.com/prometheus/node_exporter).
+[node_exporter (0.17.0)](https://github.com/prometheus/node_exporter).
+
+
+##### Recommended versions: 
+-grafana 8.3.5
+    -grafana-piechart-panel 1.6.2
+    -grafana-status-panel 1.0.11
 
 #### Requirements
 
@@ -31,12 +37,28 @@ alert rules that should provide a decent set of default alerts for a
 Ceph cluster. Just put this file in a place according to your Prometheus
 configuration (wherever the `rules` configuration stanza points).
 
+### Multi-cluster support
+Ceph-mixin supports dashboards and alerts across multiple clusters. 
+To enable this feature you need to configure the following in `config.libsonnnet`:
+
+```
+showMultiCluster: true,
+clusterLabel: '<your cluster label>',
+```
+
+##### Recommended versions: 
+-prometheus v2.33.4
+
 #### SNMP
-Ceph provides a MIB (CEPH-PROMETHEUS-ALERT-MIB.txt) to support sending Prometheus
-alerts through to an SNMP management platform. The translation from Prometheus
-alert to SNMP trap requires the Prometheus alert to contain an OID that maps to
-a definition within the MIB. When making changes to the Prometheus alert rules
-file, developers should include any necessary changes to the MIB.
+Ceph provides a MIB (CEPH-PROMETHEUS-ALERT-MIB.txt) to support sending
+Prometheus alerts to an SNMP management platform. The translation from
+Prometheus alert to SNMP trap requires the Prometheus alert to contain an OID
+that maps to a definition within the MIB. When making changes to the Prometheus
+alert rules file, developers should include any necessary changes to the MIB.
+
+
+##### Recommended: 
+-alertmanager 0.16.2
 
 ### Building from Jsonnet
 
@@ -50,3 +72,5 @@ To rebuild all the generated files, you can run `tox -egrafonnet-fix`.
 The jsonnet code located in this directory depends on some Jsonnet third party
 libraries. To update those libraries you can run `jb update` and then update
 the generated files using `tox -egrafonnet-fix`.
+
+##### Any upgrade or downgrade to different major versions of the recommended tools mentioned above is not supported.