Skip to content

Commit 7c5164b

Browse files
authored
Merge pull request ceph#63741 from zdover23/wip-doc-2025-06-05-mgr-telemetry-63476-followup-4-of-x
doc/mgr: edit telemetry (4 of x) Reviewed-by: Anthony D'Atri <[email protected]>
2 parents e6648cd + b199d75 commit 7c5164b

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

doc/mgr/telemetry.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -320,14 +320,14 @@ Sending telemetry through a proxy
320320
---------------------------------
321321

322322
If the cluster cannot directly connect to the configured telemetry
323-
endpoint (default ``telemetry.ceph.com``), you can configure a HTTP/HTTPS
324-
proxy server with:
323+
endpoint (default: ``telemetry.ceph.com``), configure a HTTP/HTTPS
324+
proxy server by running a command of the following form:
325325

326326
.. prompt:: bash #
327327

328328
ceph config set mgr mgr/telemetry/proxy https://10.0.0.1:8080
329329

330-
You can also include a ``user:pass`` if needed:
330+
Include a ``user:pass`` if needed by running a command of the following form:
331331

332332
.. prompt:: bash #
333333

@@ -337,8 +337,9 @@ You can also include a ``user:pass`` if needed:
337337
Contact and Description
338338
-----------------------
339339

340-
A contact and description can be added to the report. This is
341-
completely optional, and disabled by default:
340+
A contact and description can be added to the report. This is optional and is
341+
disabled by default. Run commands of the following forms to add contacts and
342+
descriptions:
342343

343344
.. prompt:: bash #
344345

@@ -357,13 +358,13 @@ To participate in a leaderboard in the `public dashboards
357358
ceph config set mgr mgr/telemetry/leaderboard true
358359

359360
The leaderboard displays basic information about the cluster. This includes the
360-
total storage capacity and the number of OSDs. To add a description of the
361-
cluster, run a command of the following form:
361+
cluster's total storage capacity and the number of OSDs. To add a description
362+
of the cluster so that it can more easily be identified on the leaderboard, run
363+
a command of the following form:
362364

363365
.. prompt:: bash #
364366

365367
ceph config set mgr mgr/telemetry/leaderboard_description 'Ceph cluster for Computational Biology at the University of XYZ'
366368

367369
If the ``ident`` channel is enabled, its details will not be displayed in the
368370
leaderboard.
369-

0 commit comments

Comments
 (0)