Skip to content

Commit cc8cfed

Browse files
committed
doc/cephfs: edit disaster-recovery-experts
Edit the first two 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. https://tracker.ceph.com/issues/69557 Signed-off-by: Zac Dover <[email protected]>
1 parent 0523e8e commit cc8cfed

File tree

1 file changed

+22
-19
lines changed

1 file changed

+22
-19
lines changed

doc/cephfs/disaster-recovery-experts.rst

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,43 +21,46 @@ Advanced: Metadata repair tools
2121
Journal export
2222
--------------
2323

24-
Before attempting dangerous operations, make a copy of the journal like so:
24+
Before attempting any dangerous operation, make a copy of the journal by
25+
running the following command:
2526

26-
::
27+
.. prompt:: bash #
2728

28-
cephfs-journal-tool journal export backup.bin
29+
cephfs-journal-tool journal export backup.bin
2930

30-
Note that this command may not always work if the journal is badly corrupted,
31-
in which case a RADOS-level copy should be made (http://tracker.ceph.com/issues/9902).
31+
If the journal is badly corrupted, this command might not work. If the journal
32+
is badly corrupted, make a RADOS-level copy
33+
(http://tracker.ceph.com/issues/9902).
3234

3335

3436
Dentry recovery from journal
3537
----------------------------
3638

3739
If a journal is damaged or for any reason an MDS is incapable of replaying it,
38-
attempt to recover what file metadata we can like so:
40+
attempt to recover file metadata by running the following command:
3941

40-
::
42+
.. prompt:: bash #
4143

42-
cephfs-journal-tool event recover_dentries summary
44+
cephfs-journal-tool event recover_dentries summary
4345

44-
This command by default acts on MDS rank 0, pass --rank=<n> to operate on other ranks.
46+
By default, this command acts on MDS rank ``0``. Pass the option ``--rank=<n>``
47+
to the ``cephfs-journal-tool`` command to operate on other ranks.
4548

46-
This command will write any inodes/dentries recoverable from the journal
47-
into the backing store, if these inodes/dentries are higher-versioned
48-
than the previous contents of the backing store. If any regions of the journal
49-
are missing/damaged, they will be skipped.
49+
This command writes all inodes and dentries recoverable from the journal into
50+
the backing store, but only if these inodes and dentries are higher-versioned
51+
than the existing contents of the backing store. Any regions of the journal
52+
that are missing or damaged will be skipped.
5053

51-
Note that in addition to writing out dentries and inodes, this command will update
52-
the InoTables of each 'in' MDS rank, to indicate that any written inodes' numbers
53-
are now in use. In simple cases, this will result in an entirely valid backing
54+
In addition to writing out dentries and inodes, this command updates the
55+
InoTables of each ``in`` MDS rank, to indicate that any written inodes' numbers
56+
are now in use. In simple cases, this will result in an entirely valid backing
5457
store state.
5558

5659
.. warning::
5760

58-
The resulting state of the backing store is not guaranteed to be self-consistent,
59-
and an online MDS scrub will be required afterwards. The journal contents
60-
will not be modified by this command, you should truncate the journal
61+
The resulting state of the backing store is not guaranteed to be
62+
self-consistent, and an online MDS scrub will be required afterwards. The
63+
journal contents will not be modified by this command. Truncate the journal
6164
separately after recovering what you can.
6265

6366
Journal truncation

0 commit comments

Comments
 (0)