diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-21 11:54:28 +0000 |
commit | e6918187568dbd01842d8d1d2c808ce16a894239 (patch) | |
tree | 64f88b554b444a49f656b6c656111a145cbbaa28 /doc/mgr/progress.rst | |
parent | Initial commit. (diff) | |
download | ceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip |
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | doc/mgr/progress.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/doc/mgr/progress.rst b/doc/mgr/progress.rst new file mode 100644 index 000000000..77a8a408a --- /dev/null +++ b/doc/mgr/progress.rst @@ -0,0 +1,58 @@ +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 + +PG Recovery Event +----------------- + +An event for each PG affected by recovery event can be shown in +`ceph progress` This is completely optional, and disabled by default +due to CPU overheard: + +.. prompt:: bash # + + ceph config set mgr mgr/progress/allow_pg_recovery_event true |