Cluster Reference
This document describes the elements and properties you can configure in the Kaazing WebSocket Gateway to achieve high availability.
Overview
You can use the optional cluster
element to configure a Gateway to participate in a Kaazing WebSocket Gateway cluster. Once a cluster service is configured on each Gateway cluster member and the members are started, the clustered instances will handle connection-switching when another cluster member unexpectedly terminates. Cluster members share information about activity and which of their services are load balanced. See Overview of Gateway Clustering for more information about high availability and clustering.
Structure
The Gateway configuration file (gateway-config.xml
or gateway-config.xml
) defines the following configuration elements contained in the top-level gateway-config
element:
cluster
Required? Optional; Occurs: zero or one
This is the element for cluster configuration. Kaazing WebSocket Gateway can be clustered to achieve high availability. You can configure a cluster by specifying the local IP address of the Gateway in the accept
element, and the unicast addresses or multicast group address in the connect
element. If the cluster
element is missing, the server cannot participate as a cluster member.
cluster
contains the following elements:
Example
The following example shows a cluster
service that accepts on tcp://192.168.2.10:5942 (its local IP and arbitrary port number) and connects to the cluster using udp://224.2.2.44:54327.
<cluster> <name>MyCluster</name> <accept>tcp://192.168.2.10:5942</accept> <connect>udp://224.2.2.44:54327</connect> </cluster>
Notes
- To configure clustering in an Enterprise Shield™ topology, see How Does Enterprise Shield™ Work in a Cluster?.
Summary
In this document, you learned about the Gateway cluster
configuration element and how to specify it in your Gateway configuration file. For more information about the location of the configuration files and starting the Gateway, see Setting Up Kaazing WebSocket Gateway. For more information about Kaazing WebSocket Gateway administration, see the documentation.