Skip to content

Commit 4f3a69e

Browse files
doc/cephfs: edit disaster-recovery-experts (2 of x)
Edit the third and fourth sections of doc/cephfs/disaster-recovery-experts.rst in preparation for adding deeper explanations of the contexts in which one should use the various commands listed on that page. Follows ceph#61426 https://tracker.ceph.com/issues/69557 Co-authored-by: Anthony D'Atri <[email protected]> Signed-off-by: Zac Dover <[email protected]>
1 parent 887ff24 commit 4f3a69e

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

doc/cephfs/disaster-recovery-experts.rst

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -66,40 +66,44 @@ store state.
6666
Journal truncation
6767
------------------
6868

69-
If the journal is corrupt or MDSs cannot replay it for any reason, you can
70-
truncate it like so:
69+
Use a command of the following form to truncate any journal that is corrupt or
70+
that an MDS cannot replay:
7171

72-
::
72+
.. prompt:: bash #
7373

74-
cephfs-journal-tool [--rank=<fs_name>:{mds-rank|all}] journal reset --yes-i-really-really-mean-it
74+
cephfs-journal-tool [--rank=<fs_name>:{mds-rank|all}] journal reset --yes-i-really-really-mean-it
7575

76-
Specify the filesystem and the MDS rank using the ``--rank`` option when the file system has/had
77-
multiple active MDS.
76+
Specify the filesystem and the MDS rank using the ``--rank`` option when the
77+
file system has or had multiple active MDS.
7878

7979
.. warning::
8080

81-
Resetting the journal *will* lose metadata unless you have extracted
82-
it by other means such as ``recover_dentries``. It is likely to leave
83-
some orphaned objects in the data pool. It may result in re-allocation
84-
of already-written inodes, such that permissions rules could be violated.
81+
Resetting the journal *will* cause metadata to be lost unless you have
82+
extracted it by other means such as ``recover_dentries``. Resetting the
83+
journal is likely to leave orphaned objects in the data pool. Resetting
84+
the journal may result in the re-allocation of already-written inodes,
85+
which means that permissions rules could be violated.
8586

8687
MDS table wipes
8788
---------------
8889

8990
After the journal has been reset, it may no longer be consistent with respect
9091
to the contents of the MDS tables (InoTable, SessionMap, SnapServer).
9192

92-
To reset the SessionMap (erase all sessions), use:
93+
Use the following command to reset the SessionMap (this will erase all
94+
sessions):
9395

94-
::
96+
.. prompt:: bash #
9597

9698
cephfs-table-tool all reset session
9799

98-
This command acts on the tables of all 'in' MDS ranks. Replace 'all' with an MDS
99-
rank to operate on that rank only.
100+
This command acts on the tables of all MDS ranks that are ``in``. To operate
101+
only on a specified rank, replace ``all`` in the above command with an MDS
102+
rank.
100103

101-
The session table is the table most likely to need resetting, but if you know you
102-
also need to reset the other tables then replace 'session' with 'snap' or 'inode'.
104+
Of all tables, the session table is the table most likely to require a reset.
105+
If you know that you need also to reset the other tables, then replace
106+
``session`` with ``snap`` or ``inode``.
103107

104108
MDS map reset
105109
-------------

0 commit comments

Comments
 (0)