From f5ca7550ee3dab3cefafca4270388a5cb5f9618b Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Mon, 26 May 2025 09:45:58 +1000 Subject: [PATCH] doc/mgr: edit progress.rst Edit doc/mgr/progress.rst. This is part of a project to separate out the twenty-five files that were committed to https://github.com/ceph/ceph/pull/62782. Signed-off-by: Zac Dover (cherry picked from commit 9bada3be2f49377bec06f4a270dea7174777b763) --- doc/mgr/progress.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/mgr/progress.rst b/doc/mgr/progress.rst index 77a8a408a9aad..b990650ab9b08 100644 --- a/doc/mgr/progress.rst +++ b/doc/mgr/progress.rst @@ -5,7 +5,7 @@ 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", +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. @@ -17,13 +17,13 @@ running the following command: .. prompt:: bash # - ceph progress on + ceph progress on The module can be disabled at anytime by running the following command: .. prompt:: bash # - ceph progress off + ceph progress off Commands -------- @@ -32,27 +32,27 @@ Show the summary of all the ongoing and completed events and their duration: .. prompt:: bash # - ceph progress + ceph progress Show the summary of ongoing and completed events in JSON format: .. prompt:: bash # - ceph progress json + ceph progress json Clear all ongoing and completed events: .. prompt:: bash # - ceph progress clear + 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: +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 +overhead: .. prompt:: bash # - ceph config set mgr mgr/progress/allow_pg_recovery_event true + ceph config set mgr mgr/progress/allow_pg_recovery_event true -- 2.39.5