From: Neha Ojha Date: Tue, 14 Apr 2020 21:17:15 +0000 (+0000) Subject: doc/rados/operations: update docs to reflect balancer being on by default X-Git-Tag: v17.0.0~2616^2 X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=0ec13bace9650b06ed9562afc135b4f4fb805bb0;p=ceph.git doc/rados/operations: update docs to reflect balancer being on by default Signed-off-by: Neha Ojha --- diff --git a/doc/rados/operations/balancer.rst b/doc/rados/operations/balancer.rst index b4bbfd85158ca..5146c23c2703b 100644 --- a/doc/rados/operations/balancer.rst +++ b/doc/rados/operations/balancer.rst @@ -19,17 +19,15 @@ The current status of the balancer can be checked at any time with:: Automatic balancing ------------------- -The automatic balancing can be enabled, using the default settings, with:: - - ceph balancer on - -The balancer can be turned back off again with:: +The automatic balancing feature is enabled by default in ``upmap`` +mode. Please refer to :ref:`upmap` for more details. The balancer can be +turned off with:: ceph balancer off -This will use the ``crush-compat`` mode, which is backward compatible -with older clients, and will make small changes to the data -distribution over time to ensure that OSDs are equally utilized. +The balancer mode can be changed to ``crush-compat`` mode, which is +backward compatible with older clients, and will make small changes to +the data distribution over time to ensure that OSDs are equally utilized. Throttling @@ -86,11 +84,7 @@ There are currently two supported balancer modes: Note that using upmap requires that all clients be Luminous or newer. -The default mode is ``crush-compat``. The mode can be adjusted with:: - - ceph balancer mode upmap - -or:: +The default mode is ``upmap``. The mode can be adjusted with:: ceph balancer mode crush-compat diff --git a/doc/rados/operations/upmap.rst b/doc/rados/operations/upmap.rst index 8bad0d9592859..98737e9579d48 100644 --- a/doc/rados/operations/upmap.rst +++ b/doc/rados/operations/upmap.rst @@ -1,3 +1,5 @@ +.. _upmap: + Using the pg-upmap ================== @@ -12,8 +14,13 @@ clients understand the new *pg-upmap* structure in the OSDMap. Enabling -------- -To allow use of the feature, you must tell the cluster that it only -needs to support luminous (and newer) clients with:: +New clusters will have this module on by default. The cluster must only +have luminous (and newer) clients. You can the turn the balancer off with:: + + ceph balancer off + +To allow use of the feature on existing clusters, you must tell the +cluster that it only needs to support luminous (and newer) clients with:: ceph osd set-require-min-compat-client luminous @@ -26,7 +33,7 @@ use with:: Balancer module ----------------- -The new `balancer` module for ceph-mgr will automatically balance +The `balancer` module for ceph-mgr will automatically balance the number of PGs per OSD. See ``Balancer``