From 1ad580d3af16d08c43739c1fe100896493fd0180 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 4 Dec 2022 03:03:53 +1000 Subject: [PATCH] doc/rados: add prompts to health-checks (5 of 5) Add unselectable prompts to doc/rados/operations/health-checks.rst, fifth 300 lines. https://tracker.ceph.com/issues/57108 Signed-off-by: Zac Dover (cherry picked from commit b0851995af9f4bb5750b2b8d51edcbadb4fd473b) --- doc/rados/operations/health-checks.rst | 120 +++++++++++++++++++------ 1 file changed, 94 insertions(+), 26 deletions(-) diff --git a/doc/rados/operations/health-checks.rst b/doc/rados/operations/health-checks.rst index fa9e55f14ccc0..ed3eeda9813fc 100644 --- a/doc/rados/operations/health-checks.rst +++ b/doc/rados/operations/health-checks.rst @@ -1169,9 +1169,11 @@ PGs will not (deep) scrub if they are not flagged as *clean*, which may happen if they are misplaced or degraded (see *PG_AVAILABILITY* and *PG_DEGRADED* above). -You can manually initiate a scrub of a clean PG with:: +You can manually initiate a scrub of a clean PG with: + +.. prompt:: bash $ - ceph pg deep-scrub + ceph pg deep-scrub PG_SLOW_SNAP_TRIMMING @@ -1205,23 +1207,31 @@ yet been archived (acknowledged) by the administrator. This may indicate a software bug, a hardware problem (e.g., a failing disk), or some other problem. -New crashes can be listed with:: +New crashes can be listed with: + +.. prompt:: bash $ - ceph crash ls-new + ceph crash ls-new -Information about a specific crash can be examined with:: +Information about a specific crash can be examined with: - ceph crash info +.. prompt:: bash $ + + ceph crash info This warning can be silenced by "archiving" the crash (perhaps after being examined by an administrator) so that it does not generate this -warning:: +warning: + +.. prompt:: bash $ - ceph crash archive + ceph crash archive -Similarly, all new crashes can be archived with:: +Similarly, all new crashes can be archived with: - ceph crash archive-all +.. prompt:: bash $ + + ceph crash archive-all Archived crashes will still be visible via ``ceph crash ls`` but not ``ceph crash ls-new``. @@ -1229,9 +1239,53 @@ Archived crashes will still be visible via ``ceph crash ls`` but not The time period for what "recent" means is controlled by the option ``mgr/crash/warn_recent_interval`` (default: two weeks). -These warnings can be disabled entirely with:: +These warnings can be disabled entirely with: + +.. prompt:: bash $ + + ceph config set mgr/crash/warn_recent_interval 0 + +RECENT_MGR_MODULE_CRASH +_______________________ + +One or more ceph-mgr modules has crashed recently, and the crash as +not yet been archived (acknowledged) by the administrator. This +generally indicates a software bug in one of the software modules run +inside the ceph-mgr daemon. Although the module that experienced the +problem maybe be disabled as a result, the function of other modules +is normally unaffected. + +As with the *RECENT_CRASH* health alert, the crash can be inspected with: + +.. prompt:: bash $ + + ceph crash info + +This warning can be silenced by "archiving" the crash (perhaps after +being examined by an administrator) so that it does not generate this +warning: + +.. prompt:: bash $ + + ceph crash archive - ceph config set mgr/crash/warn_recent_interval 0 +Similarly, all new crashes can be archived with: + +.. prompt:: bash $ + + ceph crash archive-all + +Archived crashes will still be visible via ``ceph crash ls`` but not +``ceph crash ls-new``. + +The time period for what "recent" means is controlled by the option +``mgr/crash/warn_recent_interval`` (default: two weeks). + +These warnings can be disabled entirely with: + +.. prompt:: bash $ + + ceph config set mgr/crash/warn_recent_interval 0 TELEMETRY_CHANGED _________________ @@ -1246,21 +1300,27 @@ report, Ceph will require the administrator to re-enable telemetry to ensure they have an opportunity to (re)review what information will be shared. -To review the contents of the telemetry report,:: +To review the contents of the telemetry report: + +.. prompt:: bash $ - ceph telemetry show + ceph telemetry show Note that the telemetry report consists of several optional channels that may be independently enabled or disabled. For more information, see :ref:`telemetry`. -To re-enable telemetry (and make this warning go away),:: +To re-enable telemetry (and make this warning go away): + +.. prompt:: bash $ + + ceph telemetry on - ceph telemetry on +To disable telemetry (and make this warning go away): -To disable telemetry (and make this warning go away),:: +.. prompt:: bash $ - ceph telemetry off + ceph telemetry off AUTH_BAD_CAPS _____________ @@ -1274,16 +1334,20 @@ capabilities were set with an older version of Ceph that did not properly validate their syntax, or if the syntax of the capabilities has changed. -The user in question can be removed with:: +The user in question can be removed with: - ceph auth rm +.. prompt:: bash $ + + ceph auth rm (This will resolve the health alert, but obviously clients will not be able to authenticate as that user.) -Alternatively, the capabilities for the user can be updated with:: +Alternatively, the capabilities for the user can be updated with: + +.. prompt:: bash $ - ceph auth [ ...] + ceph auth [ ...] For more information about auth capabilities, see :ref:`user-management`. @@ -1300,9 +1364,11 @@ This option is normally set to five or ten minutes--enough time for a host to power-cycle or reboot. This warning can silenced by setting the -``mon_warn_on_osd_down_out_interval_zero`` to false:: +``mon_warn_on_osd_down_out_interval_zero`` to false: - ceph config global mon mon_warn_on_osd_down_out_interval_zero false +.. prompt:: bash $ + + ceph config global mon mon_warn_on_osd_down_out_interval_zero false DASHBOARD_DEBUG _______________ @@ -1313,6 +1379,8 @@ a Python traceback. This behaviour should be disabled in production environments because such a traceback might contain and expose sensible information. -The debug mode can be disabled with:: +The debug mode can be disabled with: + +.. prompt:: bash $ - ceph dashboard debug disable + ceph dashboard debug disable -- 2.47.3