trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject [trafficserver] 03/08: TS-2171: docs: cluster.config entry in configuration files admin section
Date Tue, 23 Aug 2016 07:52:22 GMT
This is an automated email from the ASF dual-hosted git repository.

jsime pushed a commit to branch master
in repository

commit 1ec7560a931af98b79c909956a8a12bcb0c2c03e
Author: Jon Sime <>
AuthorDate: Mon Aug 22 18:16:05 2016 +0000

    TS-2171: docs: cluster.config entry in configuration files admin section
 doc/admin-guide/files/cluster.config.en.rst | 85 +++++++++++++++++++++++++++++
 doc/admin-guide/files/index.en.rst          |  4 ++
 2 files changed, 89 insertions(+)

diff --git a/doc/admin-guide/files/cluster.config.en.rst b/doc/admin-guide/files/cluster.config.en.rst
new file mode 100644
index 0000000..c08c296
--- /dev/null
+++ b/doc/admin-guide/files/cluster.config.en.rst
@@ -0,0 +1,85 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+   or more contributor license agreements.  See the NOTICE file
+   distributed with this work for additional information
+   regarding copyright ownership.  The ASF licenses this file
+   to you under the Apache License, Version 2.0 (the
+   "License"); you may not use this file except in compliance
+   with the License.  You may obtain a copy of the License at
+   Unless required by applicable law or agreed to in writing,
+   software distributed under the License is distributed on an
+   KIND, either express or implied.  See the License for the
+   specific language governing permissions and limitations
+   under the License.
+.. include:: ../../common.defs
+.. configfile:: cluster.config
+The :file:`cluster.config` tracks |TS| cluster membership, allowing more than
+one server running |TS| to coordinate and either replicate or distribute cache
+For the contents of this file to reflect any clustering peers, |TS| clustering
+must first be enabled by adjusting :ts:cv:`proxy.local.cluster.type`.
+For information on how to enable and configure |TS| clustering, refer to the
+:ref:`traffic-server-cluster` section.
+.. danger::
+   The :file:`cluster.config` configuration file is generated and managed by
+   |TS| itself and should not be modified directly.
+The format of :file:`cluster.config` is simple. Lines beginning with ``#`` are
+comments and, as such, will be ignored by |TS|. The first non-comment,
+non-empty line is an integer indicating the number of |TS| 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, |TS| uses ``8086`` for cluster communication. This may be adjusted
+with :ts:cv:`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.
+Stand-alone Proxy
+When running a single |TS| 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
+Multiple Peers
+In a cluster with four members (including the current node), the configuration
+will appear as::
+    3
+Though, of course, the IP addresses will be appropriate for your network. If
+you have configured your |TS| 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 |TS| node's address, only its
+peers' addresses.
diff --git a/doc/admin-guide/files/index.en.rst b/doc/admin-guide/files/index.en.rst
index ca474b5..60ab442 100644
--- a/doc/admin-guide/files/index.en.rst
+++ b/doc/admin-guide/files/index.en.rst
@@ -26,6 +26,7 @@ Configuration Files
+   cluster.config.en
@@ -46,6 +47,9 @@ Configuration Files
     Defines if, how, and for what durations |TS| caches objects, based on
     destinations, clients, URL components, and more.
+    Manages |TS| cluster configuration and membership on each node.
     Defines network conditions under which clients will receive retry messages
     instead of |TS| contacting origin servers.

To stop receiving notification emails like this one, please contact
"" <>.

View raw message