]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/mgr: edit "leaderboard" in telemetry.rst 51721/head
authorZac Dover <zac.dover@proton.me>
Mon, 22 May 2023 20:06:52 +0000 (06:06 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 23 May 2023 22:09:05 +0000 (08:09 +1000)
Standardize the presentation of commands in the "Leaderboard" section of
doc/mgr/telemetry.rst.

Follow-up to https://github.com/ceph/ceph/pull/50977

Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 4935ad8aed2aa796015473de5b38cc973ba85ba1)

doc/mgr/telemetry.rst

index 388353b84adcfdf6121bec4064896d731760b790..90d45766c15bce3006bd1e15d36296889cde5d55 100644 (file)
@@ -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.
+