Skip to content

Commit 1f0bfe1

Browse files
doc/cephfs: add note for config option pause_purging and pause_cloning
Update documentation for add information about mgr/vol config options "pause_purging" and "pause_cloning". Signed-off-by: Rishabh Dave <[email protected]>
1 parent e7eb36e commit 1f0bfe1

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

doc/cephfs/fs-volumes.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -959,6 +959,32 @@ Configure the maximum number of concurrent clone operations. The default is 4:
959959

960960
ceph config set mgr mgr/volumes/max_concurrent_clones <value>
961961

962+
Pause the threads that asynchronously purge trashed subvolumes. This option is
963+
useful during cluster recovery scenarios:
964+
965+
.. prompt:: bash #
966+
967+
ceph config set mgr/volumes/pause_purging true
968+
969+
To resume purging threads:
970+
971+
.. prompt:: bash #
972+
973+
ceph config set mgr/volumes/pause_purging false
974+
975+
Pause the threads that asynchronously clone subvolume snapshots. This option is
976+
useful during cluster recovery scenarios:
977+
978+
.. prompt:: bash #
979+
980+
ceph config set mgr/volumes/pause_cloning true
981+
982+
To resume cloning threads:
983+
984+
.. prompt:: bash #
985+
986+
ceph config set mgr/volumes/pause_cloning false
987+
962988
Configure the ``snapshot_clone_no_wait`` option:
963989

964990
The ``snapshot_clone_no_wait`` config option is used to reject clone-creation

doc/cephfs/troubleshooting.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,31 @@ things to do:
134134
be changed in such circumstances, run the command to change ``max_mds`` with
135135
the confirmation flag (``--yes-i-really-mean-it``)
136136

137+
* **Turn off async purge threads** The volumes plugin spawns threads for
138+
asynchronously purging trashed/deleted subvolumes. To help troubleshooting or
139+
recovery effort, these purge threads can be disabled using:
140+
141+
.. code:: bash
142+
143+
ceph config set mgr mgr/volumes/pause_purging true
144+
145+
To resume purging run::
146+
147+
ceph config set mgr mgr/volumes/pause_purging false
148+
149+
* **Turn off async cloner threads** The volumes plugin spawns threads for
150+
asynchronously cloning subvolume snapshots. To help troubleshooting or
151+
recovery effort, these cloner threads can be disabled using:
152+
153+
.. code:: bash
154+
155+
ceph config set mgr mgr/volumes/pause_cloning true
156+
157+
To resume cloning run::
158+
159+
ceph config set mgr mgr/volumes/pause_cloning false
160+
161+
137162
138163
Expediting MDS journal trim
139164
===========================

0 commit comments

Comments
 (0)