* doc/guide.tex: Documentation for the domain_balancing_component_number option.

SVN Revision: 711

diff --git a/ChangeLog b/ChangeLog
index b92b9b1bfad9d6ef8764361d2152e81b1d0c79c4..29909342645be6955d4ba58cbb141e2ddc9100d7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2007-01-24  Mickael Remond  <mickael.remond@process-one.net>
 
+       * doc/guide.tex: Documentation for the
+       domain_balancing_component_number option.
+
        * doc/guide.tex: Documentation for domain balancing.
 
        * doc/guide.tex: mod_muc now supports cluster.

diff --git a/doc/guide.tex b/doc/guide.tex
index 49569980864946956c1bf917ecbfa9e8d00a5048..6980793484c5bb2f94691609aa35ced0483d94f4 100644 (file)
--- a/doc/guide.tex
+++ b/doc/guide.tex
@@ -906,8 +906,13 @@ Examples:
 \end{itemize}
 
 \section{Advanced configuration}
-
 \subsection{Components Load-Balancing}
+\label{componentlb}
+\ind{component load-balancing}
+
+\subsection{Domain Load-Balancing Algorithm}
+\label{domainlb}
+\ind{options!domain\_balancing}
 
 \ejabberd{} includes an algorithm to load balance the components that are plugged on an ejabberd cluster. It means that you can plug one or several instances of the same component on each ejabberd cluster and that the traffic will be automatically distributed.
 
@@ -929,6 +934,19 @@ Several balancing criterium are available:
 
 If the value corresponding to the criterium is the same, the same component instance in the cluster will be used.
 
+\subsection{Load-Balancing Buckets}
+\label{lbbuckets}
+\ind{options!domain_balancing_component_number}
+
+When there is a risk of failure for a given component, domain balancing can cause service trouble. If one component is failling the service will not work correctly unless the sessions are rebalanced.
+
+In this case, it is best to limit the problem to the sessions handled by the failling component. This is what the \term{domain_balancing_component_number} option does, making the load balancing algorithm not dynamic, but sticky on a fix number of component instances.
+
+The syntax is the following:
+\begin{verbatim}
+    {domain_balancing_component_number, "component.example.com", N}
+\end{verbatim}
+
 \section{Database and LDAP Configuration}
 \label{database}
 \ind{database}