From a78d600e6b368255096d6f0bbee8e53553307118 Mon Sep 17 00:00:00 2001 From: Sage Weil Date: Sat, 18 Aug 2018 09:24:31 -0500 Subject: [PATCH] doc: move mgr/balancer to rados/operations/balancer Signed-off-by: Sage Weil --- doc/mgr/index.rst | 1 - doc/{mgr => rados/operations}/balancer.rst | 17 ++++------------- doc/rados/operations/data-placement.rst | 6 ++++++ 3 files changed, 10 insertions(+), 14 deletions(-) rename doc/{mgr => rados/operations}/balancer.rst (93%) diff --git a/doc/mgr/index.rst b/doc/mgr/index.rst index e00c0381a052b..f6ad6412be53f 100644 --- a/doc/mgr/index.rst +++ b/doc/mgr/index.rst @@ -28,7 +28,6 @@ sensible. Installation and Configuration Writing plugins Writing orchestrator plugins - Balancer plugin Dashboard plugin Local pool plugin RESTful plugin diff --git a/doc/mgr/balancer.rst b/doc/rados/operations/balancer.rst similarity index 93% rename from doc/mgr/balancer.rst rename to doc/rados/operations/balancer.rst index 52165e7cf2d3d..120e29041fe15 100644 --- a/doc/mgr/balancer.rst +++ b/doc/rados/operations/balancer.rst @@ -1,23 +1,14 @@ -Balancer plugin -=============== +Balancer +======== -The *balancer* plugin can optimize the placement of PGs across OSDs in +The *balancer* can optimize the placement of PGs across OSDs in order to achieve a balanced distribution, either automatically or in a supervised fashion. -Enabling --------- - -The *balancer* module is enabled with:: - - ceph mgr module enable balancer - -(It is enabled by default.) - Status ------ -The current status of the balancer can be check at any time with:: +The current status of the balancer can be checked at any time with:: ceph balancer status diff --git a/doc/rados/operations/data-placement.rst b/doc/rados/operations/data-placement.rst index 6237685c5e2b8..bd9bd7ec74639 100644 --- a/doc/rados/operations/data-placement.rst +++ b/doc/rados/operations/data-placement.rst @@ -28,6 +28,11 @@ placement planning. The main data placement planning concepts in Ceph include: for added data safety among other things. See `CRUSH Maps`_ for additional details. +- **Balancer:** The balancer is a feature that will automatically optimize the + distribution of PGs across devices to achieve a balanced data distribution, + maximizing the amount of data that can be stored in the cluster and evenly + distributing the workload across OSDs. + When you initially set up a test cluster, you can use the default values. Once you begin planning for a large Ceph cluster, refer to pools, placement groups and CRUSH for data placement operations. @@ -35,3 +40,4 @@ and CRUSH for data placement operations. .. _Pools: ../pools .. _Placement Groups: ../placement-groups .. _CRUSH Maps: ../crush-map +.. _Balancer: ../balancer -- 2.39.5