Skip to content

Commit 8eaee4d

Browse files
Merge pull request ceph#63920 from bluikko/doc-sphinx-warnings-new
doc: Fix sphinx warnings and one error
2 parents 3bd52c9 + 60f9ed8 commit 8eaee4d

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

doc/cephadm/services/snmp-gateway.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
SNMP Gateway Service
33
====================
44

5-
SNMP_ is still a widely used protocol, to monitor distributed systems and devices across a variety of hardware
6-
and software platforms. Ceph's SNMP integration focuses on forwarding alerts from its Prometheus Alertmanager
5+
`SNMP`_ is a widely used protocol for monitoring distributed systems and devices.
6+
Ceph's SNMP integration focuses on forwarding alerts from its Prometheus Alertmanager
77
cluster to a gateway daemon. The gateway daemon transforms the alert into an SNMP Notification and sends
8-
it on to a designated SNMP management platform. The gateway daemon is from the ``snmp_notifier``_ project,
8+
it on to a designated SNMP management platform. The gateway daemon is from the `snmp_notifier`_ project,
99
which provides SNMP V2c and V3 support (authentication and encryption).
1010

1111
Ceph's SNMP gateway service deploys one instance of the gateway by default. You may increase this
@@ -159,13 +159,13 @@ with a credentials file of the following form:
159159
AlertManager Integration
160160
========================
161161
When an SNMP gateway service is deployed or updated, the Prometheus Alertmanager configuration is automatically updated to forward any
162-
alert that has an OID_ label to the SNMP gateway daemon for processing.
162+
alert that has an `OID`_ label to the SNMP gateway daemon for processing.
163163

164164
.. _OID: https://en.wikipedia.org/wiki/Object_identifier
165165

166166
Implementing the MIB
167167
======================
168168
To make sense of SNMP notifications and traps, you'll need to apply the MIB to your SNMP management platform. The MIB (``CEPH-MIB.txt``) can
169-
downloaded from the main Ceph GitHub repository_
169+
downloaded from the main Ceph GitHub `repository`_
170170

171171
.. _repository: https://github.com/ceph/ceph/tree/master/monitoring/snmp

doc/dev/cephfs-mirroring.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -387,6 +387,7 @@ status. Commands of this kind take the form ``filesystem-name@filesystem-id peer
387387
.. prompt:: bash $
388388

389389
ceph --admin-daemon /var/run/ceph/cephfs-mirror.asok fs mirror peer status cephfs@360 a2dc7784-e7a1-4723-b103-03ee8d8768f8
390+
390391
::
391392

392393
{
@@ -432,6 +433,7 @@ status:
432433

433434
ceph fs snapshot mirror add cephfs /f0
434435
ceph --admin-daemon /var/run/ceph/cephfs-mirror.asok fs mirror peer status cephfs@360 a2dc7784-e7a1-4723-b103-03ee8d8768f8
436+
435437
::
436438

437439
{
@@ -470,6 +472,7 @@ mapped to use, run a command of the following form:
470472
.. prompt:: bash $
471473

472474
ceph fs snapshot mirror dirmap cephfs /d0/d1/d2
475+
473476
::
474477

475478
{
@@ -489,6 +492,7 @@ If no mirror daemons are running, the same command shows the following:
489492
.. prompt:: bash $
490493

491494
ceph fs snapshot mirror dirmap cephfs /d0/d1/d2
495+
492496
::
493497

494498
{

doc/mgr/telemetry.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ and other parameters that help the project develop a better understanding of
6565
the way Ceph is used.
6666

6767
Data is sent secured to
68-
`https://telemetry.ceph.com<https://telemetry.ceph.com>`_.
68+
`https://telemetry.ceph.com <https://telemetry.ceph.com>`_.
6969

7070
Individual channels can be enabled or disabled by running the following
7171
commands:

0 commit comments

Comments
 (0)