Clusters Grid

The Clusters grid presents definitions of persistence clusters and persistence servers, along with selected details. In edit mode, you can add and delete persistence cluster and server definitions, and modify existing definitions.

For background information, see Persistence Servers and Cluster.

For consequences of modifying this configuration, see Store and Durable Modifications, and Quorum Behaviors.

Levels

Cluster
Server Set
Server

Cluster Level

Column	Description
Cluster	Required. Name of the persistence cluster. Cluster names must be unique within the realm. All names are limited to maximum length of 256 characters.
Last Modified	This timestamp indicates the date and time of the most recent change to this persistence cluster definition.
DR Enabled	Disaster Recovery Replication In the GUI, select this check box to enable replication to the disaster recovery server set. In the web API, set this attribute to `true` to enable replication to the disaster recovery set.
DR Protocol	If you enable disaster recovery replication, the servers in the cluster use this transport protocol to establish a communication bus for that purpose. You can set other parameters of the transport for each server in the cluster.
Primary Set	In the GUI, select one server set to be primary. In the web API, set this attribute to the name of the primary server set. The opposite server set is the standby set.

Server Set Level

Each persistence cluster can contain either one or two sets of servers. If the cluster enables disaster recovery replication, then configure two server sets. If the cluster does not enable disaster recovery replication, then only one server set is relevant. (See the DR Enabled column.) For background information, see Disaster Recovery.

Column	Description
Set Name	Name of the server set. You may use the default set names or supply other names. Set names must be unique within the cluster. All names are limited to maximum length of 256 characters.
Cluster Set Protocol	Persistence servers with a cluster's server set communicate with one another using this transport. Select the transport protocol from the drop-down menu in this column. As needed, set the host, subnet, and port parameters in server-level columns. Set other parameters in the server details panel. Notice that all the servers in a server set use the same cluster protocol, though individual servers can supply different transport parameters. For connection-oriented protocols, such as static TCP and RDMA, the realm server automatically arranges the listening ends and connecting ends.
Client Protocol	Client applications communicate with persistence servers in the cluster using the client transport. Select the client transport protocol from the drop-down menu in this column. As needed, set the host, subnet, and port parameters in server-level columns. Set other parameters in the server details panel. Notice that all the servers in a cluster use the same client protocol, though individual servers can supply different transport parameters. For connection-oriented protocols, such as static TCP and RDMA, the persistence server always is the listening end, and clients the connecting end.

Column

Description

Set Name

Name of the server set.

You may use the default set names or supply other names.

Set names must be unique within the cluster.

All names are limited to maximum length of 256 characters.

Cluster Set Protocol

Persistence servers with a cluster's server set communicate with one another using this transport.

Select the transport protocol from the drop-down menu in this column. As needed, set the host, subnet, and port parameters in server-level columns. Set other parameters in the server details panel.

Notice that all the servers in a server set use the same cluster protocol, though individual servers can supply different transport parameters.

For connection-oriented protocols, such as static TCP and RDMA, the realm server automatically arranges the listening ends and connecting ends.

Client Protocol

Client applications communicate with persistence servers in the cluster using the client transport.

Select the client transport protocol from the drop-down menu in this column. As needed, set the host, subnet, and port parameters in server-level columns. Set other parameters in the server details panel.

Notice that all the servers in a cluster use the same client protocol, though individual servers can supply different transport parameters.

For connection-oriented protocols, such as static TCP and RDMA, the persistence server always is the listening end, and clients the connecting end.

Server Level

If the cluster enables the disaster recovery feature, then each set must contain equivalent servers. For background information, see Disaster Recovery.

Column	JSON Attribute	Description
Server Name	`name`	Required. Name of the persistence server. Persistence server names must be globally unique within the realm. All names are limited to a maximum length of 256 characters.
Weight	`weight`	Optional. This value must be an integer in the range [1,10]. Larger values indicate greater preference that the server becomes the leader. When absent, the default weight is 10.
Cluster Host/Subnet Cluster Port		Persistence servers inherit the cluster transport protocol from the server set. For connection-oriented transports, set the host name and port for establishing a connection (both are required). For dynamic TCP transports, you may set a subnet mask and port (both are optional).
Client Host/Subnet Client Port		Persistence servers inherit the client transport protocol from the server set. For connection-oriented transports, set the host name and port for establishing a connection (both are required). For dynamic TCP transports, you may set a subnet mask and port (both are optional).
DR Host DR Port		Persistence servers inherit the disaster recovery transport protocol from the cluster. Set the host name and port for establishing a connection (both are required).