Bug 1074550 - [Doc Change] Document the hot-standby functionality of the mod_cluster subsystem
Summary: [Doc Change] Document the hot-standby functionality of the mod_cluster subsystem
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: JBoss Enterprise Application Platform 6
Classification: JBoss
Component: Documentation
Version: 6.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
urgent
Target Milestone: ER6
: EAP 6.3.0
Assignee: David Michael
QA Contact: Michal Karm Babacek
David Michael
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-03-10 14:26 UTC by Michal Karm Babacek
Modified: 2014-08-14 15:20 UTC (History)
5 users (show)

Fixed In Version:
Doc Type: Enhancement
Doc Text:
Clone Of:
Environment:
Build Name: 22508, Administration and Configuration Guide-6.3-1 Build Date: 06-03-2014 07:50:55 Topic ID: 14165-592103 [Latest]
Last Closed: 2014-06-28 15:31:15 UTC
Type: Enhancement
Embargoed:


Attachments (Terms of Use)

Description Michal Karm Babacek 2014-03-10 14:26:55 UTC
Dear doc guys,

this feature [1][2] deserves an article in the mod_cluster documentation, somewhere near that "ProxyPassMatch/ProxyPass" note in the current version.

[1] https://issues.jboss.org/browse/EAP6-172
[2] https://bugzilla.redhat.com/show_bug.cgi?id=987259

Yesterday, on the 9th of March, we received information from the customer that shall enable development to engineer a configuration that will go into the documentation.

On the actual contents of the documentation, please, consult Jean-Frederic Clere <jclere>.

Questions regarding planning, time and the status of ACKS/NACKS on the [1][2] will be answered by John Doyle <jdoyle>.

THX

Comment 2 Jean-frederic Clere 2014-06-03 06:53:51 UTC
A hotstandby node in the mod_cluster logic is a kind of last ressort node: when all other nodes of the cluster are down/in error the requests and the sessions will be routed to that node.
To configure a hotstandby node just configure the node with factor=0 like:
+++
        <subsystem xmlns="urn:jboss:domain:modcluster:1.2">
            <mod-cluster-config advertise-socket="modcluster" connector="ajp">
                <simple-load-provider factor="0"/>
            </mod-cluster-config>
        </subsystem>
+++
In mod_cluster-manager the node will be displayed with status OK and load=-1

Scenario with 3 node:
A factor=10
B factor=10
C facctor=0

Normal behaviour load will be balanced between A and B, if one of the 2 get in error or stopped all requests will go to the other one, if both are in error or stop all request will go to C.

Comment 5 Michal Karm Babacek 2014-06-18 15:23:12 UTC
I find several things being wrong in the documentation.

- naming conventions
- it's Load: 0 not Load: -1, see [2]
- swapping terms "Load" and "factor"
- somewhat misleading wording

Please, see the new version of the documentation text:

== BEGIN ==

A hot-standby node in the mod_cluster logic is the last resort node to which all requests are routed if all other nodes are down.
This is similar to the hot-standby logic in mod_proxy.
To configure a hot-standby node, replace the dynamic-load-provider in mod_cluster subsystem with a simple-load-provider with factor set to 0, e.g.:

<subsystem xmlns="urn:jboss:domain:modcluster:1.2">
    <mod-cluster-config advertise-socket="modcluster" connector="ajp">
-        <dynamic-load-provider>
-            <load-metric type="busyness"/>
-        </dynamic-load-provider>
+        <simple-load-provider factor="0"/>
    </mod-cluster-config>
</subsystem>

In mod_cluster-manager console [See Development_Guide, 9.5. Apache mod_cluster-manager Application][1], the node is displayed with OK status and Load: 0.
For instance, if there are three nodes:

    Node A, Load: 10
    Node B, Load: 10
    Node C, Load: 0

The load will be ballanced between nodes A and B, unless they are both unavailable. In such case, node C will take the load.

== END ==

[1] http://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.3/html-single/Development_Guide/index.html#sect-Apache_mod_cluster-manager_Application

[2] https://github.com/modcluster/mod_cluster/pull/95

Comment 8 Michal Karm Babacek 2014-06-20 11:54:12 UTC
I'm sorry, this is wrong:

the XML configuration snippet is wrong (both providers are there at the same time), please, read my comment 5 , it says "replace", not "add". These + and - prefixes are well known diff syntax, but you might want to use your own specific formatting or convention. The only point is to show both states: before and after the change.

Furthermore, why isn't the text "refer Apache mod_cluster-manager Application section in the JBoss Enterprise Application Platform Development Guide" an actual link?

These are small bugs, so we are almost there :-)

Thanks

Comment 10 David Michael 2014-06-26 07:08:32 UTC
Topic modified/updated: 18.3.4. mod_cluster Configuration on httpd

Summary of changes/updates:
- Included information as per comment 5 after the Table 18.2. mod_cluster Derivatives

Link to topic: http://documentation-devel.engineering.redhat.com/site/documentation/en-US/JBoss_Enterprise_Application_Platform/6.3/html-single/Administration_and_Configuration_Guide/index.html#mod_cluster_Configuration_on_httpd

Build ID: JBoss_Enterprise_Application_Platform-Administration_and_Configuration_Guide-6.3-web-en-US-6.3.0-28.el6eng

Comment 11 Michal Karm Babacek 2014-06-26 08:36:08 UTC
It's O.K. now. THX.


Note You need to log in before you can comment on or make changes to this bug.