diff options
author | Zac Dover <zac.dover@gmail.com> | 2022-12-03 18:03:53 +0100 |
---|---|---|
committer | Zac Dover <zac.dover@gmail.com> | 2022-12-03 18:03:53 +0100 |
commit | b0851995af9f4bb5750b2b8d51edcbadb4fd473b (patch) | |
tree | 5df5a2ce86891908ab4bcaae3e754fb15a1119f5 /doc | |
parent | Merge pull request #49202 from zdover23/wip-doc-2022-12-01-rados-ops-erasure-... (diff) | |
download | ceph-b0851995af9f4bb5750b2b8d51edcbadb4fd473b.tar.xz ceph-b0851995af9f4bb5750b2b8d51edcbadb4fd473b.zip |
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 <zac.dover@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/rados/operations/health-checks.rst | 102 |
1 files changed, 68 insertions, 34 deletions
diff --git a/doc/rados/operations/health-checks.rst b/doc/rados/operations/health-checks.rst index c9f2bffe6fa..3895762dcd0 100644 --- a/doc/rados/operations/health-checks.rst +++ b/doc/rados/operations/health-checks.rst @@ -1188,9 +1188,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 <pgid> + ceph pg deep-scrub <pgid> PG_SLOW_SNAP_TRIMMING @@ -1224,23 +1226,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 <crash-id> +.. prompt:: bash $ + + ceph crash info <crash-id> 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 <crash-id> + ceph crash archive <crash-id> -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``. @@ -1248,9 +1258,11 @@ 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 + ceph config set mgr/crash/warn_recent_interval 0 RECENT_MGR_MODULE_CRASH _______________________ @@ -1262,19 +1274,25 @@ 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:: +As with the *RECENT_CRASH* health alert, the crash can be inspected with: - ceph crash info <crash-id> +.. prompt:: bash $ + + ceph crash info <crash-id> 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 <crash-id> + ceph crash archive <crash-id> -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``. @@ -1282,9 +1300,11 @@ 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 + ceph config set mgr/crash/warn_recent_interval 0 TELEMETRY_CHANGED _________________ @@ -1299,21 +1319,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 _____________ @@ -1327,16 +1353,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 <entity-name> +.. prompt:: bash $ + + ceph auth rm <entity-name> (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 <entity-name> <daemon-type> <caps> [<daemon-type> <caps> ...] + ceph auth <entity-name> <daemon-type> <caps> [<daemon-type> <caps> ...] For more information about auth capabilities, see :ref:`user-management`. @@ -1353,9 +1383,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 _______________ @@ -1366,6 +1398,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 |