Repository: trafficserver Updated Branches: refs/heads/master 5f2fc30d7 -> 9b3b8150d
doc: Add documentation for wccp_client. Fix up inline routing document. Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/9b3b8150 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/9b3b8150 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/9b3b8150 Branch: refs/heads/master Commit: 9b3b8150d462dba685c9ca1a003c4f89567beebe Parents: 5f2fc30 Author: shinrich <shinr...@yahoo-inc.com> Authored: Thu Jan 8 14:54:31 2015 -0600 Committer: shinrich <shinr...@yahoo-inc.com> Committed: Thu Jan 8 14:54:31 2015 -0600 ---------------------------------------------------------------------- .../transparent-proxy/router-inline.en.rst | 6 +- .../transparent-proxy/wccp-configuration.en.rst | 1 + doc/reference/commands/index.en.rst | 1 + doc/reference/commands/wccp_client.en.rst | 74 ++++++++++++++++++++ 4 files changed, 79 insertions(+), 3 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b3b8150/doc/admin/transparent-proxy/router-inline.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/transparent-proxy/router-inline.en.rst b/doc/admin/transparent-proxy/router-inline.en.rst index b3c0d8f..0e9060a 100644 --- a/doc/admin/transparent-proxy/router-inline.en.rst +++ b/doc/admin/transparent-proxy/router-inline.en.rst @@ -39,8 +39,8 @@ appropriately. iptables -t mangle -A PREROUTING -i eth1 -p tcp -m tcp --dport 80 -j TPROXY \ --on-ip 0.0.0.0 --on-port 8080 --tproxy-mark 1/1 # Let locally directed traffic pass through. - iptables -t mangle -A PREROUTING -i eth0 --source 192.168.56.0/24 -j ACCEPT - iptables -t mangle -A PREROUTING -i eth0 --destination 192.168.56.0/24 -j ACCEPT + iptables -t mangle -A PREROUTING -i eth0 --source 192.168.1.0/24 -j ACCEPT + iptables -t mangle -A PREROUTING -i eth0 --destination 192.168.1.0/24 -j ACCEPT # Mark presumed return web traffic iptables -t mangle -A PREROUTING -i eth0 -p tcp -m tcp --sport 80 -j MARK --set-mark 1/1 @@ -73,7 +73,7 @@ The marking used is arbitrary but it must be consistent between To configure Traffic Server set the following values in :file:`records.config` -``proxy.config.http.server_port`` +``proxy.config.http.server_ports`` ``STRING`` Default: *value from* ``--on-port`` http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b3b8150/doc/admin/transparent-proxy/wccp-configuration.en.rst ---------------------------------------------------------------------- diff --git a/doc/admin/transparent-proxy/wccp-configuration.en.rst b/doc/admin/transparent-proxy/wccp-configuration.en.rst index 2588822..61d3f21 100644 --- a/doc/admin/transparent-proxy/wccp-configuration.en.rst +++ b/doc/admin/transparent-proxy/wccp-configuration.en.rst @@ -18,6 +18,7 @@ WCCP Configuration specific language governing permissions and limitations under the License. +.. _wccp-configuration: .. toctree:: :maxdepth: 2 http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b3b8150/doc/reference/commands/index.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/commands/index.en.rst b/doc/reference/commands/index.en.rst index a6b615b..5488d60 100644 --- a/doc/reference/commands/index.en.rst +++ b/doc/reference/commands/index.en.rst @@ -32,3 +32,4 @@ Command Reference traffic_via.en tspush.en tsxs.en + wccp_client.en http://git-wip-us.apache.org/repos/asf/trafficserver/blob/9b3b8150/doc/reference/commands/wccp_client.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/commands/wccp_client.en.rst b/doc/reference/commands/wccp_client.en.rst new file mode 100644 index 0000000..59e7df0 --- /dev/null +++ b/doc/reference/commands/wccp_client.en.rst @@ -0,0 +1,74 @@ +.. 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 + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +.. _wccp_client: + +=========== +wccp_client +=========== + +.. program:: wccp_client + +Description +=========== + +Wccp_client is a front end to the wccp client library. It is a stand +alone program that speaks the client side of the WCCP cache protocol. + +It can be used instead of the built in WCCP feature in Apache traffic server. +This can be beneficial if you have multiple programs running on the same +computer that are relying on WCCP to redirect traffic from the router to +the computer. + +Since it relies on the wccp library, the wccp_client is only build if apache +traffic server is configured with --enable-wccp. + +The overall Apache Traffic Server WCCP configuration documentation is +at :ref:`WCCP Configuratoin <wccp-configuration>` + +The wccp-client takes the following arguments. + +.. option:: --address IP address to bind. + +.. option:: --router Booststrap IP address for routers. + +.. option:: --service Path to service group definitions. + +.. option:: --debug Print debugging information. + +.. option:: --daemon Run as daemon. + +You need to run at least with the --service arguments. +An example service definition file, service-nogre-example.config, is included +in the tools/wccp_client directory. In this file you define your MD5 security password +(highly recommended), and you define your service groups. For each service +group you define how the service should be recognized (protocol and port), +the routers you are communicating with, whether you are using GRE or basic L2 +routing to redirect packets. + +In addition, you can specify a proc-name, a path +to a process pid file. If the proc-name is present, the wccp client will +only advertise the associated service group, if the process is currently +up and running. So if your computer is hosting three services, and one of +them goes down, the wccp client could stop advertising the service group +associated with the down service thus stopping the router from redirecting +that traffic, but continue to advertise and maintain the redireciton for the +other two services. + +The current WCCP implementation associated with ATS only supports one cache +client per service group per router. The cache assignment logic current +assigns the current cache client to all buckets.
