update ceph source to reef 18.1.2

[ceph.git] / ceph / doc / mgr / telemetry.rst

diff --git a/ceph/doc/mgr/telemetry.rst b/ceph/doc/mgr/telemetry.rst
index 388353b84adcfdf6121bec4064896d731760b790..90d45766c15bce3006bd1e15d36296889cde5d55 100644 (file)
--- a/ceph/doc/mgr/telemetry.rst
+++ b/ceph/doc/mgr/telemetry.rst
@@ -269,3 +269,24 @@ completely optional, and disabled by default.::
   ceph config set mgr mgr/telemetry/description 'My first Ceph cluster'
   ceph config set mgr mgr/telemetry/channel_ident true
 
+Leaderboard
+-----------
+
+To participate in a leaderboard in the `public dashboards
+<https://telemetry-public.ceph.com/>`_, run the following command:
+
+.. prompt:: bash $
+
+   ceph config set mgr mgr/telemetry/leaderboard true
+
+The leaderboard displays basic information about the cluster. This includes the
+total storage capacity and the number of OSDs. To add a description of the
+cluster, run a command of the following form: 
+
+.. prompt:: bash $
+
+   ceph config set mgr mgr/telemetry/leaderboard_description 'Ceph cluster for Computational Biology at the University of XYZ'
+
+If the ``ident`` channel is enabled, its details will not be displayed in the
+leaderboard.
+