From eb7478901be6f476d767e150da2695fa18745efe Mon Sep 17 00:00:00 2001 From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Sun, 18 May 2025 12:25:07 +0700 Subject: [PATCH] doc: Fix missing blank line Sphinx warnings Fix four warnings from Sphinx about missing blank line after explicit markup. Indent content in list items correctly, fixing formatting errors. Signed-off-by: Ville Ojamo <14869000+bluikko@users.noreply.github.com> (cherry picked from commit 5e1b3cd566fd700b36001551d1c7e092fc850def) --- doc/cephfs/troubleshooting.rst | 39 +++++++++++++++++----------------- doc/dev/cephfs-mirroring.rst | 3 +++ 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/doc/cephfs/troubleshooting.rst b/doc/cephfs/troubleshooting.rst index e96fe2454e857..ba04a9cc14cee 100644 --- a/doc/cephfs/troubleshooting.rst +++ b/doc/cephfs/troubleshooting.rst @@ -81,13 +81,13 @@ things to do: * **Deny all reconnect to clients.** This effectively blocklists all existing CephFS sessions so all mounts will hang or become unavailable. -.. code:: bash + .. code:: bash - ceph config set mds mds_deny_all_reconnect true + ceph config set mds mds_deny_all_reconnect true Remember to undo this after the MDS becomes active. -.. note:: This does not prevent new sessions from connecting. For that, see the ``refuse_client_session`` file system setting. + .. note:: This does not prevent new sessions from connecting. For that, see the ``refuse_client_session`` file system setting. * **Extend the MDS heartbeat grace period**. This avoids replacing an MDS that appears "stuck" doing some operation. Sometimes recovery of an MDS may involve an @@ -96,23 +96,23 @@ things to do: normal amount of time to complete (indicated by your reading this document). Avoid unnecessary replacement loops by extending the heartbeat graceperiod: -.. code:: bash + .. code:: bash - ceph config set mds mds_heartbeat_grace 3600 + ceph config set mds mds_heartbeat_grace 3600 -.. note:: This has the effect of having the MDS continue to send beacons to the monitors - even when its internal "heartbeat" mechanism has not been reset (beat) in one - hour. The previous mechanism for achieving this was via the - `mds_beacon_grace` monitor setting. + .. note:: This has the effect of having the MDS continue to send beacons to the monitors + even when its internal "heartbeat" mechanism has not been reset (beat) in one + hour. The previous mechanism for achieving this was via the + `mds_beacon_grace` monitor setting. * **Disable open file table prefetch.** Normally, the MDS will prefetch directory contents during recovery to heat up its cache. During long recovery, the cache is probably already hot **and large**. So this behavior can be undesirable. Disable using: -.. code:: bash + .. code:: bash - ceph config set mds mds_oft_prefetch_dirfrags false + ceph config set mds mds_oft_prefetch_dirfrags false * **Turn off clients.** Clients reconnecting to the newly ``up:active`` MDS may cause new load on the file system when it's just getting back on its feet. @@ -122,9 +122,9 @@ things to do: You can do this manually or use the new file system tunable: -.. code:: bash + .. code:: bash - ceph fs set refuse_client_session true + ceph fs set refuse_client_session true That prevents any clients from establishing new sessions with the MDS. @@ -139,26 +139,27 @@ things to do: asynchronously purging trashed/deleted subvolumes. To help troubleshooting or recovery effort, these purge threads can be disabled using: -.. code:: bash + .. code:: bash - ceph config set mgr mgr/volumes/pause_purging true + ceph config set mgr mgr/volumes/pause_purging true To resume purging run:: - ceph config set mgr mgr/volumes/pause_purging false + ceph config set mgr mgr/volumes/pause_purging false .. _pause-clone-threads: + * **Turn off async cloner threads** The volumes plugin spawns threads for asynchronously cloning subvolume snapshots. To help troubleshooting or recovery effort, these cloner threads can be disabled using: -.. code:: bash + .. code:: bash - ceph config set mgr mgr/volumes/pause_cloning true + ceph config set mgr mgr/volumes/pause_cloning true To resume cloning run:: - ceph config set mgr mgr/volumes/pause_cloning false + ceph config set mgr mgr/volumes/pause_cloning false Expediting MDS journal trim diff --git a/doc/dev/cephfs-mirroring.rst b/doc/dev/cephfs-mirroring.rst index 31ae93a4a06f2..174735b290238 100644 --- a/doc/dev/cephfs-mirroring.rst +++ b/doc/dev/cephfs-mirroring.rst @@ -207,6 +207,7 @@ mirroring module. This means that ``/a/b/../b`` is equivalent to ``/a/b``: mkdir -p /d0/d1/d2 ceph fs snapshot mirror add cephfs /d0/d1/d2 {} ceph fs snapshot mirror add cephfs /d0/d1/../d1/d2 + :: Error EEXIST: directory /d0/d1/d2 is already tracked @@ -217,6 +218,7 @@ directories are not allowed to be added for mirroring: .. prompt:: bash $ ceph fs snapshot mirror add cephfs /d0/d1 + :: Error EINVAL: /d0/d1 is a ancestor of tracked path /d0/d1/d2 @@ -224,6 +226,7 @@ directories are not allowed to be added for mirroring: .. prompt:: bash $ ceph fs snapshot mirror add cephfs /d0/d1/d2/d3 + :: Error EINVAL: /d0/d1/d2/d3 is a subtree of tracked path /d0/d1/d2 -- 2.39.5