diff --git a/doc/source/admin_guide.rst b/doc/source/admin_guide.rst index 4f87939c0c..d039caac24 100644 --- a/doc/source/admin_guide.rst +++ b/doc/source/admin_guide.rst @@ -98,6 +98,23 @@ This produces a great deal of output that is mostly useful if you are either (a) attempting to fix the ring builder, or (b) filing a bug against the ring builder. +You may notice in the rebalance output a 'dispersion' number. What this +number means is explained in :ref:`ring_dispersion` but in essence +is the percentage of partitions in the ring that have too many replicas +within a particular failure domain. You can ask 'swift-ring-builder' what +the dispersion is with:: + + swift-ring-builder dispersion + +This will give you the percentage again, if you want a detailed view of +the dispersion simply add a ``--verbose``:: + + swift-ring-builder dispersion --verbose + +This will not only display the percentage but will also display a dispersion +table that lists partition dispersion by tier. You can use this table to figure +out were you need to add capacity or to help tune an :ref:`ring_overload` value. + ----------------------- Scripting Ring Creation ----------------------- diff --git a/doc/source/overview_ring.rst b/doc/source/overview_ring.rst index 181b2f143c..321b5ac8bc 100644 --- a/doc/source/overview_ring.rst +++ b/doc/source/overview_ring.rst @@ -158,6 +158,8 @@ for the ring. This means that some partitions will have more replicas than others. For example, if a ring has 3.25 replicas, then 25% of its partitions will have four replicas, while the remaining 75% will have just three. +.. _ring_dispersion: + ********** Dispersion ********** @@ -173,6 +175,8 @@ the dispersion metric. A lower dispersion value is better, and the value can be used to find the proper value for "overload". +.. _ring_overload: + ******** Overload ********