Updated Branches: refs/heads/master 9238e2e60 -> d9c639bea
fix links & formatting for Cluster Config cluster.config is not documented. ET_NET and ET_CLUSTER should be documented some place. Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/5c687575 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/5c687575 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/5c687575 Branch: refs/heads/master Commit: 5c687575eea24e2064be382ce09970d850cb18f8 Parents: 9238e2e Author: Igor GaliÄ <[email protected]> Authored: Sun Aug 18 23:14:37 2013 +0200 Committer: Igor GaliÄ <[email protected]> Committed: Sun Aug 18 23:14:37 2013 +0200 ---------------------------------------------------------------------- doc/admin/cluster-howto.en.rst | 59 +++++++++--------------- doc/admin/configuring-traffic-server.en.rst | 2 - 2 files changed, 23 insertions(+), 38 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/5c687575/doc/admin/cluster-howto.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/cluster-howto.en.rst b/doc/admin/cluster-howto.en.rst index ee6a575..612db32 100644 --- a/doc/admin/cluster-howto.en.rst +++ b/doc/admin/cluster-howto.en.rst @@ -23,8 +23,7 @@ Traffic Server Cluster Traffic Server scales from a single node to multiple nodes that form a -cluster allowing you to improve system performance and reliability. This -chapter discusses the following topics: +cluster allowing you to improve system performance and reliability. .. toctree:: :maxdepth: 1 @@ -40,8 +39,8 @@ Traffic Server uses its own protocol for clustering, which is multicast for node location and heartbeat, but unicast for all data exchange within the cluster. Traffic Server has two clustering modes: -- Management-only mode; refer to Management-Only Clustering below. -- Full-clustering mode; refer to Full Clustering +- Management-only mode; refer to `Management-Only Clustering`_ below. +- Full-clustering mode; refer to `Full Clustering`_ Management-Only Clustering ========================== @@ -85,9 +84,9 @@ things are in order: - You are using the same operation system on all nodes: - - Using the same distribution, fx: RHEL 5.5 - - Have same kernel, fx: 2.6.18-194.17.1.el5 - - The same architecture, fx: ``x86_64`` + - Using the same distribution, e.g.: RHEL 5.5 + - Have same kernel, e.g.: 2.6.18-194.17.1.el5 + - The same architecture, e.g.: ``x86_64`` - You have the same version of Traffic Server installed - The same hardware @@ -97,41 +96,31 @@ Traffic Server does not apply the clustering mode change to all the nodes in the cluster. You must change the clustering mode on each node individually. You may following these instructions: -1. setup the same cluster name, or proxy name, e.g. MyCluster: +1. setup the same cluster name, with :ts:cv:`proxy.config.proxy_name`, e.g. MyCluster. - :: - traffic_line -s proxy.config.proxy_name -v MyCluster +2. Set :ts:cv:`proxy.config.proxy_name` to ``1``, to enable cluster mode. -2. enable cluster mode: +3. Setup a :ts:cv:`proxy.config.cluster.ethernet_interface`, e.g.: ``eth0``. + This should be replaced by your real interface; we recommends a + dedicated interface here. Refer to :ts:cv:`proxy.local.cluster.type` for a full description. - :: - traffic_line -s proxy.local.cluster.type -v 1 - traffic_line -s proxy.config.cluster.ethernet_interface -v eth0 +3. enable: :: - ``eth0`` should be replaced by your real interface, we recommends a - dedicated interface here. Refer to - ```proxy.local.cluster.type`` <../configuration-files/records.config#proxy.local.cluster.type>`_ - for a full description. - -3. enable: - - :: traffic_line -x -4. restart: +4. restart: :: - :: traffic_line -L The :program:`traffic_server` and :program:`traffic_manager` processes will need to - restart after the change of 'proxy.local.cluster.type' and - 'proxy.config.cluster.ethernet_interface' have taken place. + restart after the change of :ts:cv:`proxy.local.cluster.type` and + :ts:cv:`proxy.config.cluster.ethernet_interface` have taken place. Traffic Server will join the cluster in about 10 seconds, and you can -run ``traffic_line -r proxy.process.cluster.nodes`` to check the hosts -in the cluster, or check out the -```cluster.config`` <../configuration-files/cluster.configcluster.config>`_ -in the configuration directory. +run :option:`traffic_line -r` `proxy.process.cluster.nodes` to check the hosts +in the cluster, or check out the :file:`cluster.config` in the configuration directory. + +.. XXX:: cluster.config is not documented. After a successful join of the cluster, all changes of global configurations on any node, will take effect on **all** nodes. @@ -140,7 +129,7 @@ Deleting Nodes from a Cluster ============================= To delete a node from the Traffic Server cluster, just roll back -``proxy.config.cluster.type`` to the default value 3 and reload. +:ts:cv:`proxy.config.cluster.type` to the default value 3 and reload. Performance tweak for busy Cluster ================================== @@ -154,18 +143,16 @@ connections: In the cluster env, the current performance of the Cluster threads will consume the same cpu usage as net threads, so you may adapt the ET_NET & ET_CLUSTER at about 1:1. For example, on a 24 cores - system, set ET_NET threads to 10, ET_CLUSTER threads to 10. + system, set ET_NET threads & ET_CLUSTER threads to 10, by setting :ts:cv:`proxy.config.cluster.threads` to ``10``. - :: - traffic_line -s proxy.config.cluster.threads -v 10 +.. XXX:: ET_NET and ET_CLUSTER should be documented some place. Right now, this means nothing to me. - Setup the Cluster connections: In the Cluster, the internal connections is TCP and limited by ET_CLUSTER threads and network performance, we can increase the - connections to archive better performance. + connections to archive better performance.:: - :: traffic_line -s proxy.config.cluster.num_of_cluster_connections -v 10 with these tweaks, we can archive about 10gbps traffic for the internal http://git-wip-us.apache.org/repos/asf/trafficserver/blob/5c687575/doc/admin/configuring-traffic-server.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/configuring-traffic-server.en.rst b/doc/admin/configuring-traffic-server.en.rst index e211e4d..ca33e86 100644 --- a/doc/admin/configuring-traffic-server.en.rst +++ b/doc/admin/configuring-traffic-server.en.rst @@ -23,8 +23,6 @@ Configuring Traffic Server Traffic Server provides several options for configuring the system. -This chapter discusses the following topics: - .. toctree:: :maxdepth: 2
