[ovs-dev] [PATCH] docs: Update for auto load balance threshold parameters.

[Stokes, Ian]

> Update the docs to remove the previously hardcoded values
> and mention the load and improvement thresholds when
> describing the operation of auto load balance.
> 

Hi Kevin,

Thanks for the patch, LGTM, tested documentation builds and is in the clear.

@Ilya Maximets any input your side? If it's ok for you I'm happy to merge to master and 2.15.

Regards
Ian

> Fixes: 62ab5594c20c ("dpif-netdev: Add parameters to configure PMD auto load
> balance.")
> Signed-off-by: Kevin Traynor <ktraynor at redhat.com>
> ---
>  Documentation/topics/dpdk/pmd.rst | 21 ++++++++++++++++++---
>  1 file changed, 18 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/topics/dpdk/pmd.rst
> b/Documentation/topics/dpdk/pmd.rst
> index 6f1fdcbc6..830559a6f 100644
> --- a/Documentation/topics/dpdk/pmd.rst
> +++ b/Documentation/topics/dpdk/pmd.rst
> @@ -211,6 +211,13 @@ If any of above is not met PMD Auto Load Balancing is
> disabled.
>  Once auto load balancing is set, each non-isolated PMD measures the
> processing
>  load for each of its associated queues every 10 seconds. If the aggregated PMD
> -load reaches 95% for 6 consecutive intervals then PMD considers itself to be
> -overloaded.
> +load reaches the load threshold for 6 consecutive intervals then PMD considers
> +itself to be overloaded.
> +
> +The load threshold can be configured by::
> +
> +    $ ovs-vsctl set open_vswitch .\
> +        other_config:pmd-auto-lb-load-threshold="<load>"
> +
> +If not set, the default load threshold is 95%.
> 
>  If any PMD is overloaded, a dry-run of the PMD assignment algorithm is
> @@ -219,5 +226,13 @@ to PMD assignments.
> 
>  If the resultant mapping of dry-run indicates an improved distribution of the
> -load then the actual reassignment will be performed.
> +load by at least the variance improvement threshold then the actual
> +reassignment will be performed.
> +
> +The variance improvement threshold can be configured by::
> +
> +    $ ovs-vsctl set open_vswitch .\
> +        other_config:pmd-auto-lb-improvement-threshold="<improvement>"
> +
> +If not set, the default variance improvement threshold is 25%.
> 
>  .. note::
> --
> 2.26.2