Author: objectiser Date: 2011-03-22 14:19:40 -0400 (Tue, 22 Mar 2011) New Revision: 1323 Modified: trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml Log: Updates to the documentation. Modified: trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml 2011-03-21 05:29:45 UTC (rev 1322) +++ trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml 2011-03-22 18:19:40 UTC (rev 1323) @@ -7,9 +7,15 @@ <section> <title> Overview </title> <para> - In order to make riftsaw to be able to work in a clustering environment, it has to be configured to a shared database for - all the nodes that among the clustering environment, because riftsaw persists all of process states into database. For the frontend, - it needs a load balancer to dispatch the soap message into nodes properly.Below is the picture of riftsaw server deployment architecture for clustering. + To enable riftsaw to work in a clustered environment, all of the nodes within the cluster must be + configured to use a shared database. This is to ensure all of the nodes have access to the + shared information concerning the persistent state of process instances. + </para> + + <para> + For the cluster to work correctly, it will also be necessary to employ a load balancer to distribute + the incoming SOAP requests appropriately across all of the nodes in the server, as shown in the + following diagram. </para> <imageobject> @@ -21,18 +27,27 @@ <title>Installation</title> <para> - In the $riftsaw/install folder, if you set the <emphasis >org_jboss_as_config=all</emphasis> in the <filename>deployment.properties</filename>, - it will deployed riftsaw-clustering libraries and files into JBoss AS. If you want to deploy the riftsaw clustering feature into other config, say like you copied 'all' into 'node1', - you can run the following command, (which basically added '-Dclustering.support=true'). + There are two ways to install a clustered version of riftsaw. The first approach is to simply + set the <emphasis>org_jboss_as_config</emphasis> property in the + <filename>${RiftSaw}/install/deployment.properties</filename> file to <emphasis>all</emphasis> + before deploying riftsaw into the JBossAS server. </para> + <para> - <command>ant deploy -Dclustering.support=true</command> + However, if a different JBossAS config profile needs to be used, then it will be necessary to + explicitly indicating that clustering is required. This is achieved by setting the system + property <emphasis>clustering.support</emphasis> to <emphasis>true</emphasis>, e.g. </para> <para> + <command>ant deploy -Dclustering.support=true ....)</command> + </para> + + <para> <note> - Please be noted that the riftsaw clustering support depends on the JBoss AS Clustering's <emphasis>HAPartitionService</emphasis>, so please be sure that you have this service started if you - use some customized config for JBoss AS. + The riftsaw clustering support depends on the JBossAS Clustering + <emphasis>HAPartitionService</emphasis> service, so please be sure that you have this service + started if you use some customized config profile for JBossAS. </note> </para> </section> @@ -41,18 +56,21 @@ <title>Deployment</title> <para> - Deploying bpel artifact in clustering environment is different from deploying it into a single server. - You have to copy your bpel artifact (say hello_world.jar) into <filename>$JBossAS/server/$config (like all)/farm/</filename>, - any artifacts deployed in this folder will be copied into all nodes that in the clustering environment. + Deploying a BPEL process into a clustered environment is different from deploying it into a single server. + You have to copy your BPEL artifact (say hello_world.jar) into a <emphasis>farm</emphasis> folder. This is + a special folder that the server uses to share deployable components across the nodes within the cluster. + For example, the default <emphasis>farm</emphasis> folder in JBossAS is located here: + <filename>${JBossAS}/server/all/farm</filename>. </para> </section> <section> - <title>Bpel Process Service Invocation</title> + <title>BPEL Process Service Invocation</title> <para> - For the bpel service that you deployed in the clustering environment, if you want to invoke that service, you should be specifying the <emphasis>load balancer's url</emphasis> - instead of the soap address that you specified in the wsdl file. + When invoking the BPEL service deployed in the clustering environment, you should specify the + <emphasis>load balancer's url</emphasis> instead of the SOAP address specified in the wsdl file. + The load balancer will then take care of deciding which server in the cluster to invoke. </para> </section>