Skip to content

Commit b85b43d

Browse files
Merge pull request ceph#63255 from zdover23/wip-doc-2025-05-13-mgr-crash-62782-followup
doc/mgr: edit crash.rst
2 parents c0a7453 + aa2d9f9 commit b85b43d

File tree

1 file changed

+27
-19
lines changed

1 file changed

+27
-19
lines changed

doc/mgr/crash.rst

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@ it in the Ceph cluster for later analysis.
66
Enabling
77
--------
88

9-
The *crash* module is enabled with::
9+
Enable the *crash* module by running the following command:
1010

11-
ceph mgr module enable crash
11+
.. prompt:: bash #
1212

13-
The *crash* upload key is generated with::
13+
ceph mgr module enable crash
1414

15-
ceph auth get-or-create client.crash mon 'profile crash' mgr 'profile crash'
15+
Generate the *crash* upload key by running the following command:
16+
17+
.. prompt:: bash #
18+
19+
ceph auth get-or-create client.crash mon 'profile crash' mgr 'profile crash'
1620

1721
On each node, you should store this key in
1822
``/etc/ceph/ceph.client.crash.keyring``.
@@ -39,57 +43,61 @@ and a keyring needs to be in ``/etc/ceph``.
3943

4044
Commands
4145
--------
42-
::
4346

44-
ceph crash post -i <metafile>
47+
.. prompt:: bash #
48+
49+
ceph crash post -i <metafile>
4550

4651
Save a crash dump. The metadata file is a JSON blob stored in the crash
4752
dir as ``meta``. As usual, the ceph command can be invoked with ``-i -``,
4853
and will read from stdin.
4954

50-
::
55+
.. prompt:: bash #
5156

52-
ceph crash rm <crashid>
57+
ceph crash rm <crashid>
5358

5459
Remove a specific crash dump.
5560

56-
::
61+
.. prompt:: bash #
5762

58-
ceph crash ls
63+
ceph crash ls
5964

6065
List the timestamp/uuid crashids for all new and archived crash info.
6166

62-
::
6367

64-
ceph crash ls-new
68+
.. prompt:: bash #
69+
70+
ceph crash ls-new
6571

6672
List the timestamp/uuid crashids for all newcrash info.
6773

68-
::
6974

70-
ceph crash stat
75+
.. prompt:: bash #
76+
77+
ceph crash stat
7178

7279
Show a summary of saved crash info grouped by age.
7380

74-
::
81+
.. prompt:: bash #
7582

76-
ceph crash info <crashid>
83+
ceph crash info <crashid>
7784

7885
Show all details of a saved crash.
7986

80-
::
87+
88+
.. prompt:: bash #
8189

8290
ceph crash prune <keep>
8391

8492
Remove saved crashes older than 'keep' days. <keep> must be an integer.
8593

86-
::
94+
.. prompt:: bash #
8795

8896
ceph crash archive <crashid>
8997

9098
Archive a crash report so that it is no longer considered for the ``RECENT_CRASH`` health check and does not appear in the ``crash ls-new`` output (it will still appear in the ``crash ls`` output).
9199

92-
::
100+
.. prompt:: bash #
93101

94102
ceph crash archive-all
95103

0 commit comments

Comments
 (0)