Cluster properties - FORMCYCLE Wiki

author	version	line-number	content
1	The file //cluster.properties// stores several settings related to clustering.
2
3	You should [[edit these settings via the user interface>>doc:Formcycle.SystemSettings.UserInterface.Cluster.WebHome]]. Please note that some of these properties may be stored encrypted.
4
5	{{table dataTypeAlpha="0-1-2" preSort="0-asc" caption="Settings regarding clustering"}}
6	\|= Property\|= Default value\|= Encrypted\|= Explanation
7	\|cluster.group.name\|XFC-CLUSTER\|no\|An identifier for the cluster network.
8	\|cluster.node.name\|(generated from local inet address, time etc.)\|no\|An identifier for the master server.
9	\|cluster.node.type\|MASTER\|no\|Whether this server is a master server or a backup (failover) server. Allowed values are {{code language="none"}}MASTER{{/code}} and {{code language="none"}}FAILOVER{{/code}}.
10	\|cluster.active\|false\|no\|Activates or deactivates the cluster mode.
11	\|cluster.protocol.file\|(empty string)\|no\|Path to the file on the [[file system with>>http://www.jgroups.org/manual/index.html#_the_protocol_stack\|\|target="_blank"]] a [[JGroups XML configuration>>http://www.jgroups.org/manual/index.html#CreatingAChannel\|\|target="_blank"]].
12	\|cluster.protocol.type\|UDP\|no\|The network protocol, either {{code language="none"}}UDP{{/code}} or {{code language="none"}}TCP{{/code}}.
13	\|cluster.config.extended\|false\|no\|Whether to apply the advanced settings (type of protocol and its configuration, eg. IP addresses and ports).
14	\|cluster.udp.bind.adr\|(local host address)\|no\|Bind address when using UDP.
15	\|cluster.udp.bind.port\|7600\|no\|Bind port when using UDP.
16	\|cluster.udp.external.use\|false\|no\|Whether an external address and port is used for UDP.
17	\|cluster.udp.external.adr\|(same as cluster.udp.bind.adr)\|no\|The external address when using UDP.
18	\|cluster.udp.external.port\|(same as cluster.udp.bind.port)\|no\|The external port when using UDP.
19	\|cluster.udp.mcast.adr\|228.8.8.8\|no\|Multicast address when using UDP.
20	\|cluster.udp.mcast.port\|7600\|no\|Multicast port when using UDP.
21	\|cluster.tcp.bind.adr\|(local host address)\|no\|Bind address when using TCP.
22	\|cluster.tcp.bind.port\|7600\|no\|Bind port when using TCP.
23	\|cluster.tcp.external.use\|false\|no\|Whether an external address and port is used for TCP.
24	\|cluster.tcp.external.adr\|(same as cluster.tcp.bind.adr)\|no\|External address when using TCP.
25	\|cluster.tcp.external.port\|(same as cluster.tcp.bind.port)\|no\|External port when using TCP.
26	\|cluster.tcp.initial.hosts\|(empty list)\|no\|For discovering other cluster servers in the network. Required only when the protocol is set to TCP. A list of all expected cluster servers that are to be a part of the network. Multiple values are specified by using the same key on several lines.
27	\|cluster.discovery.timeout\|0\|no\|The number of milliseconds to wait for the connection to another server of the cluster to be established successfully. When set to {{code language="none"}}0{{/code}}, there is no timeout limit.
28	\|cluster.tcp.merge3.minInterval\|1000\|no\|{{version major="6" minor="2"/}} For TCP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.
29	\|cluster.tcp.merge3.maxInterval\|30000\|no\|{{version major="6" minor="2"/}} For TCP connections: maximum time in milliseconds before sending an info message to other member in the cluster. AA cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than //0//.
30	\|cluster.tcp.fdall.interval\|3000\|no\|{{version major="6" minor="2"/}} For TCP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than //0//.
31	\|cluster.tcp.fdall.timeout\|5000\|no\|{{version major="6" minor="2"/}} For TCP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.
32	\|cluster.tcp.gms.attempts\|6\|no\|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. //0// means //never give up//.
33	\|cluster.tcp.gms.timeout\|10000\|no\|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.
34	\|cluster.udp.merge3.minInterval\|1000\|no\|{{version major="6" minor="2"/}} For UDP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.
35	\|cluster.udp.merge3.maxInterval\|30000\|no\|{{version major="6" minor="2"/}} For UDP connections: maximum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than //0//.
36	\|cluster.udp.fdall.interval\|3000\|no\|{{version major="6" minor="2"/}} For UDP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than //0//.
37	\|cluster.udp.fdall.timeout\|5000\|no\|{{version major="6" minor="2"/}} For UDP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.
38	\|cluster.udp.gms.attempts\|6\|no\|{{version major="6" minor="2"/}} For UDP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. //0// means //never give up//.
39	\|cluster.udp.gms.timeout\|10000\|no\|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.
40	{{/table}}

The file //cluster.properties// stores several settings related to clustering.

You should [[edit these settings via the user interface>>doc:Formcycle.SystemSettings.UserInterface.Cluster.WebHome]]. Please note that some of these properties may be stored encrypted.

4

5

{{table dataTypeAlpha="0-1-2" preSort="0-asc" caption="Settings regarding clustering"}}

6

|= Property|= Default value|= Encrypted|= Explanation

7

|cluster.group.name|XFC-CLUSTER|no|An identifier for the cluster network.

8

|cluster.node.name|(generated from local inet address, time etc.)|no|An identifier for the master server.

9

|cluster.node.type|MASTER|no|Whether this server is a master server or a backup (failover) server. Allowed values are {{code language="none"}}MASTER{{/code}} and {{code language="none"}}FAILOVER{{/code}}.

10

|cluster.active|false|no|Activates or deactivates the cluster mode.

11

|cluster.protocol.file|(empty string)|no|Path to the file on the [[file system with>>http://www.jgroups.org/manual/index.html#_the_protocol_stack||target="_blank"]] a [[JGroups XML configuration>>http://www.jgroups.org/manual/index.html#CreatingAChannel||target="_blank"]].

12

|cluster.protocol.type|UDP|no|The network protocol, either {{code language="none"}}UDP{{/code}} or {{code language="none"}}TCP{{/code}}.

13

|cluster.config.extended|false|no|Whether to apply the advanced settings (type of protocol and its configuration, eg. IP addresses and ports).

14

|cluster.udp.bind.adr|(local host address)|no|Bind address when using UDP.

15

|cluster.udp.bind.port|7600|no|Bind port when using UDP.

16

|cluster.udp.external.use|false|no|Whether an external address and port is used for UDP.

17

|cluster.udp.external.adr|(same as cluster.udp.bind.adr)|no|The external address when using UDP.

18

|cluster.udp.external.port|(same as cluster.udp.bind.port)|no|The external port when using UDP.

19

|cluster.udp.mcast.adr|228.8.8.8|no|Multicast address when using UDP.

20

|cluster.udp.mcast.port|7600|no|Multicast port when using UDP.

21

|cluster.tcp.bind.adr|(local host address)|no|Bind address when using TCP.

22

|cluster.tcp.bind.port|7600|no|Bind port when using TCP.

23

|cluster.tcp.external.use|false|no|Whether an external address and port is used for TCP.

24

|cluster.tcp.external.adr|(same as cluster.tcp.bind.adr)|no|External address when using TCP.

25

|cluster.tcp.external.port|(same as cluster.tcp.bind.port)|no|External port when using TCP.

26

|cluster.tcp.initial.hosts|(empty list)|no|For discovering other cluster servers in the network. Required only when the protocol is set to TCP. A list of all expected cluster servers that are to be a part of the network. Multiple values are specified by using the same key on several lines.

27

|cluster.discovery.timeout|0|no|The number of milliseconds to wait for the connection to another server of the cluster to be established successfully. When set to {{code language="none"}}0{{/code}}, there is no timeout limit.

28

|cluster.tcp.merge3.minInterval|1000|no|{{version major="6" minor="2"/}} For TCP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.

29

|cluster.tcp.merge3.maxInterval|30000|no|{{version major="6" minor="2"/}} For TCP connections: maximum time in milliseconds before sending an info message to other member in the cluster. AA cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than //0//.

30

|cluster.tcp.fdall.interval|3000|no|{{version major="6" minor="2"/}} For TCP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than //0//.

31

|cluster.tcp.fdall.timeout|5000|no|{{version major="6" minor="2"/}} For TCP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.

32

|cluster.tcp.gms.attempts|6|no|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. //0// means //never give up//.

33

|cluster.tcp.gms.timeout|10000|no|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.

34

|cluster.udp.merge3.minInterval|1000|no|{{version major="6" minor="2"/}} For UDP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.

35

|cluster.udp.merge3.maxInterval|30000|no|{{version major="6" minor="2"/}} For UDP connections: maximum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than //0//.

36

|cluster.udp.fdall.interval|3000|no|{{version major="6" minor="2"/}} For UDP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than //0//.

37

|cluster.udp.fdall.timeout|5000|no|{{version major="6" minor="2"/}} For UDP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.

38

|cluster.udp.gms.attempts|6|no|{{version major="6" minor="2"/}} For UDP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. //0// means //never give up//.

39

|cluster.udp.gms.timeout|10000|no|{{version major="6" minor="2"/}} For TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.

40

Wiki source code of Cluster properties

Navigation