doc/rados/operations: document ceph balancer status detail

Document change in ceph#54801 Signed-off-by: Laura Flores <[email protected]>
zmc · Jan 3, 2024 · 159751b · 159751b
1 parent 16ffaaf
commit 159751b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/PendingReleaseNotes b/PendingReleaseNotes
@@ -99,6 +99,10 @@ CephFS: Disallow delegating preallocated inode ranges to clients. Config
   by disabling async recovery by setting osd_async_recovery_min_cost to a very
   large value on all OSDs until the upgrade is complete:
   ``ceph config set osd osd_async_recovery_min_cost 1099511627776``
+* RADOS: A detailed version of the `balancer status` CLI command in the balancer
+  module is now available. Users may run `ceph balancer status detail` to see more
+  details about which PGs were updated in the balancer's last optimization.
+  See https://docs.ceph.com/en/latest/rados/operations/balancer/ for more information.
 
 >=18.0.0
 

diff --git a/doc/rados/operations/balancer.rst b/doc/rados/operations/balancer.rst
@@ -205,6 +205,12 @@ command:
 
       ceph balancer status
 
+To see the status in greater detail, run the following command:
+
+   .. prompt:: bash $
+
+      ceph balancer status detail
+
 To evaluate the distribution that would result from executing a specific plan,
 run the following command: