<Listener className="org.jboss.web.tomcat.service.deployers.MicrocontainerIntegrationLifecycleListener" delegateBeanName="ModClusterListener"/>
Installation Instructions for mod_cluster 1.1.2 with JBoss EAP 5.1.x
Installation Instructions for mod_cluster 1.1.2 with JBoss AS6
Operation |
Description |
reset |
Move the node out of an error state. |
refresh |
Refresh node configuration. |
enable |
Enable all webapps for all virtual hosts of the managed server. |
disable |
Disable all webapps for all virtual hosts of the managed server. |
stop |
Gracefully stops all webapps for all virtual hosts of the managed server. |
addProxy |
Add a proxy. |
removeProxy |
Remove a proxy. |
pingHTTPD |
Ping httpd and determine whether each proxy is accessible and healthy. Returns the PING_RSP grouped by proxy address. |
pingNodeByJVMRoute |
Ping a node from httpd and returns the PING_RSP grouped by proxy address. Dtermines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
pingNodeByAddress |
Ping a node from httpd and returns the PING_RSP grouped by proxy address. Determines whether the node configured with the specified jvm route is accessible from each proxy returning the PING_RSP grouped by proxy address. |
Metric Name |
Description |
proxyConfiguration |
Get the mod_cluster configuration, per proxy |
proxyInfo |
Get information about what is registered with each mod_cluster, per proxy |
All the operations from the regular Service are available, plus the following:
Operation |
Description |
enableDomain |
Enable all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
disableDomain |
Disables all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
stopDomain |
Gracefully stops all contexts on each node within the current domain. If the current domain is null, then all nodes are stopped. |
All the metrics from the regular Service are available, plus the following:
Metric Name |
Description |
masterNode |
Get the master node status of the current node. |
Property Name |
Description |
advertise |
Enable autodiscovery of httpd servers. |
advertiseGroupAddress |
Multicast address on which to listen for advertisements. |
advertisePort |
Multicast port for discovery |
advertiseInterface |
Multicast interface for discovery |
advertiseSecurityKey |
Security key for discovery. |
proxyList |
Comma separated list of address:port listing the httpd servers where mod_cluster is running. |
proxyURL |
URL prefix to send with commands to mod_cluster. Default is no prefix. |
socketTimeout |
Connection timeout for communication with the proxy. |
ssl |
Whether to use SSL to communicate with mod_cluster. Note this has nothing to do with handling of https requests by JBoss Web. |
excludedContexts |
Comma delimited list of contexts that should not be auto-registered with httpd. Contexts may be qualified by host using a colon, e.g. host1:context1. If no host is defined, localhost is assumed. |
autoEnableContexts |
Toggle for context auto-enable during mod_cluster startup. |
loadBalancingGroup |
Load balancing group. |
flushPackets |
Allows controlling flusing of packets. |
flushWait |
Time in ms to wait before flushing packets. |
ping |
Time in s to wait for a pong answer to a ping. |
smax |
Maximum time on seconds for idle connections above smax. |
ttl |
TTL |
nodeTimeout |
Node timeout |
balancer |
Name of the balancer |
stickySession |
Enables sticky session for the node. |
stickySessionRemove |
Remove session when the request cannot be routed to the right node for this cluster. |
stickySessionForce |
Return an error when the request cannot be routed to the right node. |
workerTimeout |
Timeout to wait for an available worker (default is no wait). |
maxAttempts |
Maximum number of attempts to send the request to the backend server. |
All the properties from the regular Service are available, plus the following:
Property Name |
Description |
masterPerLoadBalancingGroup |
Enable current node to be master in the load balancing group. |
Property Name |
Description |
decayFactor |
The number of historical load values used to determine load factor. |
history |
The exponential decay factor for historical load values. |
Metric Name |
Description |
Load |
The current load of this metric as a percent of the metric's capacity. |
Property Name |
Description |
weight |
The significance of this load metric compared to the other metrics. |
capacity |
Used to normalize the value returned by load expressed as a percentage of the capacity, such that: 0 < (load/capacity) < 1 |
Property Name |
Description |
loadBalanceFactor |
The load balance factor. |
Operation |
Description |
enableContext |
Enable a single webapp |
disableContext |
Disable a single webapp |
stopContext |
Gracefully stops a single webapp |
SSL properties cannot be configured through RHQ. Please use mod_cluster-jboss-beans.xml.
When switching from HA Service to Service (and vice-versa), the RHQ agent will require a restart to pickup the changes in mod_cluster configuration.
Download mod_cluster 1.1.2 (java bundles)
Unzip mod_cluster archive
Copy mod_cluster.sar folder from the downloaded bundle into $JBoss_EAP51_HOME/server/all/deploy
Add the following tag as a child of <Server> tag in
$JBoss_EAP51_HOME/server/all/deploy/jbossweb.sar/server.xml
<Listener className="org.jboss.web.tomcat.service.deployers.MicrocontainerIntegrationLifecycleListener" delegateBeanName="ModClusterListener"/>
Remove the following line from <bean name="ModClusterListener"> tag in
$JBoss_EAP51_HOME/server/all/deploy/mod_cluster.sar/META-INF/mod_cluster-jboss-beans.xml
<depends>WebServer</depends>
Start the the server
$JBoss_EAP51_HOME/bin/run.sh -c all
Remove existing mod_cluster.sar from $JBoss_AS6_HOME/server/all/deploy
Download mod_cluster 1.1.2 (java bundles)
Unzip mod_cluster archive
Copy mod_cluster.sar folder from the downloaded bundle into $JBoss_AS6_HOME/server/all/deploy
Start the the server
$JBoss_AS6_HOME/bin/run.sh -c all