Author: kfujino
Date: Mon Apr 15 08:03:17 2013
New Revision: 1467891
URL: http://svn.apache.org/r1467891
Log:
Add document for Cluster Deployer.
Modified:
tomcat/trunk/webapps/docs/config/cluster-deployer.xml
Modified: tomcat/trunk/webapps/docs/config/cluster-deployer.xml
URL:
http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/cluster-deployer.xml?rev=1467891&r1=1467890&r2=1467891&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/cluster-deployer.xml (original)
+++ tomcat/trunk/webapps/docs/config/cluster-deployer.xml Mon Apr 15 08:03:17
2013
@@ -34,29 +34,54 @@
</section>
<section name="Introduction">
- <p>TODO - Complete documentation</p>
-
-
+ <p>The Farm War Deployer can deploy and undeploy web applications on the
other
+ nodes in the cluster.</p>
+ <p><strong>Note: </strong>FarmWarDeployer can be configured at host level
+ cluster only.
+ </p>
</section>
-<section name="Attributes">
-
- <subsection name="Common Attributes">
-
- <attributes>
+<section name="org.apache.catalina.ha.deploy.FarmWarDeployer">
- <attribute name="className" required="true">
-
- </attribute>
-
-
- </attributes>
+ <subsection name="Attributes">
+ <attributes>
+ <attribute name="className" required="true">
+ The cluster deployer class, currently only one is available,
+ <code>org.apache.catalina.ha.deploy.FarmWarDeployer.</code>
+ </attribute>
+ <attribute name="deployDir" required="true">
+ Deployment directory. This is the pathname of a directory where deploy
+ the web applications. In the current implementation, this attribute
must
+ be the same value as the <strong>Host's appBase</strong>.
+ </attribute>
+ <attribute name="tempDir" required="true">
+ The temporaryDirectory to store binary data when downloading a war from
+ the cluster.
+ </attribute>
+ <attribute name="watchDir" required="false">
+ This is the pathname of a directory where watch for
changes(add/modify/remove)
+ of web applications. <strong>Note: </strong> if
<strong>watchEnabled</strong>
+ is false, this attribute will have no effect.
+ </attribute>
+ <attribute name="watchEnabled" required="false">
+ Set to true if you want to watch for changes of web applications.
+ Only when this attribute set to true, you can trigger a deploy/undeploy
+ of web applications. The flag's value defaults to false.
+ </attribute>
+ <attribute name="processDeployFrequency" required="false">
+ Frequency of the Farm watchDir check. Cluster wide deployment will be
+ done once for the specified amount of backgrondProcess calls (ie, the
+ lower the amount, the most often the checks will occur). The minimum
+ value is 1, and the default value is 2.
+ <strong>Note: </strong> if <strong>watchEnabled</strong> is false, this
+ attribute will have no effect.
+ </attribute>
+ </attributes>
</subsection>
-
</section>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
