From 191cce74e164c1b9cc50bfaca96600b532b7bce5 Mon Sep 17 00:00:00 2001 From: John Spray Date: Tue, 28 Nov 2017 13:05:57 -0500 Subject: [PATCH] doc: note new mgr module error codes Signed-off-by: John Spray --- doc/rados/operations/health-checks.rst | 32 ++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/doc/rados/operations/health-checks.rst b/doc/rados/operations/health-checks.rst index 99621323d3a..c43e1e57a1f 100644 --- a/doc/rados/operations/health-checks.rst +++ b/doc/rados/operations/health-checks.rst @@ -21,6 +21,38 @@ that are defined by ceph-mgr python modules. Definitions =========== +Manager +------- + +MGR_MODULE_DEPENDENCY +_____________________ + +An enabled manager module is failing its dependency check. This health check +should come with an explanatory message from the module about the problem. + +For example, a module might report that a required package is not installed: +install the required package and restart your manager daemons. + +This health check is only applied to enabled modules. If a module is +not enabled, you can see whether it is reporting dependency issues in +the output of `ceph module ls`. + + +MGR_MODULE_ERROR +________________ + +A manager module has experienced an unexpected error. Typically, +this means an unhandled exception was raised from the module's `serve` +function. The human readable description of the error may be obscurely +worded if the exception did not provide a useful description of itself. + +This health check may indicate a bug: please open a Ceph bug report if you +think you have encountered a bug. + +If you believe the error is transient, you may restart your manager +daemon(s), or use `ceph mgr fail` on the active daemon to prompt +a failover to another daemon. + OSDs ---- -- 2.39.5