Revision: 6e60d38ae0d4
Author:   [email protected] <[email protected]>
Date:     Tue Aug  7 12:56:02 2012
Log:      rework section 5.x with comments from Jean

http://code.google.com/p/sipservlets/source/detail?r=6e60d38ae0d4

Modified:
 /docs/sources/src/main/resources/en-US/concept-section-SS_Load_Balancer.xml
/docs/sources/src/main/resources/en-US/concept-section-SS_for_JBoss-Passivation_Support.xml

=======================================
--- /docs/sources/src/main/resources/en-US/concept-section-SS_Load_Balancer.xml Tue Aug 7 04:45:24 2012 +++ /docs/sources/src/main/resources/en-US/concept-section-SS_Load_Balancer.xml Tue Aug 7 12:56:02 2012
@@ -6,90 +6,29 @@

 <section>

-<title> Detailed Load-balancer Settings </title>
+<section id="sslb-SIP_Load_Balancing_Basics">
+    <title>SIP Load Balancing Basics</title>

-<para>
-By default, the servers are configured with one SIP load-balancer set to the IP address <literal>127.0.0.1</literal>. This is specified in the balancers attribute in the <filename>server.xml</filename> configuration file as follows: + <para>All User Agents send SIP messages, such as <literal>INVITE</literal> and <literal>MESSAGE</literal>, to the same SIP URI (the IP address and port number of the SIP Load Balancer on the WAN). The Load Balancer then parses, alters, and forwards those messages to an available node in the cluster. If the message was sent as a part of an existing SIP session, it will be forwarded to the cluster node which processed that User Agent's original transaction request.
+    </para>
+ <para>The SIP Server that receives the message acts upon it and sends a response back to the SIP Load Balancer. The SIP Load Balancer reparses, alters and forwards the message back to the original User Agent. This entire proxying and provisioning process is carried out independent of the User Agent, which is only concerned with the SIP service or application it is using.
+    </para>
+ <para>By using the Load Balancer, SIP traffic is balanced across a pool of available SIP Servers, increasing the overall throughput of the SIP service or application running on either individual nodes of the cluster. In the case of a &SHORT_PLATFORM_NAME; server with <literal>&lt;/distributed&gt;</literal> capabilities, load balancing advantages are applied across the entire cluster.
+    </para>
+ <para>The SIP Load Balancer is also able to failover requests mid-call from unavailable nodes to available ones, thus increasing the reliability of the SIP service or application. The Load Balancer increases throughput and reliability by dynamically provisioning SIP service requests and responses across responsive nodes in a cluster. This enables SIP applications to meet the real-time demand for SIP services.
+    </para>
+  </section>

-</para>

+<section id="sslb-MSS_Load_Balancer">
+<!--
+<title> Detailed Load-balancer Overview </title>
+-->

-<screen>
-&lt;Service name=&quot;jboss.web&quot;
- className=&quot;org.mobicents.servlet.sip.startup.failover.SipStandardBalancerNodeService&quot;
-  balancers=&quot;127.0.0.1&quot;
-  sipPathName=&quot;org.mobicents.ha&quot;
- sipApplicationDispatcherClassName=&quot;org.mobicents.servlet.sip.core.SipApplicationDispatcherImpl&quot;
-concurrencyControlMode=&quot;None&quot;
- darConfigurationFileLocation=&quot;conf/dars/mobicents-dar.properties&quot;
-  sipStackPropertiesFile=&quot;conf/mss-sip-stack.properties&quot;&gt;
-</screen>
+<para>The SIP Load Balancer is used to balance the load of SIP service requests and responses between nodes in a SIP Servlets Server cluster. Both &SHORT_PLATFORM_NAME; for JBoss and &SHORT_PLATFORM_NAME; for Tomcat servers can be used in conjunction with the SIP Load Balancer to increase the performance and availability of SIP services and applications. </para> + <para>In terms of functionality, the SIP Load Balancer is a simple stateless proxy server that intelligently forwards SIP session requests and responses between User Agents (UAs) on a Wide Area Network (WAN), and SIP Servlets Server nodes, which are almost always located on a Local Area Network (LAN). All SIP requests and responses pass through the SIP Load Balancer.</para>

-<para>
-Multiple load balancers can be specified and all of them will be updated on the health status of the node. The complete syntax for the balancers string is the following:
-</para>
-<screen>

-&lt;Service name=&quot;jboss.web&quot;
-      ...
- balancers=&quot;ipAddress1:sipPort1:rmiPort1;ipAddress2:sipPort2:rmiPort2;..3...4..&quot;
-  ...&gt;
-</screen>
-
-
- <para>If the RMI port is omitted, port 2000 is assumed, and if the SIP port is omitted, 5065 is assumed.</para>
-      <warning>
- <para>The SIP port specified in the balancers string for each balancer refers to the internal SIP port of the SIP balancer. That is because the internal port faces the cluster nodes directly. Requests coming through the internal port will go to the external port and vice versa. If you put the external port in the <literal>balancers</literal> string, then the SIP LB will assume that the requests comes from outside the cluster and it will route it back to some cluster node instead of routing it outside the cluster as expected. Always use the SIP internal port in the <literal>balancers</literal> string. The exception to this rule is when a single port is used for internal and external ports in the SIP load balancer. In that case, the direction analysis is done based on <literal>Via</literal> headers and the requests are routed correctly without extra settings.</para>
-        <para/>
-      </warning>
- <para>When multiple SIP load balancers are specified, the outgoing requests will always go through the first one, or an IP load balancer can be used and the requests will be distributed based on the IP balancer policy. To route the outgoing requests to a particular IP address (the IP load balancer address for example) the <literal>outboundProxy</literal> property can be used:</para>
-      <programlisting role="XML">&lt;Service name=&quot;jboss.web&quot;
-      ...
-  balancers=&quot;127.0.0.1:5060:2000;127.0.0.1:5160:2100&quot;
-outboundProxy=&quot;127.0.0.1:5500&quot;
-  ...&gt;
-</programlisting>
- <para>In this example configuration, all outbound requests will go through 127.0.0.1:5500, while the node will perform the health checks against two SIP load balancers. If the 127.0.0.1:5500 machine is an IP load balancer, it should be configured to spray the SIP load balancers, and they will route the requests outside the cluster reliably.</para> - <para>The <literal>outboundProxy</literal> attribute overrides the default effect of specifying a SIP port for SIP load balancers in the <literal>balancers</literal> string.</para>
-
-
-
-<section id="ssfjcs-binary-SIP_Servlets_Server_Cluster-Stopping">
-      <title>How to Stop &SHORT_PLATFORM_NAME;</title>
- <para>Individual nodes in the cluster should be stopped one-by-one, followed by the SIP load balancer. Refer to:</para>
-      <itemizedlist>
-        <listitem>
- <para>Stopping the SIP load balancer: <xref linkend="sslb-binary-SIP_Load_Balancer-Stopping"/>
-     </para>
-        </listitem>
-        <listitem>
- <para>Stopping &SHORT_PLATFORM_NAME; for JBoss: <xref linkend="bssswjicar-binary-SIP_Servlets_Server_with_JBoss-Stopping"/>
-     </para>
-        </listitem>
-        <listitem>
- <para>Stopping &SHORT_PLATFORM_NAME; for Tomcat: <xref linkend="bssswticar-binary-SIP_Servlets_Server_with_Tomcat-Stopping"/>
-     </para>
-        </listitem>
-      </itemizedlist>
-    </section>
-
-    <section id="ssfjcs-binary-SIP_Servlets_Server_Cluster-Testing">
-      <title>Testing</title>
- <para>To test your JBoss cluster setup for mid-call failover (Established SIP Dialog), refer to:</para>
-      <itemizedlist>
-        <listitem>
-          <para>
-      <xref linkend="ssfjfs-SS_for_JBoss-Failover_Support"/>
-     </para>
-        </listitem>
-      </itemizedlist>
-
- <para>Uninstalling a SIP Servlets Cluster would entail deleting the &PLATFORM_NAME; SIP Servlets Servers directories, the SIP Load Balancer directory, and possibly removing the unused <envar>JBOSS_HOME</envar> environment variable.</para>
-
-</section>
-
-<!-- chapter id nickname: sslb --><section id="sslb-MSS_Load_Balancer">
-  <title>Load Balancer</title>
<!--Removed star network image because it's also in the introductory section, and jdocbook can't shrink it or align the caption--> <figure>
     <title>Star Cluster Topology.</title>
     <mediaobject id="sslb-mss-MSSSIPLoadBalancer-dia-StarNetworkTopology">
@@ -98,14 +37,20 @@
       </imageobject>
     </mediaobject>
   </figure>
- <para>The SIP Load Balancer is used to balance the load of SIP service requests and responses between nodes in a SIP Servlets Server cluster. Both &SHORT_PLATFORM_NAME; for JBoss and &SHORT_PLATFORM_NAME; for Tomcat servers can be used in conjunction with the SIP Load Balancer to increase the performance and availability of SIP services and applications. </para> - <para>In terms of functionality, the SIP Load Balancer is a simple stateless proxy server that intelligently forwards SIP session requests and responses between User Agents (UAs) on a Wide Area Network (WAN), and SIP Servlets Server nodes, which are almost always located on a Local Area Network (LAN). All SIP requests and responses pass through the SIP Load Balancer.</para>
+
+</section>
+
+
+
<section id="sslb-binary-SIP_Load_Balancer-Installing_Configuring_and_Running">
-    <title>SIP Load Balancer: Installing, Configuring and Running</title>
+ <title>SIP Load Balancer: Downloading, Installing, Configuring and Running</title>
     <para>&nbsp;</para>
+<!--
<section id="sslb-binary-SIP_Load_Balancer-PreInstall_Requirements_and_Prerequisites">
       <title>Pre-Install Requirements and Prerequisites</title>
       <para>&nbsp;</para>
+
+-->
<variablelist id="sslb-binary-SIP_Load_Balancer-Software_Prerequisites">
         <title>Software Prerequisites</title>
<!--Issue #822 Editor Comment - if I understand correctly, clustering won't work on Tomcat Servlet Containers. If that is the case, it's probably easier to say:
@@ -113,8 +58,12 @@
 1. Load balancing requires at least two Sip Servlet Servers.
2. Only SIP Servlet JBoss AS containers supported. Tomcat Servlet Containers cannot be clustered.

-Or something similar to that.  Do you agree?-->        <varlistentry>
+Or something similar to that.  Do you agree?-->
+
+ <varlistentry>
<term>A JAIN SIP HA-enabled application server such as &PLATFORM_NAME; JAIN SLEE or &PLATFORM_NAME; SIP Servlets is required. </term>
+
+
           <listitem>
<para>Running the SIP Load Balancer requires at least two instances of the application server as cluster nodes nodes. Therefore, before configuring the SIP Load Balancer, we should make sure we&apos;ve installed a the SIP application server first. The &PLATFORM_NAME; SIP load balancer will work with a SIP Servlets-enabled JBoss Application Server <emphasis>or</emphasis> a JAIN SLEE application server with SIP RA.</para> <para>SIP Servlets containers based on Tomcat are also supported but the session replication is not available there, thus mid-call failover will not work.</para>
@@ -129,9 +78,21 @@
           </listitem>
         </varlistentry>
       </variablelist>
-    </section>
+
+<!--
+
+   </section>
+
+
     <section id="sslb-binary-SIP_Load_Balancer-Downloading">
       <title>Downloading</title>
+-->
+ <varlistentry>
+
+       <term>Downloading</term>
+
+ </varlistentry>
+
<para>The load balancer is located in the <filename>sip-balancer</filename> top-level directory of the &SHORT_PLATFORM_NAME; distribution. You will find the following files in the directory:</para>
       <variablelist>
         <varlistentry>
@@ -155,14 +116,34 @@
url="http://code.google.com/p/mobicents/source/browse/trunk/servers/sip-servlets/sip-servlets-impl/docs/failover-server-tomcat-6.xml";>Tomcat</ulink> container instances.</para>
      </listitem>
     </varlistentry>-->      </variablelist>
-    </section>
+<!--
+
+   </section>
     <section id="sslb-binary-SIP_Load_Balancer-Installing">
       <title>Installing</title>
- <para>The SIP load balancer executable JAR file can be extracted anywhere in the file system. It is recommended that the file is placed in the directory containing other JAR executables, so it can be easily located in the future.</para>
-    </section>
+
+-->
+
+ <varlistentry>
+<term>Installing </term>
+ </varlistentry>
+
+ <para>The SIP load balancer executable JAR file can be extracted anywhere in the file system. It is recommended that the file is placed in the directory containing other JAR executables, so it can be easily located in the future.</para>
+
+<!--
+   </section>
     <section id="sslb-binary-SIP_Load_Balancer-Configuring">
       <title>Configuring</title>
+
+
+ <varlistentry>
+<term> Configuring </term>
+ </varlistentry>
+
<para>Configuring the SIP load balancer and the two SIP Servlets-enabled Server nodes is described in <xref linkend="sslb-Configuring_the_SIP_Load_Balancer_and_Servlet_Server_Nodes"/>.</para>
+
+-->
+
<procedure id="sslb-Configuring_the_SIP_Load_Balancer_and_Servlet_Server_Nodes"> <title>Configuring the &PLATFORM_NAME; SIP Load Balancer and SIP Server Nodes</title>
         <step>
@@ -423,7 +404,11 @@
           </itemizedlist>
         </step>
       </procedure>
-      <section>
+
+</section>
+
+
+ <section>
       <note>
         <title>Configuration File Locations</title>
<para>On &SHORT_PLATFORM_NAME; for Tomcat server installations, <filename>server.xml</filename> is located in <filename>&lt;install_directory&gt;/conf</filename>.</para>
@@ -453,16 +438,129 @@
           </varlistentry>
         </variablelist>
       </section>
-      <section>
-        <title>Converged Load Balancing</title>
+
+
+<section>
+
+<title>Load Balancer Server.xml Settings </title>
+
+<para>
+By default, the servers are configured with one SIP load-balancer set to the IP address <literal>127.0.0.1</literal>. This is specified in the balancers attribute in the <filename>server.xml</filename> configuration file as follows:
+
+</para>
+
+
+<screen>
+&lt;Service name=&quot;jboss.web&quot;
+ className=&quot;org.mobicents.servlet.sip.startup.failover.SipStandardBalancerNodeService&quot;
+  balancers=&quot;127.0.0.1&quot;
+  sipPathName=&quot;org.mobicents.ha&quot;
+ sipApplicationDispatcherClassName=&quot;org.mobicents.servlet.sip.core.SipApplicationDispatcherImpl&quot;
+concurrencyControlMode=&quot;None&quot;
+ darConfigurationFileLocation=&quot;conf/dars/mobicents-dar.properties&quot;
+  sipStackPropertiesFile=&quot;conf/mss-sip-stack.properties&quot;&gt;
+</screen>
+
+<para>
+Multiple load balancers can be specified and all of them will be updated on the health status of the node. The complete syntax for the balancers string is the following:
+</para>
+<screen>
+
+&lt;Service name=&quot;jboss.web&quot;
+      ...
+ balancers=&quot;ipAddress1:sipPort1:rmiPort1;ipAddress2:sipPort2:rmiPort2;..3...4..&quot;
+  ...&gt;
+</screen>
+
+
+ <para>If the RMI port is omitted, port 2000 is assumed, and if the SIP port is omitted, 5065 is assumed.</para>
+      <warning>
+ <para>The SIP port specified in the balancers string for each balancer refers to the internal SIP port of the SIP balancer. That is because the internal port faces the cluster nodes directly. Requests coming through the internal port will go to the external port and vice versa. If you put the external port in the <literal>balancers</literal> string, then the SIP LB will assume that the requests comes from outside the cluster and it will route it back to some cluster node instead of routing it outside the cluster as expected. Always use the SIP internal port in the <literal>balancers</literal> string. The exception to this rule is when a single port is used for internal and external ports in the SIP load balancer. In that case, the direction analysis is done based on <literal>Via</literal> headers and the requests are routed correctly without extra settings.</para>
+        <para/>
+      </warning>
+ <para>When multiple SIP load balancers are specified, the outgoing requests will always go through the first one, or an IP load balancer can be used and the requests will be distributed based on the IP balancer policy. To route the outgoing requests to a particular IP address (the IP load balancer address for example) the <literal>outboundProxy</literal> property can be used:</para>
+      <programlisting role="XML">&lt;Service name=&quot;jboss.web&quot;
+      ...
+  balancers=&quot;127.0.0.1:5060:2000;127.0.0.1:5160:2100&quot;
+outboundProxy=&quot;127.0.0.1:5500&quot;
+  ...&gt;
+</programlisting>
+ <para>In this example configuration, all outbound requests will go through 127.0.0.1:5500, while the node will perform the health checks against two SIP load balancers. If the 127.0.0.1:5500 machine is an IP load balancer, it should be configured to spray the SIP load balancers, and they will route the requests outside the cluster reliably.</para> + <para>The <literal>outboundProxy</literal> attribute overrides the default effect of specifying a SIP port for SIP load balancers in the <literal>balancers</literal> string.</para>
+
+</section>
+
+
+
+
+
+
+<section id="ssfjcs-binary-SIP_Servlets_Server_Cluster-Stopping">
+      <title>How to Stop &SHORT_PLATFORM_NAME;</title>
+ <para>Individual nodes in the cluster should be stopped one-by-one, followed by the SIP load balancer. Refer to:</para>
+      <itemizedlist>
+        <listitem>
+ <para>Stopping the SIP load balancer: <xref linkend="sslb-binary-SIP_Load_Balancer-Stopping"/>
+     </para>
+        </listitem>
+        <listitem>
+ <para>Stopping &SHORT_PLATFORM_NAME; for JBoss: <xref linkend="bssswjicar-binary-SIP_Servlets_Server_with_JBoss-Stopping"/>
+     </para>
+        </listitem>
+        <listitem>
+ <para>Stopping &SHORT_PLATFORM_NAME; for Tomcat: <xref linkend="bssswticar-binary-SIP_Servlets_Server_with_Tomcat-Stopping"/>
+     </para>
+        </listitem>
+      </itemizedlist>
+    </section>
+
+    <section id="ssfjcs-binary-SIP_Servlets_Server_Cluster-Testing">
+      <title>Uninstalling SIP</title>
+<!--
+ <para>To test your JBoss cluster setup for mid-call failover (Established SIP Dialog), refer to:</para>
+      <itemizedlist>
+        <listitem>
+          <para>
+      <xref linkend="ssfjfs-SS_for_JBoss-Failover_Support"/>
+     </para>
+        </listitem>
+      </itemizedlist>
+-->
+
+ <para>Uninstalling a SIP Servlets Cluster would entail deleting the &PLATFORM_NAME; SIP Servlets Servers directories, the SIP Load Balancer directory, and possibly removing the unused <envar>JBOSS_HOME</envar> environment variable.</para>
+
+</section>
+
+
+
+  <section>
+    <title>HTTP Load Balancing Basics</title>
+ <para>In addition to the SIP load balancing, there are several options for coordinated or cooperative load balancing with other protocols such as HTTP.
+    </para>
+ <para>Typically, a JBoss Application Server will use apache HTTP server with mod_jk, mod_proxy, mod_cluster or similar extension installed as an HTTP load balancer. This apache-based load balancer will parse incoming HTTP requests and will look for the session ID of those requests in order to ensure all requests from the same session arrive at the same application server.
+    </para>
+ <para>By default, this is done by examining the <literal>jsessionid</literal> HTTP cookie or GET parameter and looking for the <literal>jvmRoute</literal> assigned to the session. The typical <literal>jsessionid</literal> value is of the form <literal>&lt;sessionId&gt;.&lt;jvmRoute&gt;</literal>. The very first request for each new HTTP session does not have a session ID assigned; the apache routes the request to a random application server node.
+    </para>
+ <para>When the node responds it assigns a session ID and <literal>jvmRoute</literal> to the response of the request in a HTTP cookie. This response goes back to the client through apache, which keeps track of which node owns each <literal>jvmRoute</literal>. Once the very first request is served this way, the subsequent requests from this session will carry the assigned cookie, and the apache load balancer will always route the requests to the node, which advertised itself as the <literal>jvmRoute</literal> owner.
+    </para>
+ <para>Instead of using apache, an integrated HTTP Load Balancer is also available. The SIP Load Balancer has a HTTP port where you can direct all incoming HTTP requests. The integrated HTTP load balancer behaves exactly like apache by default, but this behavior is extensible and can be overridden completely with the pluggable balancer algorithms. The integrated HTTP load balancer is much easier to configure and generally requires no effort, because it reuses most SIP settings and assumes reasonable default values.
+    </para>
+ <para>Unlike the native apache, the integrated HTTP Load Balancer is written completely in Java, thus a performance penalty should be expected when using it. However, the integrated HTTP Balancer has an advantage when related SIP and HTTP requests must stick to the same node.
+    </para>
+  </section>
+
+
         <section>
+
           <title>Apache HTTP Load Balancer</title>
<para>The &SHORT_PLATFORM_NAME; SIP Load Balancer can work in concert with HTTP load balancers such as <literal>mod_jk</literal>. Whenever an HTTP session is bound to a particular node, an instruction is sent to the SIP Load Balancer to direct the SIP calls from the same application session to the same node.
           </para>
<para>It is sufficient to configure <literal>mod_jk</literal> to work for HTTP in JBoss in order to enable cooperative load balancing. &SHORT_PLATFORM_NAME; will read the configuration and will use it without any extra configuration. You can read more about configuring <literal>mod_jk</literal> with JBoss in your JBoss Application Server documentation.</para> <para>Alternatively you may disable this behaviour and make the HTTP load balancer follow the decisions made by the SIP load balancer with the httpFollowsSip flag. This is achieved by changing the jvmRoute part of the session ID cookie used internally by <literal>mod_jk</literal>.</para>
-
+
+</section>
+
           <section>
           <title>The httpFollowsSip flag</title>
<para>The <literal>httpFollowsSip</literal> flag in the service configuration makes the application server aware of how different mod_jk and SIP load balancers have assigned
@@ -483,7 +581,7 @@
 </programlisting>
            </section>

-        </section>
+
         <section>
           <title>Integrated HTTP Load Balancer</title>
<para>To use the integrated HTTP Load Balancer, no extra configuration is needed. If a unique <literal>jvmRoute</literal> is specified and enabled in each application server, it will behave exactly as the apache balancer. If <literal>jvmRoute</literal> is not present, it will use the session ID as a hash value and attempt to create a sticky session. The integrated balancer can be used together with the apache balancer at the same time.
@@ -497,9 +595,11 @@
               </imageobject>
             </mediaobject>
           </figure>
-        </section>
-      </section>
+
+
     </section>
+
+
     <section id="sslb-binary-SIP_Load_Balancer-Running">
       <title>Running</title>
<procedure id="sslb-Running_the_SIP_Load_Balancer_and_Servlet_Server_Nodes">
@@ -546,7 +646,10 @@
    id="sslb-binary-SIP_Load_Balancer-Using">
    <title>Using</title>
    <para>&nbsp;</para>
-  </section-->    <section id="sslb-binary-SIP_Load_Balancer-Testing">
+  </section-->
+
+
+<section id="sslb-binary-SIP_Load_Balancer-Testing">
       <title>Testing</title>
<para>To test load balancing, the same application must be deployed manually on each node, and two SIP Softphones must be installed.</para>
       <procedure>
@@ -571,6 +674,8 @@
         </step>
       </procedure>
     </section>
+
+
     <section id="sslb-binary-SIP_Load_Balancer-Stopping">
       <title>Stopping</title>
<para>Assuming that you started the JBoss Application Server as a foreground process in the Linux terminal, the easiest way to stop it is by pressing the <keycombo action="simul">
@@ -581,13 +686,14 @@
<screen>^COct 21, 2008 1:11:57 AM org.mobicents.tools.sip.balancer.SipBalancerShutdownHook run
 INFO: Stopping the sip forwarder</screen>
     </section>
+
     <section id="sslb-binary-SIP_Load_Balancer-Uninstalling">
       <title>Uninstalling</title>
<para>To uninstall the SIP load balancer, delete the JAR file you installed.</para>
     </section>
-  </section>
-  <section>
-    <title>IP Load Balancing</title>
+
+
+
     <section>
       <title>IP Load Balancers</title>
<para>An IP load-balancer is a network appliance that distributes traffic to an application server (or actual servers) using a load-balancing algorithm. IP load-balancing is often used when the other load-balancers&apos; capacity is exceeded and can not scale further without hardware upgrades.</para>
@@ -596,6 +702,8 @@

 </para>
     </section>
+
+
     <section>
       <title>Technical overview</title>
<para>In its simplest form, the IP load-balancer usually &quot;owns&quot; the public-facing IP address (known as a VIP). <!--Issue #822 Editor Comment - VIP = Virtual IP?--> The traffic is routed to actual servers in it&apos;s private network similar to NAT. It is also possible to not change the IP address and just work on the MAC address by assuming that all actual servers are configured to accept packets for the VIP address. The features offered by the IP load balancer depend largely on the vendor. </para>
@@ -608,6 +716,7 @@
<para>Pure IP load balancing is not a recommented option. It is advised to use a distributed load balancer instead. Proper operation with pure IP load balancing depends on the ability of the IP load balancer to establish request affinity based on IP addresses and ports.</para>
       </warning>
     </section>
+
     <section>
       <title></title>
<para>First you need to remove the SIP load balancers from any configuration in &SHORT_PLATFORM_NAME;. In particular the <literal>balancers</literal>
@@ -626,37 +735,19 @@
       <note>
<para>Depending on your reliability requirements you can omit the configuration described in this section and let the servers use their own IP address in the SIP messages.</para>
       </note>
-    </section>
+
   </section>
+
   <!--<note>
   <title/>
<para>Before reading further, you should ensure that you are familiar with the terminology employed across all sections of the selected SIP Server from &PLATFORM_NAME; Platform (SIP Servlets or JAIN SLEE with SIP RA).</para>
- </note>-->  <section id="sslb-SIP_Load_Balancing_Basics">
-    <title>SIP Load Balancing Basics</title>
- <para>All User Agents send SIP messages, such as <literal>INVITE</literal> and <literal>MESSAGE</literal>, to the same SIP URI (the IP address and port number of the SIP Load Balancer on the WAN). The Load Balancer then parses, alters, and forwards those messages to an available node in the cluster. If the message was sent as a part of an existing SIP session, it will be forwarded to the cluster node which processed that User Agent's original transaction request.
-    </para>
- <para>The SIP Server that receives the message acts upon it and sends a response back to the SIP Load Balancer. The SIP Load Balancer reparses, alters and forwards the message back to the original User Agent. This entire proxying and provisioning process is carried out independent of the User Agent, which is only concerned with the SIP service or application it is using.
-    </para>
- <para>By using the Load Balancer, SIP traffic is balanced across a pool of available SIP Servers, increasing the overall throughput of the SIP service or application running on either individual nodes of the cluster. In the case of a &SHORT_PLATFORM_NAME; server with <literal>&lt;/distributed&gt;</literal> capabilities, load balancing advantages are applied across the entire cluster.
-    </para>
- <para>The SIP Load Balancer is also able to failover requests mid-call from unavailable nodes to available ones, thus increasing the reliability of the SIP service or application. The Load Balancer increases throughput and reliability by dynamically provisioning SIP service requests and responses across responsive nodes in a cluster. This enables SIP applications to meet the real-time demand for SIP services.
-    </para>
-  </section>
-  <section>
-    <title>HTTP Load Balancing Basics</title>
- <para>In addition to the SIP load balancing, there are several options for coordinated or cooperative load balancing with other protocols such as HTTP.
-    </para>
- <para>Typically, a JBoss Application Server will use apache HTTP server with mod_jk, mod_proxy, mod_cluster or similar extension installed as an HTTP load balancer. This apache-based load balancer will parse incoming HTTP requests and will look for the session ID of those requests in order to ensure all requests from the same session arrive at the same application server.
-    </para>
- <para>By default, this is done by examining the <literal>jsessionid</literal> HTTP cookie or GET parameter and looking for the <literal>jvmRoute</literal> assigned to the session. The typical <literal>jsessionid</literal> value is of the form <literal>&lt;sessionId&gt;.&lt;jvmRoute&gt;</literal>. The very first request for each new HTTP session does not have a session ID assigned; the apache routes the request to a random application server node.
-    </para>
- <para>When the node responds it assigns a session ID and <literal>jvmRoute</literal> to the response of the request in a HTTP cookie. This response goes back to the client through apache, which keeps track of which node owns each <literal>jvmRoute</literal>. Once the very first request is served this way, the subsequent requests from this session will carry the assigned cookie, and the apache load balancer will always route the requests to the node, which advertised itself as the <literal>jvmRoute</literal> owner.
-    </para>
- <para>Instead of using apache, an integrated HTTP Load Balancer is also available. The SIP Load Balancer has a HTTP port where you can direct all incoming HTTP requests. The integrated HTTP load balancer behaves exactly like apache by default, but this behavior is extensible and can be overridden completely with the pluggable balancer algorithms. The integrated HTTP load balancer is much easier to configure and generally requires no effort, because it reuses most SIP settings and assumes reasonable default values.
-    </para>
- <para>Unlike the native apache, the integrated HTTP Load Balancer is written completely in Java, thus a performance penalty should be expected when using it. However, the integrated HTTP Balancer has an advantage when related SIP and HTTP requests must stick to the same node.
-    </para>
-  </section>
+ </note>-->
+
+
+
+
+
+
   <section>
     <title>Pluggable balancer algorithms</title>
<para>The SIP/HTTP Load Balancer exposes an interface to allow users to customize the routing decision making for special purposes. By default there are three built-in algorithms. Only one algorithm is active at any time and it is specified with the <literal>algorithmClass</literal> property in the configuration file.</para>
@@ -701,6 +792,8 @@
         </varlistentry>
       </variablelist></para>
   </section>
+
+
   <section>
     <title>Distributed load balancing</title>
<para>When the capacity of a single load balancer is exceeded, multiple load balancers can be used. With the help of an IP load balancer the traffic can be distributed between all SIP/HTTP load balancers based on some IP rules or round-robin. With consistent hash and <literal>jvmRoute</literal>-based balancer algorithms it doesn't matter which SIP/HTTP load balancer will process the request, because they would all make the same decisions based on information in the requests (headers, parameters or cookies) and the list of available nodes. With consistent hash algorithms there is no state to be preserved in the SIP/HTTP balancers.</para>
@@ -713,6 +806,8 @@
       </mediaobject>
     </figure>
   </section>
+
+
   <section id="sslb-SIP_Load_Balancer-Implementation">
     <title>Implementation of the &PLATFORM_NAME; Load Balancer</title>
<para>Each individual &PLATFORM_NAME; SIP Server in the cluster is responsible for contacting the SIP load balancer and relaying its health status and regular &quot;heartbeats&quot;. <!--Issue #822 Editor Comment - would it be worthwhile describing heartbeats in more detail here? Can you link to another area in the guide which discusses heartbeats in more detail (to avoid duplicating information)?-->
@@ -724,6 +819,8 @@
<para>The SIP Load Balancer first receives SIP requests from endpoints on a port that is specified in its Configuration Properties configuration file. The SIP Load Balancer, using a round-robin algorithm, then selects a node to which it forwards the SIP requests. The Load Balancer forwards all same-session requests to the first node selected to initiate the session, providing that the node is healthy and available.
     </para>
   </section>
+
+
   <section>
     <title>SIP Message Flow</title>
<para>The SIP Load Balancer appends itself to the <literal>Via</literal> header of each request, so that returned responses are sent to the SIP Balancer before they are sent to the originating endpoint.
@@ -741,6 +838,6 @@
       </mediaobject>
     </figure>
   </section>
-</section>
+

 </section>
=======================================
--- /docs/sources/src/main/resources/en-US/concept-section-SS_for_JBoss-Passivation_Support.xml Tue Aug 7 04:45:24 2012 +++ /docs/sources/src/main/resources/en-US/concept-section-SS_for_JBoss-Passivation_Support.xml Tue Aug 7 12:56:02 2012
@@ -192,11 +192,11 @@
                    </para>

 <screen>
-                                                 &lt;!--
- &lt;property name=&quot;useSessionPassivation&quot;&gt;false &lt;/property&gt; - &lt;property name=&quot;passivationMaxIdleTime&quot;&gt;-1 &lt;/property&gt; - &lt;property name=&quot;passivationMinIdleTime&quot;&gt;-1 &lt;/property&gt;
-                                             --&gt;
+ &lt;!--
+ &lt;property name=&quot;useSessionPassivation&quot;&gt;false &lt;/property&gt; + &lt;property name=&quot;passivationMaxIdleTime&quot;&gt;-1 &lt;/property&gt; + &lt;property name=&quot;passivationMinIdleTime&quot;&gt;-1 &lt;/property&gt;
+ --&gt;

 </screen>

Reply via email to