.\" Man page generated from reStructuredText.
.
.TH "CLUSTER.CONFIG" "5" "Mar 22, 2017" "7.0" "Apache Traffic Server"
.SH 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
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
For the contents of this file to reflect any clustering peers, Traffic Server clustering
must first be enabled by adjusting \fBproxy.local.cluster.type\fP\&.
.sp
For information on how to enable and configure Traffic Server clustering, refer to the
traffic\-server\-cluster section.
.sp
\fBDANGER:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%cluster.config\fP configuration file is generated and managed by
Traffic Server itself and should not be modified directly.
.UNINDENT
.UNINDENT
.SH FORMAT
.sp
The format of \fI\%cluster.config\fP is simple. Lines beginning with \fB#\fP 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 \fB0\fP\&.
.sp
Following lines provide the \fB<address>:<port>\fP of each peer in the cluster.
By default, Traffic Server uses \fB8086\fP for cluster communication. This may be adjusted
with \fBproxy.config.cluster.cluster_port\fP\&. Note that this setting is in
the \fBCONFIG\fP scope, which means it must be set to the same value on all
cluster peers.
.SH EXAMPLES
.SS Stand\-alone Proxy
.sp
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:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
0
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Because there are zero peers in the (non\-existent) cluster, no address lines
follow.
.SS Multiple Peers
.sp
In a cluster with four members (including the current node), the configuration
will appear as:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
3
127.1.2.3:8086
127.1.2.4:8086
127.1.2.5:8086
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
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 \fB8086\fP the port numbers will differ, as well.
.sp
The configuration will not include the current Traffic Server node\(aqs address, only its
peers\(aq addresses.
.SH COPYRIGHT
2017, dev@trafficserver.apache.org
.\" Generated by docutils manpage writer.
.