Wiki source code of Clustering
Version 2.1 by Thomas Mortagne on 2009/09/01
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | = Clustering = | ||
| 2 | |||
| 3 | XWiki provide easy way to setup clustered instances of XWiki based on network events distribution. | ||
| 4 | |||
| 5 | == Features == | ||
| 6 | |||
| 7 | * events synchronization between XWiki instances | ||
| 8 | * multiple clustering channels | ||
| 9 | * possibility to start stop clustering channel at runtime | ||
| 10 | |||
| 11 | == Setup == | ||
| 12 | |||
| 13 | === Enable event distribution === | ||
| 14 | |||
| 15 | To enable event distribution in a XWiki instance go to ##xwiki.properties## file and set the property ##observation.remote.enabled## to ##true##. | ||
| 16 | |||
| 17 | === Setup communication channels === | ||
| 18 | |||
| 19 | Then you need to create a JGroups configuration file for each different cluster group you want to setup. | ||
| 20 | |||
| 21 | For this go to ##/WEB-INF/observation/remote/jgroups## folder and add one xml file by clustering group. Generally there is only one for a simple cluster. | ||
| 22 | |||
| 23 | You can look at http://www.jboss.org/community/wiki/JGroups for a good documentation on how to setup JGroups configuration files. | ||
| 24 | |||
| 25 | === Start communication channels === | ||
| 26 | |||
| 27 | The name of the xml file matches the identifier of the channel. | ||
| 28 | |||
| 29 | To indicate which channels to start when XWiki starts list the in the property ##observation.remote.channels## of the file ##xwiki.properties##. | ||
| 30 | |||
| 31 | === Choose network adaptor implementation to use === | ||
| 32 | |||
| 33 | By default only jgroups implementation is provided but it's possible to add more. See [[code:Modules.RemoteObservationModule#HAddcustomnetworkadaptor]] for more details. | ||
| 34 | |||
| 35 | == More == | ||
| 36 | |||
| 37 | See [[code:Modules.RemoteObservationModule]] for more details of event distribution features and extension capabilities. | ||
| 38 | |||
| 39 | Follow [[Clustering_localhosttcptuto]] for a complete tutorial of how to setup a simple cluster between two instances of XWiki on the same server. |
