Man pages sections > man5 > cluster

cluster.config - the cluster.config tracks Traffic Server cluster membership,

CLUSTER.CONFIG(5) Apache Traffic Server CLUSTER.CONFIG(5)

NAME

cluster.config - the cluster.config tracks Traffic Server cluster membership, allowing more than one server running Traffic Server to coordinate and either replicate or distribute cache operations
 
For the contents of this file to reflect any clustering peers, Traffic Server clustering must first be enabled by adjusting proxy.local.cluster.type.
 
For information on how to enable and configure Traffic Server clustering, refer to the traffic-server-cluster section.
 
DANGER:
The cluster.config configuration file is generated and managed by Traffic Server itself and should not be modified directly.


FORMAT

The format of cluster.config is simple. Lines beginning with # are comments and, as such, will be ignored by Traffic Server. The first non-comment, non-empty line is an integer indicating the number of Traffic Server cluster peers for the current node. If the current node is not a member of a cluster, this value will be 0.
 
Following lines provide the <address>:<port> of each peer in the cluster. By default, Traffic Server uses 8086 for cluster communication. This may be adjusted with proxy.config.cluster.cluster_port. Note that this setting is in the CONFIG scope, which means it must be set to the same value on all cluster peers.

EXAMPLES

Stand-alone Proxy

When running a single Traffic Server node without a cluster, the configuration file will simply contain a zero, indicating that there are no cluster peers, as so:
 
0


 
Because there are zero peers in the (non-existent) cluster, no address lines follow.

Multiple Peers

In a cluster with four members (including the current node), the configuration will appear as:
 
3
127.1.2.3:8086
127.1.2.4:8086
127.1.2.5:8086


 
Though, of course, the IP addresses will be appropriate for your network. If you have configured your Traffic Server nodes to use a cluster management port other than the default 8086 the port numbers will differ, as well.
 
The configuration will not include the current Traffic Server node's address, only its peers' addresses. 2017, dev@trafficserver.apache.org
March 22, 2017 7.0