From aa2d9f98676928df02f898512f6eedc7c2bccd69 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 13 May 2025 16:17:39 +1000 Subject: [PATCH] doc/mgr: edit crash.rst Edit doc/mgr/crash.rst. Add prompts and correct some of the inelegant English present in the file. This commit is part of a project to separate out the twenty-five files that were committed to https://github.com/ceph/ceph/pull/62782. Credit for this initiative should go to Ville Ojamo. Signed-off-by: Zac Dover --- doc/mgr/crash.rst | 46 +++++++++++++++++++++++++++------------------- 1 file changed, 27 insertions(+), 19 deletions(-) diff --git a/doc/mgr/crash.rst b/doc/mgr/crash.rst index 656c7a2d4ef31..e7dab9d7c6794 100644 --- a/doc/mgr/crash.rst +++ b/doc/mgr/crash.rst @@ -6,13 +6,17 @@ it in the Ceph cluster for later analysis. Enabling -------- -The *crash* module is enabled with:: +Enable the *crash* module by running the following command: - ceph mgr module enable crash +.. prompt:: bash # -The *crash* upload key is generated with:: + ceph mgr module enable crash - ceph auth get-or-create client.crash mon 'profile crash' mgr 'profile crash' +Generate the *crash* upload key by running the following command: + +.. prompt:: bash # + + ceph auth get-or-create client.crash mon 'profile crash' mgr 'profile crash' On each node, you should store this key in ``/etc/ceph/ceph.client.crash.keyring``. @@ -39,57 +43,61 @@ and a keyring needs to be in ``/etc/ceph``. Commands -------- -:: - ceph crash post -i +.. prompt:: bash # + + ceph crash post -i Save a crash dump. The metadata file is a JSON blob stored in the crash dir as ``meta``. As usual, the ceph command can be invoked with ``-i -``, and will read from stdin. -:: +.. prompt:: bash # - ceph crash rm + ceph crash rm Remove a specific crash dump. -:: +.. prompt:: bash # - ceph crash ls + ceph crash ls List the timestamp/uuid crashids for all new and archived crash info. -:: - ceph crash ls-new +.. prompt:: bash # + + ceph crash ls-new List the timestamp/uuid crashids for all newcrash info. -:: - ceph crash stat +.. prompt:: bash # + + ceph crash stat Show a summary of saved crash info grouped by age. -:: +.. prompt:: bash # - ceph crash info + ceph crash info Show all details of a saved crash. -:: + +.. prompt:: bash # ceph crash prune Remove saved crashes older than 'keep' days. must be an integer. -:: +.. prompt:: bash # ceph crash archive 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). -:: +.. prompt:: bash # ceph crash archive-all -- 2.39.5