... |
... |
@@ -2,6
+2,10 @@ |
2 |
2 |
|
3 |
3 |
== Introduction == |
4 |
4 |
|
|
5 |
+{{figure image="cluster_base_en.png"}} |
|
6 |
+UI for configuring clusters |
|
7 |
+{{/figure}} |
|
8 |
+ |
5 |
5 |
{{formcycle/}} provides the option to setup a cluster network offering a hot standby failover mechanism by connection multiple {{mserver number="plural"/}} instances over a network, so that they can monitor each other and replace another server in case failure occurs. Currently, the {{mserver number="plural"/}} can be set two different modes: //Master// and //Failover//. |
6 |
6 |
|
7 |
7 |
=== Master === |
... |
... |
@@ -12,21
+12,23 @@ |
12 |
12 |
|
13 |
13 |
A server in failover mode deactivates certain services and functions such as {{fserver/}} connections and time-based state transitions. Normally, these servers will be in the state //idle//. You can still view forms and access the [[administration interface>>doc:Server]]. |
14 |
14 |
|
15 |
|
-=== Failover process=== |
|
19 |
+=== Failover process === |
16 |
16 |
|
17 |
|
-When the network detects a failure of a server of type //master// (eg. caused by a server or network failure), the available //failover// server negotiate and designate one server as its replacement. Commonly this will be an idle //failover// server that has been part of the cluster for the longest time. |
|
21 |
+When the network detects a failure of a server of type //master// (eg. caused by a server or network failure), the available //failover// server negotiate and designate one server as its replacement. Commonly this will be an idle //failover// server that has been part of the cluster for the longest time. |
18 |
18 |
|
19 |
|
-Now the designated server activates all deactivates services and attempts to establish a connection to all known {{fserver number="plural"/}} with the option //connect automatically// set. The state of this server changes to //active (failover)// and functions as a replacement for the {{mserver/}} without any restrictions. |
|
23 |
+Now the designated server activates all deactivated services and attempts to establish a connection to all known {{fserver number="plural"/}} with the option //connect automatically// set. The state of this server changes to //active (failover)// and functions as a replacement for the {{mserver/}} without any restrictions. |
20 |
20 |
|
21 |
21 |
Should the {{mserver/}} join the cluster again, it will replace the failover server, unless its cluster ID has changed. In this case, the failover server will deactivate all non-required services again and return back to the //idle// state. The {{mserver number="plural"/}}'s state changes back to the //active// state. |
22 |
22 |
|
23 |
|
-=== Firewalls |
|
27 |
+=== Firewalls === |
24 |
24 |
|
25 |
25 |
In order to setup a cluster, the servers will need to be able to communicate with each other over the network. When setting up the configuration properly, this is possible even with an activated firewall. Depending on the protocol, it may be neccessary to open certain ports, especially when using UDP. |
26 |
26 |
|
27 |
27 |
== Setup == |
28 |
28 |
|
29 |
|
-{{figure image="FCSnapshot14.png" width="300"}}User interface for modifying basic settings{{/figure}} |
|
33 |
+{{figure image="cluster_base_en.png"}} |
|
34 |
+User interface for modifying basic settings |
|
35 |
+{{/figure}} |
30 |
30 |
|
31 |
31 |
=== Activated === |
32 |
32 |
|
... |
... |
@@ -36,19
+36,19 @@ |
36 |
36 |
|
37 |
37 |
Sets the node type of this server, ie. either //master// or //failover//. {{mserver number="plural"/}} are active and provide all formcycle services, while failover servers are replacement servers taking over when a {{mserver/}} fails and will deactivate certain services while idle. |
38 |
38 |
|
39 |
|
-=== Group name |
|
45 |
+=== Group name === |
40 |
40 |
|
41 |
41 |
An identifier for the cluster network. All servers that should form a network must be given the same group name. |
42 |
42 |
|
43 |
43 |
Example: //XFC-Cluster// |
44 |
44 |
|
45 |
|
-=== Node id |
|
51 |
+=== Node id === |
46 |
46 |
|
47 |
47 |
An identifier for the {{mserver/}}. This id must be unique within a group. |
48 |
48 |
|
49 |
49 |
Example: //XFC-Master// |
50 |
50 |
|
51 |
|
-=== Advanced settings |
|
57 |
+=== Advanced settings === |
52 |
52 |
|
53 |
53 |
When advances settings are activated, more settings will be shown. Usually this is not required and you can leave these settings at their defaults, but it may be neccessary for certain special network configurations or non-standard port settings. |
54 |
54 |
|
... |
... |
@@ -58,9
+58,11 @@ |
58 |
58 |
|
59 |
59 |
The current server you are using to display the overview will be marked in bold. |
60 |
60 |
|
61 |
|
-== Advanced settings |
|
67 |
+== Advanced settings == |
62 |
62 |
|
63 |
|
-{{figure image="FCSnapshot15.png" width="300"}}User interface for modifying the advanced settings. This is neccessary only for special network configurations.{{/figure}} |
|
69 |
+{{figure image="cluster_advanced_en.png"}} |
|
70 |
+User interface for modifying the advanced settings. This is neccessary only for special network configurations. |
|
71 |
+{{/figure}} |
64 |
64 |
|
65 |
65 |
=== Network protocol === |
66 |
66 |
|
... |
... |
@@ -70,7
+70,7 @@ |
70 |
70 |
Default option: UDP |
71 |
71 |
{{/info}} |
72 |
72 |
|
73 |
|
-=== Local address (network adapter) |
|
81 |
+=== Local address (network adapter) === |
74 |
74 |
|
75 |
75 |
Here you can set the IP address or hostname and the port of the local server to be used, ie. the bind address. Note that the provided address must match a local network adapter. If it does not match, an error message will be displayed when trying to save the options and attempting to establish a test connection to the cluster network. |
76 |
76 |
|
... |
... |
@@ -87,11
+87,11 @@ |
87 |
87 |
* Address: fc-master.example.com, Port: 7600 |
88 |
88 |
{{/panel}} |
89 |
89 |
|
90 |
|
-=== Using a different external address |
|
98 |
+=== Using a different external address === |
91 |
91 |
|
92 |
92 |
When you activate this switch, you can provide an alternative external IP address or hostname pointing to the same local network adapter. This may become neccessary for more complicated network topologies such as when the server is not visible directly due to a firewall. In this case, you need to provide an external address or a connection to the server cannot be established from the cluster network. Furthermore, it may be neccessary to setup the firewall properly and activate port forwarding to the server. |
93 |
93 |
|
94 |
|
-==== External address |
|
102 |
+==== External address ==== |
95 |
95 |
|
96 |
96 |
The external IP address or hostname and port for the server. The default is {{code}}0{{/code}}, in which case no external address and only the locale address will be used. |
97 |
97 |
|