You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2015/11/03 07:09:46 UTC
[10/51] trafficserver git commit: Documentation reorganization
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_line.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_line.en.rst b/doc/reference/commands/traffic_line.en.rst
deleted file mode 100644
index b61c763..0000000
--- a/doc/reference/commands/traffic_line.en.rst
+++ /dev/null
@@ -1,299 +0,0 @@
-.. 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.
-
-============
-traffic_line
-============
-
-.. note::
-
- This utility is deprecated as of v6.0.0, and replaced with
- :program:`traffic_ctl`. You should change your tools / scripts to use this
- new application instead.
-
-Synopsis
-========
-
-
-:program:`traffic_line` [options]
-
-.. _traffic-line-commands:
-
-Description
-===========
-
-:program:`traffic_line` is used to execute individual Traffic Server
-commands and to script multiple commands in a shell.
-
-Options
-=======
-
-.. program:: traffic_line
-
-.. option:: -B, --bounce_cluster
-
- Bounce all Traffic Server nodes in the cluster. Bouncing Traffic
- Server shuts down and immediately restarts Traffic Server,
- node-by-node.
-
-.. option:: -b, --bounce_local
-
- Bounce Traffic Server on the local node. Bouncing Traffic Server
- shuts down and immediately restarts the Traffic Server node.
-
-.. option:: -C, --clear_cluster
-
- Clears accumulated statistics on all nodes in the cluster.
-
-.. option:: -c, --clear_node
-
- Clears accumulated statistics on the local node.
-
-.. option:: --drain
-
- This option modifies the behavior of :option:`traffic_line -b`
- and :option:`traffic_line -L` such that :program:`traffic_server`
- is not shut down until the number of active client connections
- drops to the number given by the
- :ts:cv:`proxy.config.restart.active_client_threshold` configuration
- variable.
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -L, --restart_local
-
- Restart the :program:`traffic_manager` and :program:`traffic_server`
- processes on the local node.
-
-.. option:: -M, --restart_cluster
-
- Restart the :program:`traffic_manager` process and the
- :program:`traffic_server` process on all the nodes in a cluster.
-
-.. option:: -m REGEX, --match_var REGEX
-
- Display the current values of all performance statistics or configuration
- variables whose names match the given regular expression.
-
-.. option:: -r VAR, --read_var VAR
-
- Display specific performance statistics or a current configuration
- setting.
-
-.. option:: -s VAR, --set_var VAR
-
- Set the configuration variable named *VAR*. The value of the configuration
- variable is given by the :option:`traffic_line -v` option.
- Refer to the :file:`records.config` documentation for a list
- of the configuration variables you can specify.
-
-.. option:: -S, --shutdown
-
- Shut down Traffic Server on the local node.
-
-.. option:: -U, --startup
-
- Start Traffic Server on the local node.
-
-.. option:: -v VALUE, --value VALUE
-
- Specify the value to set when setting a configuration variable.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-.. option:: -x, --reread_config
-
- Initiate a Traffic Server configuration file reread. Use this
- command to update the running configuration after any configuration
- file modification.
-
- The timestamp of the last reconfiguration event (in seconds
- since epoch) is published in the `proxy.node.config.reconfigure_time`
- metric.
-
-.. option:: -Z, --zero_cluster
-
- Reset performance statistics to zero across the cluster.
-
-.. option:: -z, --zero_node
-
- Reset performance statistics to zero on the local node.
-
-.. option:: --offline PATH
-
- Mark a cache storage device as offline. The storage is identified by a *path* which must match exactly a path
- specified in :file:`storage.config`. This removes the storage from the cache and redirects requests that would have
- used this storage to other storage. This has exactly the same effect as a disk failure for that storage. This does
- not persist across restarts of the :program:`traffic_server` process.
-
-.. option:: --alarms
-
- List all alarm events that have not been acknowledged (cleared).
-
-.. option:: --clear_alarms [all | #event | name]
-
- Clear (acknowledge) an alarm event. The arguments are "all" for all current
- alarms, a specific alarm number (e.g. ''1''), or an alarm string identifier
- (e.g. ''MGMT_ALARM_PROXY_CONFIG_ERROR'').
-
-.. option:: --status
-
- Show the current proxy server status, indicating if we're running or not.
-
-.. _traffic-line-performance-statistics:
-
-Performance Statistics
-======================
-
-proxy.process.ssl.user_agent_other_errors
- Total number of *other* ssl client connection errors (counts ssl
- errors that are not captured in other user agent stats below)
-
-proxy.process.ssl.user_agent_expired_cert
- Total number of ssl client connection failures where the cert was
- expired.
-
-proxy.process.ssl.user_agent_revoked_cert
- Total number of ssl client connection failures where the cert was
- revoked.
-
-proxy.process.ssl.user_agent_unknown_cert
- Total number of ssl client connection failures related to the cert,
- but specific error was unknown.
-
-proxy.process.ssl.user_agent_cert_verify_failed
- Total number of ssl client connection failures where cert verification
- failed.
-
-proxy.process.ssl.user_agent_bad_cert
- Total number of ssl client connection failures where the cert is bad.
-
-proxy.process.ssl.user_agent_decryption_failed
- Total number of ssl client connection decryption failures (during
- negotiation).
-
-proxy.process.ssl.user_agent_wrong_version
- Total number of ssl client connections that provided an invalid protocol
- version.
-
-proxy.process.ssl.user_agent_unknown_ca
- Total number of ssl client connection that failed due to unknown ca.
-
-proxy.process.ssl.origin_server_other_errors
- Total number of *other* ssl origin server connection errors (counts ssl
- errors that are not captured in other origin server stats below).
-
-proxy.process.ssl.origin_server_expired_cert
- Total number of ssl origin server connection failures where the cert
- was expired.
-
-proxy.process.ssl.origin_server_revoked_cert
- Total number of ssl origin server connection failures where the cert
- was revoked.
-
-proxy.process.ssl.origin_server_unknown_cert
- Total number of ssl origin server connection failures related to the
- cert where specific error was unknown.
-
-proxy.process.ssl.origin_server_cert_verify_failed
- Total number of ssl origin server connection failures where cert
- verification failed.
-
-proxy.process.ssl.origin_server_bad_cert
- Total number of ssl origin server connection failures where the cert
- is bad.
-
-proxy.process.ssl.origin_server_decryption_failed
- Total number of ssl origin server connection decryption failures
- (during negotiation).
-
-proxy.process.ssl.origin_server_wrong_version
- Total number of ssl origin server connections that provided an invalid
- protocol version.
-
-proxy.process.ssl.origin_server_unknown_ca
- Total number of ssl origin server connection that failed due to
- unknown ca.
-
-proxy.process.ssl.user_agent_sessions
- Total number of ssl/tls sessions created.
-
-proxy.process.ssl.user_agent_session_hit
- Total number of session hits. A previous session was reused which
- resulted in an abbreviated ssl client negotiation.
-
-proxy.process.ssl.user_agent_session_miss
- Total number of session misses. The ssl client provided a session id
- that was not found in cache and, therefore, could not be used.
-
-proxy.process.ssl.user_agent_session_timeout
- Total number of session timeouts. The ssl client provided a session, but
- it could not be used because it was past the session timeout.
-
-proxy.process.ssl.cipher.user_agent.{CIPHERNAME}
- Total number of ssl client connections that used cipherName. The
- list of cipher statistics is dynamic and depends upon the installed
- ciphers and the :ts:cv:`proxy.config.ssl.server.cipher_suite`
- configuration. The set of cipher statistics can be discovered
- with :option:`traffic_line -m`. For example::
-
- $ traffic_line -m proxy.process.ssl.cipher.user_agent.
- proxy.process.ssl.cipher.user_agent.ECDHE-RSA-AES256-GCM-SHA384 0
- proxy.process.ssl.cipher.user_agent.ECDHE-ECDSA-AES256-GCM-SHA384 0
- proxy.process.ssl.cipher.user_agent.ECDHE-RSA-AES256-SHA384 0
- proxy.process.ssl.cipher.user_agent.ECDHE-ECDSA-AES256-SHA384 0
- ...
-
-Cache Statistics
-======================
-
-Cache statistics come in two varieties, global and per cache volume. These will be listed here in the global form. To get a
-cache volume statistic add `.volume_#` to the name after `cache` where `#` is 1-based index of the volume in :file:`storage.config`.
-For example the statistic `proxy.process.cache.sync.bytes` is a global statistic. The value for the third cache volume is
-`proxy.process.cache.volume_3.sync.bytes`.
-
-proxy.process.cache.sync.bytes
- The total number of bytes written to disk to synchronize the cache directory.
-
-proxy.process.cache.sync.time
- The total time, in nanoseconds, during which the cache directory was being written to disk.
-
-proxy.process.cache.sync.count
- The number of times a cache directory sync has been done.
-
-proxy.process.cache.wrap_count
- The number of times a cache stripe has cycled. Each stripe is a circular buffer and this is incremented each time the
- write cursor is reset to the start of the stripe.
-
-Examples
-========
-
-Configure Traffic Server to log in Squid format::
-
- $ traffic_line -s proxy.config.log.squid_log_enabled -v 1
- $ traffic_line -s proxy.config.log.squid_log_is_ascii -v 1
- $ traffic_ctl config reload
-
-See also
-========
-
-:manpage:`records.config(5)`,
-:manpage:`storage.config(5)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_logcat.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logcat.en.rst b/doc/reference/commands/traffic_logcat.en.rst
deleted file mode 100644
index 7169503..0000000
--- a/doc/reference/commands/traffic_logcat.en.rst
+++ /dev/null
@@ -1,106 +0,0 @@
-.. 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.
-
-==============
-traffic_logcat
-==============
-
-Synopsis
-========
-
-:program:`traffic_logcat` [-o output-file | -a] [-CEhSVw2] [input-file ...]
-
-.. program:: traffic_logcat
-
-
-Description
-===========
-
-To analyse a binary log file using standard tools, you must first convert
-it to ASCII. :program:`traffic_logcat` does exactly that.
-
-Options
-=======
-
-.. option:: -o PATH, --output_file PATH
-
-Specifies where the command output is directed.
-
-.. option:: -a, --auto_filename
-
-Automatically generates the output filename based on the input
-filename. If the input is from stdin, then this option is ignored.
-For example::
-
- traffic_logcat -a squid-1.blog squid-2.blog squid-3.blog
-
-generates::
-
- squid-1.log squid-2.log squid-3.log
-
-.. option:: -f, --follow
-
-Follows the file, like :manpage:`tail(1)` ``-f``
-
-.. option:: -C, --clf
-
-Attempts to transform the input to Netscape Common format, if possible.
-
-.. option:: -E, --elf
-
-Attempts to transform the input to Netscape Extended format, if possible.
-
-.. option:: -S, --squid
-
-Attempts to transform the input to Squid format, if possible.
-
-.. option:: -2, --elf2
-
-Attempt to transform the input to Netscape Extended-2 format, if possible.
-
-.. option:: -T, --debug_tags
-
-.. option:: -w, --overwrite_output
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-
-.. note:: Use only one of the following options at any given time: ``-S``, ``-C``, ``-E``, or ``-2``.
-
-If no input files are specified, then :program:`traffic_logcat` reads from the
-standard input (``stdin``). If you do not specify an output file, then
-:program:`traffic_logcat` writes to the standard output (``stdout``).
-
-For example, to convert a binary log file to an ASCII file, you can use
-the :program:`traffic_logcat` command with either of the following options
-below::
-
- traffic_logcat binary_file > ascii_file
- traffic_logcat -o ascii_file binary_file
-
-The binary log file is not modified by this command.
-
-See Also
-========
-
-:manpage:`tail(1)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_logstats.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logstats.en.rst b/doc/reference/commands/traffic_logstats.en.rst
deleted file mode 100644
index 874870c..0000000
--- a/doc/reference/commands/traffic_logstats.en.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. 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.
-
-================
-traffic_logstats
-================
-
-.. program:: traffic_logstats
-
-Description
-===========
-
-.. option:: -f FILE, --log_file FILE
-
-.. option:: -o LIST, --origin_list LIST
-
-.. option:: -O FILE, --origin_file FILE
-
-.. option:: -M COUNT, --max_origins COUNT
-
-.. option:: -u COUNT, --urls COUNT
-
-.. option:: -U COUNT, --show_urls COUNT
-
-.. option:: --A, --as_object
-
-.. option:: -i, --incremental
-
-.. option:: -S FILE, --statetag FILE
-
-.. option:: -t, --tail
-
-.. option:: -s, --summary
-
-.. option:: -j, --json
-
-.. option:: -c, --cgi
-
-.. option:: -m, --min_hits
-
-.. option:: -a, --max_age
-
-.. option:: -l COUNT, --line_len COUNT
-
-.. option:: -T TAGS, --debug_tags TAGS
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_manager.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_manager.en.rst b/doc/reference/commands/traffic_manager.en.rst
deleted file mode 100644
index 65960c8..0000000
--- a/doc/reference/commands/traffic_manager.en.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-.. 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.
-
-.. _traffic_manager:
-
-===============
-traffic_manager
-===============
-
-.. program:: traffic_manager
-
-Description
-===========
-
-.. option:: --aconfPort PORT
-.. option:: --action TAGS
-.. option:: --clusterMCPort PORT
-.. option:: --clusterRSPort PORT
-.. option:: --debug TAGS
-.. option:: --groupAddr ADDRESS
-.. option:: --help
-.. option:: --nosyslog
-.. option:: --path FILE
-.. option:: --proxyBackDoor PORT
-.. option:: --proxyOff
-.. option:: --proxyPort PORT
-.. option:: --recordsConf FILE
-.. option:: --tsArgs ARGUMENTS
-.. option:: --version
-
-Environment
-===========
-
-.. envvar:: MGMT_ACONF_PORT
-.. envvar:: MGMT_CLUSTER_MC_PORT
-.. envvar:: MGMT_CLUSTER_RS_PORT
-.. envvar:: MGMT_GROUP_ADDR
-
-Signals
-=======
-
-SIGHUP
- This signal causes a reconfiguration event, equivalent to running :program:`traffic_ctl config reload`.
-
-See also
-========
-
-:manpage:`traffic_ctl(8)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_server.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_server.en.rst b/doc/reference/commands/traffic_server.en.rst
deleted file mode 100644
index c8179f7..0000000
--- a/doc/reference/commands/traffic_server.en.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-.. 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.
-
-.. _traffic-server:
-
-==============
-traffic_server
-==============
-
-.. program:: traffic_server
-
-Description
-===========
-
-.. option:: -n COUNT, --net_threads COUNT
-
-.. option:: -Z COUNT, --cluster_threads COUNT
-
-.. option:: -U COUNT, --udp_threads COUNT
-
-.. option:: -a, --accepts_thread
-
-.. option:: -b, --accept_till_done
-
-.. option:: -p PORT, --httpport PORT
-
-.. option:: -P PORT, --cluster_port PORT
-
-.. option:: -f, --disable_freelist
-
-In order to improve performance, :program:`traffic_server` caches
-commonly used data structures in a set of free object lists. This
-option disables these caches, causing :program:`traffic_server` to
-use :manpage:`malloc(3)` for every allocation. Though this option
-should not commonly be needed, it may be beneficial in memory-constrained
-environments or where the working set is highly variable.
-
-.. option:: -o LEVEL, --dprintf_level LEVEL
-
-.. option:: -R LEVEL, --regression LEVEL
-
-.. option:: -r TEST, --regression_rest TEST
-
-.. option:: -T TAGS, --debug_tags TAGS
-
-.. option:: -B TAGS, --action_tags TAGS
-
-.. option:: -i COUNT, --interval COUNT
-
-.. option:: -M, --remote_management
-
-.. option:: -C CMD, --command CMD
-
-.. option:: -k, --clear_hostdb
-
-.. option:: -K, --clear_cache
-
-.. option:: -c CORE, --read_core CORE
-
-.. option:: --accept_mss MSS
-
-.. option:: -t MSECS, --poll_timeout MSECS
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-Environment
-===========
-
-.. envvar:: PROXY_REMOTE_MGMT
-
-.. envvar:: PROXY_AUTO_EXIT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_top.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_top.en.rst b/doc/reference/commands/traffic_top.en.rst
deleted file mode 100644
index 3c73a1f..0000000
--- a/doc/reference/commands/traffic_top.en.rst
+++ /dev/null
@@ -1,27 +0,0 @@
-.. 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.
-
-===========
-traffic_top
-===========
-
-.. program:: traffic_top
-
-Description
-===========
-
-.. option:: -s COUNT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_via.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_via.en.rst b/doc/reference/commands/traffic_via.en.rst
deleted file mode 100644
index 94a82fd..0000000
--- a/doc/reference/commands/traffic_via.en.rst
+++ /dev/null
@@ -1,90 +0,0 @@
-.. 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.
-
-.. _traffic_via:
-
-============
-traffic_via
-============
-
-Synopsis
-========
-
-:program:`traffic_via` [OPTIONS] [VIA ...]
-
-.. program:: traffic_via
-
-Description
-===========
-
-:program:`traffic_via` decodes the Traffic Server Via header codes.
-Via header strings are passed as command-line options. The enclosing
-square brackets are optional.
-
-If the argument is '-', :program:`traffic_via` will filter standard
-input for Via headers. This modes supports only supports Via headers
-taht are enclosed by square brackets.
-
-Options
-=======
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version.
-
-Examples
-========
-
-Decode the Via header from command-line arguments::
-
- $ traffic_via "[uScMsEf p eC:t cCMi p sF]"
- Via header is uScMsEf p eC:t cCMi p sF, Length is 24
- Via Header Details:
- Request headers received from client :simple request (not conditional)
- Result of Traffic Server cache lookup for URL :miss (a cache "MISS")
- Response information received from origin server :error in response
- Result of document write-to-cache: :no cache write performed
- Proxy operation result :unknown
- Error codes (if any) :connection to server failed
- Tunnel info :no tunneling
- Cache Type :cache
- Cache Lookup Result :cache miss (url not in cache)
- ICP status :no icp
- Parent proxy connection status :no parent proxy or unknown
- Origin server connection status :connection open failed
-
-Decode the Via header from a curl request, using the :ref:`X-Debug <_xdebug_plugin>` plugin::
-
- $ curl -H "X-Debug: Via" -I http://test.example.com | traffic_via -
- Via header is uScMsSf pSeN:t cCMi p sS, Length is 24
- Via Header Details:
- Request headers received from client :simple request (not conditional)
- Result of Traffic Server cache lookup for URL :miss (a cache "MISS")
- Response information received from origin server :connection opened successfully
- Result of document write-to-cache: :no cache write performed
- Proxy operation result :served or connection opened successfully
- Error codes (if any) :no error
- Tunnel info :no tunneling
- Cache Type :cache
- Cache Lookup Result :cache miss (url not in cache)
- ICP status :no icp
- Parent proxy connection status :no parent proxy or unknown
- Origin server connection status :connection opened successfully
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/traffic_wccp.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_wccp.en.rst b/doc/reference/commands/traffic_wccp.en.rst
deleted file mode 100644
index efb1e4d..0000000
--- a/doc/reference/commands/traffic_wccp.en.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-.. 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.
-
-.. _traffic_wccp:
-
-============
-traffic_wccp
-============
-
-.. program:: traffic_wccp
-
-Description
-===========
-
-Traffic_wccp 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, traffic_wccp is only built if apache
-traffic server is configured with --enable-wccp.
-
-The overall Apache Traffic Server WCCP configuration documentation is
-at :ref:`WCCP Configuration <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 cmd/traffic_wccp directory. In this file you define your MD5 security password
-(highly recommended), and you define your service groups. The details
-of the service file are defined at :ref:`WCCP Service Configuration <wccp-service-configuration>`.
-
-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.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/tspush.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tspush.en.rst b/doc/reference/commands/tspush.en.rst
deleted file mode 100644
index fc7c947..0000000
--- a/doc/reference/commands/tspush.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. 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.
-
-======
-tspush
-======
-
-.. program:: tspush
-
-Description
-===========
-
-.. option:: -f FILE, --file FILE
-
-.. option:: -u URL, --url URL
-
-.. option:: -v, --verbose
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/commands/tsxs.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tsxs.en.rst b/doc/reference/commands/tsxs.en.rst
deleted file mode 100644
index 17db7b2..0000000
--- a/doc/reference/commands/tsxs.en.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. 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.
-
-====
-tsxs
-====
-
-.. program:: tsxs
-
-Description
-===========
-
-.. option:: -q VAR, --query VAR
-
-.. option:: -I PATH
-
-.. option:: -L PATH
-
-.. option:: -l LIB
-
-.. option:: -o FILE
-
-.. option:: -i
-
-.. option:: -c FILE [FILE ...]
-
-.. option:: -C FILE [FILE ...]
-
-.. option:: -v, --verbose
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/cache.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/cache.config.en.rst b/doc/reference/configuration/cache.config.en.rst
deleted file mode 100644
index 0472151..0000000
--- a/doc/reference/configuration/cache.config.en.rst
+++ /dev/null
@@ -1,203 +0,0 @@
-.. 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.
-
-.. configfile:: cache.config
-
-============
-cache.config
-============
-
-The :file:`cache.config` file (by default, located in
-``/usr/local/etc/trafficserver/``) defines how Traffic Server caches
-web objects. You can add caching rules to specify the following:
-
- - Not to cache objects from specific IP addresses
- - How long to pin particular objects in the cache
- - How long to consider cached objects as fresh
- - Whether to ignore no-cache directives from the server
-
-.. important::
-
- After you modify the :file:`cache.config` file, navigate to
- the Traffic Server bin directory; then run the :option:`traffic_ctl config reload`
- command to apply changes. When you apply the changes to a node in a
- cluster, Traffic Server automatically applies the changes to all other
- nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`cache.config` file contains a caching rule. Traffic
-Server recognizes three space-delimited tags::
-
- primary_destination=value secondary_specifier=value action=value
-
-You can use more than one secondary specifier in a rule. However, you
-cannot repeat a secondary specifier. The following list shows the
-possible primary destinations with allowed values.
-
-.. _cache-config-format-dest-domain:
-
-``dest_domain``
- A requested domain name. Traffic Server matches the domain name of
- the destination from the URL in the request.
-
-.. _cache-config-format-dest-host:
-
-``dest_host``
- A requested hostname. Traffic Server matches the hostname of the
- destination from the URL in the request.
-
-.. _cache-config-format-dest-ip:
-
-``dest_ip``
- A requested IP address. Traffic Server matches the IP address of the
- destination in the request.
-
-.. _cache-config-format-url-regex:
-
-``url_regex``
- A regular expression (regex) to be found in a URL.
-
-The secondary specifiers are optional in the :file:`cache.config` file. The
-following list shows possible secondary specifiers with allowed values.
-
-.. _cache-config-format-port:
-
-``port``
- A requested URL port.
-
-.. _cache-config-format-scheme:
-
-``scheme``
- A request URL protocol: http or https.
-
-.. _cache-config-format-prefix:
-
-``prefix``
- A prefix in the path part of a URL.
-
-.. _cache-config-format-suffix:
-
-``suffix``
- A file suffix in the URL.
-
-.. _cache-config-format-method:
-
-``method``
- A request URL method: get, put, post, trace.
-
-.. _cache-config-format-time:
-
-``time``
- A time range, such as 08:00-14:00.
-
-.. _cache-config-format-src-ip:
-
-``src_ip``
- A client IP address.
-
-.. _cache-config-format-internal:
-
-``internal``
- A boolean value, ``true`` or ``false``, specifying if the rule should
- match (or not match) a transaction originating from an internal API. This
- is useful to differentiate transaction originating from an ATS plugin.
-
-The following list shows possible actions and their allowed values.
-
-
-.. _cache-config-format-action:
-
-``action``
- One of the following values:
-
- - ``never-cache`` configures Traffic Server to never cache
- specified objects.
- - ``ignore-no-cache`` configures Traffic Server to ignore all
- ``Cache-Control: no-cache`` headers.
- - ``ignore-client-no-cache`` configures Traffic Server to ignore
- ``Cache-Control: no-cache`` headers from client requests.
- - ``ignore-server-no-cache`` configures Traffic Server to ignore
- ``Cache-Control: no-cache`` headers from origin server responses.
- - ``cluster-cache-local`` configures the cluster cache to allow for
- this content to be stored locally on every cluster node.
-
-.. _cache-responses-to-cookies:
-
-``cache-responses-to-cookies``
- Change the style of caching with regard to cookies. This effectively
- overrides the configuration parameter
- :ts:cv:`proxy.config.http.cache.cache_responses_to_cookies`
- and uses the same values with the same semantics. The override happens
- only for requests that match.
-
-
-.. _cache-config-format-pin-in-cache:
-
-``pin-in-cache``
- Preserves objects in cache, preventing them from being overwritten.
- Does not affect objects that are determined not to be cacheable. This
- setting can have performance issues, and severely affect the cache.
- For instance, if the primary destination matches all objects, once the
- cache is full, no new objects could get written as nothing would be
- evicted. Similarly, for each cache-miss, each object would incur extra
- checks to determine if the object it would replace could be overwritten.
-
- The value is the amount of time you want to keep the object(s) in the cache. The
- following time formats are allowed:
-
- - ``d`` for days; for example: 2d
- - ``h`` for hours; for example: 10h
- - ``m`` for minutes; for example: 5m
- - ``s`` for seconds; for example: 20s
- - mixed units; for example: 1h15m20s
-
-.. _cache-config-format-revalidate:
-
-``revalidate``
- For objects that are in cache, overrides the the amount of time the object(s)
- are to be considered fresh. Use the same time formats as ``pin-in-cache``.
-
-.. _cache-config-format-ttl-in-cache:
-
-``ttl-in-cache``
- Forces object(s) to become cached, as if they had a Cache-Control: max-age:<time>
- header. Can be overruled by requests with cookies. The value is the amount of
- time object(s) are to be kept in the cache, regardless of Cache-Control response
- headers. Use the same time formats as pin-in-cache and revalidate.
-
-Examples
-========
-
-The following example configures Traffic Server to revalidate ``gif``
-and ``jpeg`` objects in the domain ``mydomain.com`` every 6 hours, and
-all other objects in ``mydomain.com`` every hour. The rules are applied
-in the order listed. ::
-
- dest_domain=mydomain.com suffix=gif revalidate=6h
- dest_domain=mydomain.com suffix=jpeg revalidate=6h
- dest_domain=mydomain.com revalidate=1h
-
-Force a specific regex to be in cache between 7-11pm of the server's time for 26hours. ::
-
- url_regex=example.com/articles/popular.* time=19:00-23:00 ttl-in-cache=1d2h
-
-Prevent objects from being evicted from cache:
-
- url_regex=example.com/game/.* pin-in-cache=1h
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/congestion.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/congestion.config.en.rst b/doc/reference/configuration/congestion.config.en.rst
deleted file mode 100644
index 47af214..0000000
--- a/doc/reference/configuration/congestion.config.en.rst
+++ /dev/null
@@ -1,198 +0,0 @@
-.. 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.
-
-=================
-congestion.config
-=================
-
-.. configfile:: congestion.config
-
-The :file:`congestion.config` file (by default, located in
-``/usr/local/etc/trafficserver/``) enables you to configure Traffic Server
-to stop forwarding HTTP requests to origin servers when they become
-congested, and then send the client a message to retry the congested
-origin server later. After you modify the :file:`congestion.config` file,
-navigate to the Traffic Server bin directory; then run the
-:option:`traffic_ctl config reload` command to apply changes. When you apply the changes
-to a node in a cluster, Traffic Server automatically applies the changes
-to all other nodes in the cluster. Traffic Server uses the
-:file:`congestion.config` file only if you enable the
-:ts:cv:`proxy.config.http.congestion_control.enabled` option.
-
-You can create rules in the congestion.config file to specify:
-
-- Which origin servers Traffic Server tracks for congestion.
-- The timeouts Traffic Server uses, depending on whether a server is
- congested.
-- The page Traffic Server sends to the client when a server becomes
- congested.
-- If Traffic Server tracks the origin servers per IP address or per
- hostname.
-
-Format
-======
-
-Each line in :file:`congestion.config` must follow the format below. Traffic
-Server applies the rules in the order listed, starting at the top of the
-file. Traffic Server recognizes three space-delimited tags::
-
- primary_destination=value secondary_specifier=value action=value
-
-The following list shows possible primary destinations with allowed
-values.
-
-``dest_domain``
- A requested domain name.
-
-``dest_host``
- A requested hostname.
-
-``dest_ip``
- A requested IP address.
-
-``url_regex``
- A regular expression (regex) to be found in a URL.
-
-The secondary specifiers are optional in the congestion.config file. The
-following list shows possible secondary specifiers with allowed values.
-You can use more than one secondary specifier in a rule; however, you
-cannot repeat a secondary specifier.
-
-``port``
- A requested URL port or range of ports.
-
-``prefix``
- A prefix in the path part of a URL.
-
-The following list shows the possible tags and their allowed values.
-
-``max_connection_failures``
- Default: ``5``
- The maximum number of connection failures allowed within the fail
- window described below before Traffic Server marks the origin server
- as congested.
-
-``fail_window``
- Default: ``120`` seconds.
- The time period during which the maximum number of connection
- failures can occur before Traffic Server marks the origin server as
- congested.
-
-``proxy_retry_interval``
- Default: ``10`` seconds.
- The number of seconds that Traffic Server waits before contacting a
- congested origin server again.
-
-``client_wait_interval``
- Default: ``300`` seconds.
- The number of seconds that the client is advised to wait before
- retrying the congested origin server.
-
-``wait_interval_alpha``
- Default: ``30`` seconds
- The upper limit for a random number that is added to the wait
- interval.
-
-``live_os_conn_timeout``
- Default: ``60`` seconds.
- The connection timeout to the live (uncongested) origin server. If a
- client stops a request before the timeout occurs, then Traffic
- Server does not record a connection failure.
-
-``live_os_conn_retries``
- Default: ``2``
- The maximum number of retries allowed to the live (uncongested)
- origin server.
-
-``dead_os_conn_timeout``
- Default: ``15`` seconds.
- The connection timeout to the congested origin server.
-
-``dead_os_conn_retries``
- Default: ``1``
- The maximum number of retries allowed to the congested origin
- server.
-
-``max_connection``
- Default: ``-1``
- The maximum number of connections allowed from Traffic Server to the
- origin server.
-
-``error_page``
- Default: ``"congestion#retryAfter"``
- The error page sent to the client when a server is congested. You
- must enclose the value in quotes;
-
-``congestion_scheme``
- Default: ``"per_ip"``
- Specifies if Traffic Server applies the rule on a per-host
- (``"per_host"``) or per-IP basis (``"per_ip"``). You must enclose
- the value in quotes.
-
- For example: if the server ``www.host1.com`` has two IP addresses
- and you use the tag value ``"per_ip"``, then each IP address has its
- own number of connection failures and is marked as congested
- independently. If you use the tag value ``"per_host"`` and the
- server ``www.host1.com`` is marked as congested, then both IP
- addresses are marked as congested.
-
-Examples
-========
-
-The following :file:`congestion.config` rule configures Traffic Server to
-stop forwarding requests to the server ``www.host.com`` on port 80 (HTTP
-traffic) if the server is congested, according to the timeouts
-specified. Traffic Server uses the default tag values because no tag has
-been specified.
-
-::
-
- dest_host=www.host.com port=80
-
-You can use one or more tags in a rule, but each tag must have one value
-only. If you specify no tags in the rule, then Traffic Server uses the
-default values.
-
-You can override any of the default tag values by adding configuration
-variables at the end of :file:`records.config` as follows:
-
-::
-
- CONFIG proxy.config.http.congestion_control.default.tag INT|STRING value
-
-where tag is one of the tags described in the list under
-:file:`congestion.config` and value is the value you
-want to use.
-
-For example::
-
- CONFIG proxy.config.http.congestion_control.default.congestion_scheme STRING per_host
-
-.. important::
-
- Rules in the :file:`congestion.config` file override the
- following variables in the :file:`records.config` file:
-
-::
-
- proxy.config.http.connect_attempts_max_retries
- proxy.config.http.connect_attempts_max_retries_dead_server
- proxy.config.http.connect_attempts_rr_retries
- proxy.config.http.connect_attempts_timeout
- proxy.config.http.down_server.cache_time
- proxy.config.http.down_server.abort_threshold
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/hosting.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/hosting.config.en.rst b/doc/reference/configuration/hosting.config.en.rst
deleted file mode 100644
index 3052264..0000000
--- a/doc/reference/configuration/hosting.config.en.rst
+++ /dev/null
@@ -1,98 +0,0 @@
-.. 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.
-
-==============
-hosting.config
-==============
-
-.. configfile:: hosting.config
-
-The :file:`hosting.config` file (by default, located in
-``/usr/local/etc/trafficserver/``) you to assign cache volumes to
-specific origin servers and/or domains so that you can manage cache
-space efficiently and restrict disk usage. For step-by-step instructions
-on partitioning the cache according to origin servers and/or domains,
-refer to :ref:`partitioning-the-cache`.
-
-Before you can assign cache volumes to specific
-origin servers and/or domains, you must first partition your cache
-according to size and protocol in the :file:`volume.config`
-file.
-
-After you modify hosting.config, navigate to the Traffic Server bin
-directory and run :option:`traffic_ctl config reload` to apply your changes.
-
-When you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-.. important::
-
- The :file:`volume.config` configuration must be the same on all nodes in a cluster.
-
-Format
-======
-
-Each line in the :file:`hosting.config` file must have one of the following
-formats::
-
- hostname=HOST volume=NUMBERS
- domain=DOMAIN volume=NUMBERS
-
-where ``HOST`` is the fully-qualified hostname of the origin server
-whose content you want to store on a particular volume (for example,
-``www.myhost.com``); ``DOMAIN`` is the domain whose content you
-want to store on a particular partition(for example, ``mydomain.com``);
-and ``NUMBERS`` is a comma-separated list of the partitions on
-which you want to store the content that belongs to the origin server or
-domain listed. The partition numbers must be valid numbers listed in the
-file:`volume.config`.
-
-**Note:** To allocate more than one partition to an origin server or
-domain, you must enter the partitions in a comma-separated list on one
-line, as shown in the example below. The
-:file:`hosting.config` file cannot contain multiple entries
-for the same origin server or domain.
-
-Generic Partition
-=================
-
-When configuring the :file:`hosting.config` file, you must assign a generic
-volume to use for content that does not belong to any of the origin
-servers or domains listed. If all volumes for a particular origin
-server become corrupt, Traffic Server will also use the generic
-volume to store content for that origin server.
-
-The generic volume must have the following format::
-
- hostname=* volume=NUMBERS
-
-where ``NUMBERS`` is a comma-separated list of generic
-volumes.
-
-Examples
-========
-
-The following example configures Traffic Server to store content from
-the domain ``mydomain.com`` in volume 1 and content from
-``www.myhost.com`` in volume 2. Traffic Server stores content from
-all other origin servers in volumes 3 and 4.
-
-::
-
- domain=mydomain.com volume=1
- hostname=www.myhost.com volume=2
- hostname=* volume=3,4
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/icp.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/icp.config.en.rst b/doc/reference/configuration/icp.config.en.rst
deleted file mode 100644
index 24a5704..0000000
--- a/doc/reference/configuration/icp.config.en.rst
+++ /dev/null
@@ -1,99 +0,0 @@
-.. 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.
-
-==========
-icp.config
-==========
-
-.. configfile:: icp.config
-
-The :file:`icp.config` file defines ICP peers (parent and sibling caches).
-
-.. important::
-
- After you modify the icp.config file, navigate to the
- Traffic Server bin directory and run the :option:`traffic_ctl config reload` command to
- apply the changes. When you apply the changes to a node in a cluster,
- Traffic Server automatically applies the changes to all other nodes in
- the cluster.
-
-Format
-======
-
-Each line in the icp.config file contains the name and configuration
-information for a single ICP peer in the following format::
-
- host : host_IP : ctype : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
-
-Each field is described in the following list.
-
-``host``
- The hostname of the ICP peer.
-
- This field is optional; if you do not specify the hostname of the
- ICP peer, you must specify the IP address.
-
-``host_IP``
- The IP address of the ICP peer.
-
- This field is optional; if you do not specify the IP address of the
- ICP peer, you must specify the hostname.
-
-``ctype``
- Use the following options:
-
- - 1 to indicate an ICP parent cache
- - 2 to indicate an ICP sibling cache
- - 3 to indicate an ICP local cache
-
-``proxy_port``
- The port number of the TCP port used by the ICP peer for proxy
- communication.
-
-``icp_port``
- The port number of the UDP port used by the ICP peer for ICP
- communication.
-
-``MC_on``
- Enable or disable MultiCast:
-
- - 0 if multicast is disabled
- - 1 if multicast is enabled
-
-``MC_ip``
- The MultiCast IP address.
-
-``MC_ttl``
- The multicast time to live. Use the following options:
-
- - 1 if IP multicast datagrams will not be forwarded beyond a single
- subnetwork
- - 2 to allow delivery of IP multicast datagrams to more than one
- subnet (if there are one or more multicast routers attached to
- the first hop subnet).
-
-Examples
-========
-
-The following example configuration is for three nodes: the local host,
-one parent, and one sibling.
-
-::
-
- localhost:0.0.0.0:3:8080:3130:0:0.0.0.0:1
- host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1
- host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/index.en.rst b/doc/reference/configuration/index.en.rst
deleted file mode 100644
index 531511e..0000000
--- a/doc/reference/configuration/index.en.rst
+++ /dev/null
@@ -1,42 +0,0 @@
-
-.. _configuration-file-reference:
-
-Configuration File Reference
-****************************
-
-.. 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.
-
-
-.. toctree::
- :maxdepth: 2
-
- cache.config.en
- congestion.config.en
- hosting.config.en
- icp.config.en
- ip_allow.config.en
- log_hosts.config.en
- logs_xml.config.en
- parent.config.en
- plugin.config.en
- records.config.en
- remap.config.en
- splitdns.config.en
- ssl_multicert.config.en
- storage.config.en
- volume.config.en
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/ip_allow.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ip_allow.config.en.rst b/doc/reference/configuration/ip_allow.config.en.rst
deleted file mode 100644
index 9f9a4fc..0000000
--- a/doc/reference/configuration/ip_allow.config.en.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-.. 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.
-
-===============
-ip_allow.config
-===============
-
-.. configfile:: ip_allow.config
-
-The :file:`ip_allow.config` file controls client access to the Traffic
-Server proxy cache. You can specify ranges of IP addresses that are
-allowed to use the Traffic Server as a web proxy cache. After you modify
-the :file:`ip_allow.config` file, navigate to the Traffic Server bin
-directory and run the :option:`traffic_ctl config reload` command to apply changes. When
-you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`ip_allow.config` file must have the following
-format::
-
- src_ip=<range of IP addresses> action=<action> [method=<list of methods separated by '|'>]
-
-where src_ip is the IP address or range of IP addresses of the
-client(s). The action ``ip_allow`` enables the specified client(s) to
-access the Traffic Server proxy cache, and ``ip_deny`` denies the
-specified client(s) to access the Traffic Server proxy cache. Multiple
-method keywords can be specified (method=GET method=HEAD), or multiple
-methods can be separated by an '\|' (method=GET\|HEAD). The method
-keyword is optional and it is defaulted to ALL. This supports ANY string
-as the HTTP method, meaning no validation is done to check wether it
-is a valid HTTP method. This allows you to create filters for any method
-that your origin may require, this is especially useful if you use newer
-methods that aren't know to trafficserver (such as PROPFIND) or if your
-origin uses an http-ish protocol.
-
-By default, the :file:`ip_allow.config` file contains the following lines,
-which allows all methods to localhost to access the Traffic Server proxy
-cache and denies PUSH, PURGE and DELETE to all IPs (note this allows all
-other methods to all IPs)::
-
- src_ip=127.0.0.1 action=ip_allow method=ALL
- src_ip=::1 action=ip_allow method=ALL
- src_ip=0.0.0.0-255.255.255.255 action=ip_deny method=PUSH|PURGE|DELETE
- src_ip=::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff action=ip_deny method=PUSH|PURGE|DELETE
-
-Examples
-========
-
-The following example enables all clients to access the Traffic Server
-proxy cache::
-
- src_ip=0.0.0.0-255.255.255.255 action=ip_allow
-
-The following example allows all clients on a specific subnet to access
-the Traffic Server proxy cache::
-
- src_ip=123.12.3.000-123.12.3.123 action=ip_allow
-
-The following example denies all clients on a specific subnet to access
-the Traffic Server proxy cache::
-
- src_ip=123.45.6.0-123.45.6.123 action=ip_deny
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/log_hosts.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/log_hosts.config.en.rst b/doc/reference/configuration/log_hosts.config.en.rst
deleted file mode 100644
index 659030d..0000000
--- a/doc/reference/configuration/log_hosts.config.en.rst
+++ /dev/null
@@ -1,65 +0,0 @@
-.. 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.
-
-================
-log_hosts.config
-================
-
-.. configfile:: log_hosts.config
-
-To record HTTP transactions for different origin servers in separate log
-files, you must list each origin server hostname in the
-:file:`log_hosts.config` file. In addition, you must enable the :ref:`httphostlogsplitting` foo! ... <../working-log-files#HTTPHostLogSplitting>`_ option. You
-should use the same :file:`log_hosts.config` file on every Traffic Server
-node in your cluster. After you modify the :file:`log_hosts.config` file,
-run the :option:`traffic_ctl config reload` command to apply the changes.
-When you apply the changes to a node in a cluster, Traffic Server automatically applies the
-changes to all other nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`log_hosts.config` file has the following format::
-
- hostname
-
-where ``hostname`` is the hostname of the origin server.
-
-.. hint::
-
- You can specify keywords in the :file:`log_hosts.config` file to
- record all transactions from origin servers with the specified keyword
- in their names in a separate log file. See the example below.
-
-Examples
-========
-
-The following example configures Traffic Server to create separate log
-files containing all HTTP transactions for the origin servers
-``webserver1``, ``webserver2``, and ``webserver3``::
-
- webserver1
- webserver2
- webserver3
-
-The following example records all HTTP transactions from origin servers
-that contain ``sports`` in their names. For example:
-``sports.yahoo.com`` and ``www.foxsports.com`` in a log file called
-``squid-sport.log`` (the Squid format is enabled)::
-
- sports
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/logs_xml.config.en.rst b/doc/reference/configuration/logs_xml.config.en.rst
deleted file mode 100644
index c676f59..0000000
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ /dev/null
@@ -1,396 +0,0 @@
-.. 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.
-
-===============
-logs_xml.config
-===============
-
-.. configfile:: logs_xml.config
-
-The :file:`logs_xml.config` file defines the custom log file formats,
-filters, and processing options. The format of this file is modeled
-after XML, the Extensible Markup Language.
-
-Format
-======
-
-The :file:`logs_xml.config` file contains the specifications below:
-
-- ``LogFormat`` specifies the fields to be gathered from each protocol
- event access.
-- ``LogFilter`` specifies the filters that are used to include or
- exclude certain entries being logged based on the value of a field
- within that entry.
-- ``LogObject`` specifies an object that contains a particular format,
- a local filename, filters, and collation servers.
-
-The :file:`logs_xml.config` file ignores extra white space, blank lines, and
-all comments.
-
-.. _LogFormat:
-
-LogFormat
-=========
-
-The following list shows ``LogFormat`` specifications.
-
-.. _LogFormat-name:
-
-``<Name = "valid_format_name"/>``
- Required
- Valid format names include any name except ``squid``, ``common``,
- ``extended``, or ``extended2``, which are pre-defined formats. There
- is no default for this tag. The format object needs to be above the the LogObject object.
-
-.. _LogFormat-Format:
-
-``<Format = "valid_format_specification"/>``
- Required
- A valid format specification is a printf-style string describing
- each log entry when formatted for ASCII output.
-
- The printf-style could accept Oct/Hex escape representation:
-
- - ``\abc`` is Oct escape sequence, a,b,c should be one of [0-9], and
- (a*8^2 + b*8 + c) should be greater than 0 and less than 255.
- - ``\xab`` is Hex escape sequence, a,b should be one of [0-9, a-f, A-F],
- and (a*16 + b) should be greater than 0 and less than 255.
-
- Use ``%<`` ``field`` ``>`` as a placeholder for valid field names. For more
- information, refer to :ref:`custom-logging-fields`.
-
- The specified field can be one of the following types:
-
- Simple. For example: ``%<cqu>``
- A field within a container, such as an HTTP header or a statistic.
- Fields of this type have the syntax: ::
-
- %<{ field } container>
-
- Aggregates, such as ``COUNT``, ``SUM``, ``AVG``, ``FIRST``,
- ``LAST``. Fields of this type have the syntax: ``%<operator (``
- ``field`` ``)>``
-
-.. note::
-
- You cannot create a format specification that contains both aggregate operators and regular fields.
-
-``<Interval = "aggregate_interval_secs"/>``
- Optional
- Use this tag when the format contains aggregate operators. The value
- "``aggregate_interval_secs``\" represents the number of seconds
- between individual aggregate values being produced.
-
- The valid set of aggregate operators are:
-
- - COUNT
- - SUM
- - AVG
- - FIRST
- - LAST
-
-.. _LogFilter:
-
-LogFilter
-=========
-
-The following list shows the ``LogFilter`` specifications.
-
-``<Name = "valid_filter_name"/>``
- Required
- All filters must be uniquely named.
-
-``<Condition = "valid_log_field valid_operator valid_comparison_value"/>``
- Required
- This field contains the following elements:
-
- ``valid_log_field`` - the field that will be compared against
- the given value. For more information, refer to :ref:`logging-format-cross-reference`.
-
- ``valid_operator_field`` - any one of the following: ``MATCH``,
- ``CASE_INSENSITIVE_MATCH``, ``CONTAIN``,
- ``CASE_INSENSITIVE_CONTAIN``.
-
- - ``MATCH`` is true if the field and value are identical
- (case-sensitive).
- - ``CASE_INSENSITIVE_MATCH`` is similar to ``MATCH``, except that
- it is case-insensitive.
- - ``CONTAIN`` is true if the field contains the value (the value is
- a substring of the field).
- - ``CASE_INSENSITIVE_CONTAIN`` is a case-insensitive version of
- ``CONTAIN``.
-
- ``valid_comparison_value`` - any string or integer matching the
- field type. For integer values, all of the operators are equivalent
- and mean that the field must be equal to the specified value.
-
- For IP address fields, this can be a list of IP addresses and include ranges. A range is an IP address, followed by a
- dash '``-``', and then another IP address of the same family. For instance, the 10/8 network can be represented by
- ``10.0.0.0-10.255.255.255``. Currently network specifiers are not supported.
-
-.. note::
-
- There are no negative comparison operators. If you want to
- specify a negative condition, then use the ``Action`` field to
- ``REJECT`` the record.
-
-``<Action = "valid_action_field"/>``
- Required: ``ACCEPT`` or ``REJECT`` or ``WIPE_FIELD_VALUE``.
- ACCEPT or REJECT instructs Traffic Server to either accept or reject records
- that satisfy the filter condition. WIPE_FIELD_VALUE wipes out
- the values of the query params in the url fields specified in the Condition.
-
-NOTES: 1. WIPE_FIELD_VALUE action is only applied to the parameters in the query part.
- 2. Multiple parameters can be listed in a single WIPE_FIELD_VALUE filter
- 3. If the same parameter appears more than once in the query part , only
- the value of the first occurance is wiped
-
-.. _LogObject:
-
-LogObject
-=========
-
-The following list shows the ``LogObject`` specifications.
-
-``<Format = "valid_format_name"/>``
- Required
- Valid format names include the predefined logging formats:
- ``squid``, ``common``, ``extended``, and ``extended2``, as well as
- any previously-defined custom log formats. There is no default for
- this tag. The format object needs to be above the the LogObject object.
-
-``<Filename = "file_name"/>``
- Required
- The filename to which the given log file is written on the local
- file system or on a remote collation server. No local log file will
- be created if you fail to specify this tag. All filenames are
- relative to the default logging directory.
-
- If the name does not contain an extension (for example, ``squid``),
- then the extension ``.log`` is automatically appended to it for
- ASCII logs and ``.blog`` for binary logs (refer to :ref:`Mode =
- "valid_logging_mode" <LogObject-Mode>`).
-
- If you do not want an extension to be added, then end the filename
- with a single (.) dot (for example: ``squid.`` ).
-
-.. _LogObject-Mode:
-
-``<Mode = "valid_logging_mode"/>``
- Optional
- Valid logging modes include ``ascii`` , ``binary`` , and
- ``ascii_pipe`` . The default is ``ascii`` .
-
- - Use ``ascii`` to create event log files in human-readable form
- (plain ASCII).
- - Use ``binary`` to create event log files in binary format. Binary
- log files generate lower system overhead and occupy less space on
- the disk (depending on the information being logged). You must
- use the :program:`traffic_logcat` utility to translate binary log files to ASCII
- format before you can read them.
- - Use ``ascii_pipe`` to write log entries to a UNIX named pipe (a
- buffer in memory). Other processes can then read the data using
- standard I/O functions. The advantage of using this option is
- that Traffic Server does not have to write to disk, which frees
- disk space and bandwidth for other tasks. In addition, writing to
- a pipe does not stop when logging space is exhausted because the
- pipe does not use disk space.
-
- If you are using a collation server, then the log is written to a
- pipe on the collation server. A local pipe is created even before a
- transaction is processed, so you can see the pipe right after
- Traffic Server starts. Pipes on a collation server, however, *are*
- created when Traffic Server starts.
-
-``<Filters = "list_of_valid_filter_names"/>``
- Optional
- A comma-separated list of names of any previously-defined log
- filters. If more than one filter is specified, then all filters must
- accept a record for the record to be logged. The filters need
- to be above the LogObject object.
-
-``<Protocols = "list_of_valid_protocols"/>``
- Optional
- A comma-separated list of the protocols this object should log.
- Valid protocol names for this release are ``HTTP`` (FTP is
- deprecated).
-
-``<ServerHosts = "list_of_valid_servers"/>``
- Optional
- A comma-separated list of valid hostnames.This tag indicates that
- only entries from the named servers will be included in the file.
-
-.. _logs-xml-logobject-collationhost:
-
-``<CollationHosts = "list_of_valid_hostnames:port|failover hosts"/>``
- Optional
- A comma-separated list of collation servers (with pipe delimited
- failover servers) to which all log entries (for this object) are
- forwarded. Collation servers can be specified by name or IP address.
- Specify the collation port with a colon after the name. For example,
- in ``host1:5000|failhostA:5000|failhostB:6000, host2:6000`` logs
- would be sent to host1 and host2, with failhostA and failhostB
- acting as failover hosts for host1. When host1 disconnects,
- logs would be sent to failhostA. If failhostA disconnects, log
- entries would be sent to failhostB until host1 or failhostA comes
- back. Logs would also be sent to host2.
-
-``<Header = "header"/>``
- Optional
- The header text you want the log files to contain. The header text
- appears at the beginning of the log file, just before the first
- record.
-
-``<RollingEnabled = "truth value"/>``
- Optional
- Enables or disables log file rolling for the ``LogObject``. This
- setting overrides the value for the
- :ts:cv:`proxy.config.log.rolling_enabled` variable in the
- :file:`records.config` file. Set *truth value* to one of the
- following values:
-
- - ``0`` to disable rolling for this particular ``LogObject``.
- - ``1`` to roll log files at specific intervals during the day (you
- specify time intervals with the ``RollingIntervalSec`` and
- ``RollingOffsetHr`` fields).
- - ``2`` to roll log files when they reach a certain size (you
- specify the size with the ``RollingSizeMb`` field).
- - ``3`` to roll log files at specific intervals during the day or
- when they reach a certain size (whichever occurs first).
- - ``4`` to roll log files at specific intervals during the day when
- log files reach a specific size (at a specified time if the file
- is of the specified size).
-
-.. XXX this is confusing ^ really, why is it a "truth value" but then it's 5 different integer values that means varias strange things?
-
-``<RollingIntervalSec = "seconds"/>``
- Optional
- The seconds between log file rolling for the ``LogObject``; enables
- you to specify different rolling intervals for different
- ``LogObjects``.
-
- This setting overrides the value for
- :ts:cv:`proxy.config.log.rolling_interval_sec` in the
- :file:`records.config` file.
-
-``<RollingOffsetHr = "hour"/>``
- Optional
- Specifies an hour (from 0 to 23) at which rolling is guaranteed to
- align. Rolling might start before then, but a rolled file will be
- produced only at that time. The impact of this setting is only
- noticeable if the rolling interval is larger than one hour. This
- setting overrides the configuration setting for
- :ts:cv:`proxy.config.log.rolling_offset_hr` in the :file:`records.config`
- file.
-
-``<RollingSizeMb = "size_in_MB"/>``
- Optional
- The size at which log files are rolled.
-
-Examples
-========
-
-The following is an example of a ``LogFormat`` specification that
-collects information using three common fields: ::
-
- <LogFormat>
- <Name="minimal"/>
- <Format = "%<chi> : %<cqu> : %<pssc>"/>
- </LogFormat>
-
-The following is an example of a ``LogFormat`` specification that
-uses aggregate operators: ::
-
- <LogFormat>
- <Name = "summary"/>
- <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
- <Interval = "10"/>
- </LogFormat>
-
-The following is an example of a ``LogFilter`` that will cause only
-``REFRESH_HIT`` entries to be logged: ::
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "%<pssc> MATCH REFRESH_HIT"/>
- </LogFilter>
-
-.. note::
-
- When specifying the field in the filter condition, you can
- omit the ``%<>``. This means that the filter below is equivalent to the
- example directly above: ::
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "pssc MATCH REFRESH_HIT"/>
- </LogFilter>
-
-The following is an example of a ``LogFilter`` that will cause the value of
-passwd field be wiped in ``cquc`` ::
-
- <LogFilter>
- <Name = "wipe_password"/>
- <Condition = "cquc CONTAIN passwd"/>
- <Action = "WIPE_FIELD_VALUE"/>
- </LogFilter>
-
-The following is an example of a ``LogObject`` specification that
-creates a local log file for the minimal format defined earlier. The log
-filename will be ``minimal.log`` because this is an ASCII log file (the
-default).::
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- </LogObject>
-
-The following is an example of a ``LogObject`` specification that
-includes only HTTP requests served by hosts in the domain
-``company.com`` or by the specific server ``server.somewhere.com``. Log
-entries are sent to port 4000 of the collation host ``logs.company.com``
-and to port 5000 of the collation host ``209.131.52.129.`` ::
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- <ServerHosts = "company.com,server.somewhere.com"/>
- <Protocols = "http"/>
- <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
- </LogObject>
-
-.. _WELF:
-
-WELF
-====
-
-Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can
-analyze Traffic Server log files with WebTrends reporting tools. A
-predefined ``<LogFormat>`` that is compatible with WELF is provided in
-the :file:`logs_xml.config` file (shown below). To create a WELF format log
-file, create a ``<LogObject>`` that uses this predefined format. ::
-
- <LogFormat>
- <Name = "welf"/>
- <Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn> pri=6
- proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl>
- src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm>
- arg=\"%<cqup>\" result=%<pssc> ref=\"%<{Referer}cqh>\"
- agent=\"%<{user-agent}cqh>\" cache=%<crc>"/>
- </LogFormat>
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/parent.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/parent.config.en.rst b/doc/reference/configuration/parent.config.en.rst
deleted file mode 100644
index 9578713..0000000
--- a/doc/reference/configuration/parent.config.en.rst
+++ /dev/null
@@ -1,180 +0,0 @@
-.. 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.
-
-=============
-parent.config
-=============
-
-.. configfile:: parent.config
-
-The :file:`parent.config` file identifies the parent proxies used in an
-cache hierarchy. Use this file to perform the following configuration:
-
-- Set up parent cache hierarchies, with multiple parents and parent
- failover
-- Configure selected URL requests to bypass parent proxies
-
-Traffic Server uses the :file:`parent.config` file only when the parent
-caching option is enabled (refer to :ref:`configuring-traffic-server-to-use-a-parent-cache`).
-
-After you modify the :file:`parent.config` file, run the :option:`traffic_ctl config reload`
-command to apply your changes. When you apply the changes to one node in
-a cluster, Traffic Server automatically applies the changes to all other
-nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`parent.config` file must contain a parent caching
-rule. Traffic Server recognizes three space-delimited tags: ::
-
- primary_destination=value secondary_specifier=value action=value
-
-The following list shows the possible primary destinations and their
-allowed values.
-
-.. _parent-config-format-dest-domain:
-
-``dest_domain``
- A requested domain name, and its subdomains.
-
-.. _parent-config-format-dest-host:
-
-``dest_host``
- A requested hostname.
-
-.. _parent-config-format-dest-ip:
-
-``dest_ip``
- A requested IP address or range of IP addresses separated by a dash (-).
-
-.. _parent-config-format-url-regex:
-
-``url_regex``
- A regular expression (regex) to be found in a URL
-
-The secondary specifiers are optional in the :file:`parent.config` file. The
-following list shows the possible secondary specifiers and their allowed
-values.
-
-.. _parent-config-format-port:
-
-``port``
- A requested URL port.
-
-.. _parent-config-format-scheme:
-
-``scheme``
- A request URL protocol: ``http`` or ``https``.
-
-.. _parent-config-format-prefix:
-
-``prefix``
- A prefix in the path part of a URL.
-
-.. _parent-config-format-suffix:
-
-``suffix``
- A file suffix in the URL.
-
-.. _parent-config-format-method:
-
-``method``
- A request URL method. It can be one of the following:
-
- - get
- - post
- - put
- - trace
-
-.. _parent-config-format-time:
-
-``time``
- A time range, such as 08:00-14:00, during which the parent cache is
- used to serve requests.
-
-.. _parent-config-format-src-ip:
-
-``src_ip``
- A client IP address.
-
-.. _parent-config-format-internal:
-
-``internal``
- A boolean value, ``true`` or ``false``, specifying if the rule should
- match (or not match) a transaction originating from an internal API. This
- is useful to differentiate transaction originating from an ATS plugin.
-
-The following list shows the possible actions and their allowed values.
-
-.. _parent-config-format-parent:
-
-``parent``
- An ordered list of parent servers. If the request cannot be handled
- by the last parent server in the list, then it will be routed to the
- origin server. You can specify either a hostname or an IP address,
- but; you must specify the port number.
-
-.. _parent-config-format-round-robin:
-
-``round_robin``
- One of the following values:
-
- - ``true`` - Traffic Server goes through the parent cache list in a
- round robin-based on client IP address.
- - ``strict`` - Traffic Server machines serve requests strictly in
- turn. For example: machine ``proxy1`` serves the first request,
- ``proxy2`` serves the second request, and so on.
- - ``false`` - Round robin selection does not occur.
- - ``consistent_hash`` - consistent hash of the url so that one parent
- is chosen for a given url. If a parent is down, the traffic that
- would go to the down parent is rehashed amongst the remaining parents.
- The other traffic is unaffected. Once the downed parent becomes
- available, the traffic distribution returns to the pre-down
- state.
-
-.. _parent-config-format-go-direct:
-
-``go_direct``
- One of the following values:
-
- - ``true`` - requests bypass parent hierarchies and go directly to
- the origin server.
- - ``false`` - requests do not bypass parent hierarchies.
-
-Examples
-========
-
-The following rule configures a parent cache hierarchy consisting of
-Traffic Server (which is the child) and two parents, ``p1.x.com`` and
-``p2.x.com``. Traffic Server forwards the requests it cannot serve to
-the parent servers ``p1.x.com`` and ``p2.x.com`` in a round-robin
-fashion::
-
- round_robin=true
- dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
- round_robin=consistent_hash
- dest_domain=. method=get parent="p1.x.com:8080|1.0; p2.y.com:8080|2.0" round_robin=consistent_hash
-
-The following rule configures Traffic Server to route all requests
-containing the regular expression ``politics`` and the path
-``/viewpoint`` directly to the origin server (bypassing any parent
-hierarchies): ``url_regex=politics prefix=/viewpoint go_direct=true``
-
-Every line in the :file:`parent.config` file must contain either a
-``parent=`` or ``go_direct=`` directive.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ce162a6d/doc/reference/configuration/plugin.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/plugin.config.en.rst b/doc/reference/configuration/plugin.config.en.rst
deleted file mode 100644
index 2402da3..0000000
--- a/doc/reference/configuration/plugin.config.en.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-.. 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.
-
-=============
-plugin.config
-=============
-
-.. configfile:: plugin.config
-
-Description
-===========
-
-The :file:`plugin.config` file controls run-time loadable plugins
-available to the Traffic Server, as well as their configuration.
-Plugins listed in this file are referred to as `global plugins`
-because they are always loaded and have global effect. This is in
-contrast to plugins specified in :file:`remap.config`, whose effects
-are limited to the specific mapping rules they are applied to.
-
-Each configuration line consists of a path to an ``.so`` file. This
-path can either be absolute, or relative to the plugin directory
-(usually ``/usr/local/libexec/trafficserver``). Failure to load a
-plugin is fatal, and will cause Traffic Server to abort. In general,
-it is not possible to know whether it is safe for the service to
-run without a particular plugin, since plugins can have arbitrary
-effects on caching and authorization policies.
-
-Plugins should only be listed once. The order in which the plugins
-are listed is also the order in which they are chained for request
-processing.
-
-An option list of whitespace-separated arguments may follow the
-plugin name. These are passed as an argument vector to the plugin's
-initialization function, :c:func:`TSPluginInit`. Arguments that begin
-with the ``$`` character designate Traffic Server configuration
-variables. These arguments will be replaced with the value of the
-corresponding configuration variable before the plugin is loaded.
-When using configuration variable expansion, note that most Traffic
-Server configuration can be changed. If a plugin requires the current
-value, it must obtain that using the management API.
-
-Examples
-========
-
-::
-
- # Comments start with a '#' and continue to the end of the line
- # Blank lines are ignored
- #
- # test-plugin.so arg1 arg2 arg3
- #
- plugins/iwx/iwx.so
- plugins/abuse/abuse.so etc/trafficserver/abuse.config
- plugins/icx/icx.so etc/trafficserver/icx.config $proxy.config.http.connect_attempts_timeout
-
-See also
-========
-
-:manpage:`TSAPI(3ts)`,
-:manpage:`TSPluginInit(3ts)`,
-:manpage:`remap.config(5)`