Extension Deployer module

The AdminTool's Extension Deployer module allows administrators to distribute server-side Zone and Room Extensions to all Game Nodes in the cluster.

This module is available when connected to a Lobby Node only.

NOTE: as reminded in the module's interface itself, this module deploys the Extensions on the Game Nodes only, not on the Lobby itself. If you need to deploy an Extension on the Lobby, you have to use the Extension Manager module.

Usage

The module lists all the running Game Nodes with their health indicator, grouped by active or inactive status.
If an high latency in Lobby ↔ Game Node communication is measured for some time, the node is considered to be unhealthy and the green light turns to red. In case of prolonged unhealthy state, the Game Node becomes inactive.

In order to deploy an Extension to the Game Nodes, first create a zip file with the Extension's top folder at its root. The folder must contain the Extension's jar file and other required files, just like when deploying it to a standalone SmartFoxServer instance.

It is also possible to deploy multiple Extensions at once: just add their folders at the root of the same zip file.

Select one or more nodes using the checkboxes in the first column of the list to enable the deployment panel on the right. Usually all Game Nodes should be selected, to avoid having different versions of the Extension running on different nodes (also read the box below!). Click on the Select zip file button and... select the zip file created previously.

Click on the Deploy button to transfer the zip file to all nodes and extract it under SmartFoxServer's extensions/ folder.

The deployment can be destructive or non-destructive, according to the switch position on the panel (default: non-destructive). In destructive deployment, all folders under the extensions/ folder on the Game Node which are also contained in the uploaded zip file are deleted before uncompressing the new version; in non-destructive deployment, files from the uploaded zip are simply added to the respective folders (overwriting existing files with the same name).

On Extension deployment completed, a modal panel shows a success message. In case the transfer to one or more nodes failed, a warning lists the involved Game Nodes and the cause of the issue.

IMPORTANT: Extensions are deployed to the currently running nodes, but meanwhile new Game Nodes could also be started by the Orchestration logic. Since new nodes are based on an existing snapshot, this must be updated with the new Extension too! It is highly recommended to update the snapshot first, and then use this module to deploy the new Extension to the nodes already running.

« Back to Administration table of contents