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