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
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
+.. _upmap:
+
Using the pg-upmap
==================
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
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``