Wiki source code of Clustering
Version 6.3 by Vincent Massol on 2017/09/06
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | XWiki provides an easy way to setup clustered instances of XWiki based on network events distribution. | ||
| 2 | |||
| 3 | = Features = | ||
| 4 | |||
| 5 | * events synchronization between XWiki instances | ||
| 6 | * multiple clustering channels | ||
| 7 | * possibility to start/stop the clustering channel at runtime | ||
| 8 | |||
| 9 | = Setup = | ||
| 10 | |||
| 11 | == Enable event distribution == | ||
| 12 | |||
| 13 | To enable event distribution in an XWiki instance go to ##xwiki.properties## file and set the property ##observation.remote.enabled## to ##true##. | ||
| 14 | |||
| 15 | == Setup communication channels == | ||
| 16 | |||
| 17 | Then you need to create a JGroups configuration file for each different cluster group you want to setup. | ||
| 18 | |||
| 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. | ||
| 20 | |||
| 21 | See [[JGroups documentation>>http://www.jgroups.org/ug.html]] for more details on how to setup JGroups configuration files. | ||
| 22 | |||
| 23 | If you have IPv6 on your server, you are also advised to read [[this IPv6 article>>https://community.jboss.org/wiki/IPv6]]. Defining ##-Djava.net.preferIPv4Stack=true## when launching the JVM is probably your best bet in most cases. If your really want to use IPv6 for your channels, you should probably upgrade JGroup to version 2.10.0.GA and use a JVM 6 at least. | ||
| 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 them in the property ##observation.remote.channels## of the ##xwiki.properties## file. | ||
| 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 the [[Remote Observation Module>>extensions:Extension.Observation Module Remote#HAddcustomnetworkadaptor]] for more details. | ||
| 34 | |||
| 35 | = More = | ||
| 36 | |||
| 37 | See the [[Remote Observation Module>>extensions:Extension.Observation Module Remote]] for more details of the event distribution features and extension capabilities. | ||
| 38 | |||
| 39 | Follow the [[test clustering tutorial>>platform:AdminGuide.DistributedEventClusterSetup]] for a complete tutorial on how to setup a simple cluster between two instances of XWiki on the same server. |
