From beeb1401785f297861c50f724c2fa06f18c4196b Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 27 Aug 2021 09:52:51 +1000 Subject: [PATCH] doc/mgr: add progress module documentation This PR ingests the work added to the documentation in PR#29335. The technical information in this PR concerns the installation and use of the "Progress Module". Signed-off-by: Zac Dover Signed-off-by: kamoltat --- doc/mgr/index.rst | 1 + doc/mgr/progress.rst | 47 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+) create mode 100644 doc/mgr/progress.rst diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index 50754a5e2b54..7d431f22d275 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -47,3 +47,4 @@ sensible. Rook module MDS Autoscaler module NFS module + Progress Module diff --git a/doc/mgr/progress.rst b/doc/mgr/progress.rst new file mode 100644 index 000000000000..19c1e11f94ac --- /dev/null +++ b/doc/mgr/progress.rst @@ -0,0 +1,47 @@ +Progress Module +=============== + +The progress module is used to inform users about the recovery progress of PGs +(Placement Groups) that are affected by events such as (1) OSDs being marked +in or out and (2) ``pg_autoscaler`` trying to match the target PG number. + +The ``ceph -s`` command returns something called " Global Recovery Progress", +which reports the overall recovery progress of PGs and is based on the number +of PGs that are in the ``active+clean`` state. + +Enabling +-------- + +The *progress* module is enabled by default, but it can be enabled manually by +running the following command: + +.. prompt:: bash # + + ceph progress on + +The module can be disabled at anytime by running the following command: + +.. prompt:: bash # + + ceph progress off + +Commands +-------- + +Show the summary of all the ongoing and completed events and their duration: + +.. prompt:: bash # + + ceph progress + +Show the summary of ongoing and completed events in JSON format: + +.. prompt:: bash # + + ceph progress json + +Clear all ongoing and completed events: + +.. prompt:: bash # + + ceph progress clear -- 2.47.3