Cluster Configurator module
The AdminTool's Cluster Configurator module gives access to the global cluster settings. When the Lobby is started, this configuration is loaded and the cluster set up accordingly.
This module is available when connected to a Lobby Node only.
Usage
When the module is accessed, the current configuration is automatically requested to the Lobby. It is also possible to reload it later by pressing the Reload button located at the bottom of the module. In order to submit your changes, press the Submit button.
If selected, the Backup checkbox located near the Submit button allows creating a backup copy of the existing settings before saving the new ones. This is highly recommended.
The backup files are located in the [sfs2x-install-folder]/SFS2X/config/_backups folder and are named using the following convention:
- YYYY-MM-DD-HH-mm-SS__cluster.xml
YYYY = year | MM = month | DD = day
HH = hour (0-23) | mm = minutes | SS = seconds
Currently, only the Overcast team can restore a configuration backup.
Configuration settings
The cluster configuration settings are divided into a number of tabs. Most of the settings are self-explanatory, anyway they are all accompanied by a little Help icon: keeping the mouse pointer over it for a moment shows up a tooltip with basic information. Reading such notes is highly recommended.
Orchestration tab
This tab contains all the settings related to Game Nodes orchestration. The Conductor component monitors the load of Game Nodes and dynamically triggers the addition or removal of new servers based on the current state of the cluster and the settings below.
Please refer to Advanced Clustering → Orchestration for an in-depth description of each setting.
Load Balancer tab
This tab contains all the settings related to the cluster's Load Balancing mechanism, which distributes clients on the active Game Nodes based on the settings below.
Please refer to Advanced Clustering → Load Balancing for an in-depth description of each setting.
