You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@trafficserver.apache.org by ml...@apache.org on 2015/06/09 00:46:09 UTC

[1/6] trafficserver git commit: Document which configurations are overwritable

Repository: trafficserver
Updated Branches:
  refs/heads/master 9bb97769e -> dfb14525a


Document which configurations are overwritable


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2198745f
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2198745f
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2198745f

Branch: refs/heads/master
Commit: 2198745f15902832b8d110a2a4eefcd31901b3c3
Parents: f0a6575
Author: Miles Libbey <ml...@apache.org>
Authored: Tue Apr 7 10:03:49 2015 -0700
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:46 2015 -0700

----------------------------------------------------------------------
 doc/ext/traffic-server.py                       |  3 +
 .../configuration/records.config.en.rst         | 77 ++++++++++++++++++--
 2 files changed, 75 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/ext/traffic-server.py
----------------------------------------------------------------------
diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
index 4b2d9ec..30cb26c 100644
--- a/doc/ext/traffic-server.py
+++ b/doc/ext/traffic-server.py
@@ -49,6 +49,7 @@ class TSConfVar(std.Target):
         'class' : rst.directives.class_option,
         'reloadable' : rst.directives.flag,
         'deprecated' : rst.directives.flag,
+        'overwritable' : rst.directives.flag,
         'metric' : rst.directives.unchanged,
     }
     required_arguments = 3
@@ -117,6 +118,8 @@ class TSConfVar(std.Target):
             fl.append(self.make_field('Metric', self.options['metric']))
         if ('reloadable' in self.options):
             fl.append(self.make_field('Reloadable', 'Yes'))
+        if ('overwritable' in self.options):
+            fl.append(self.make_field('Overwritable', 'Yes'))
         if ('deprecated' in self.options):
             fl.append(self.make_field('Deprecated', 'Yes'))
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index 93b8f7b..e3e7579 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -53,6 +53,9 @@ A variable marked as ``Reloadable`` can be updated via the command::
 
    traffic_line -x
 
+A variable marked as ``Overwritable`` can be changed on a per-remap basis using plugins
+(like the :ref:`conf-remap-plugin`).
+
 ``INT`` type configurations are expressed as any normal integer,
 e.g. *32768*. They can also be expressed using more human readable values
 using standard prefixes, e.g. *32K*. The following prefixes are supported
@@ -140,7 +143,7 @@ System Variables
 
    The name of the product.
 
-.. ts:cv:: CONFIG proxy.config.proxy_name STRING ``build_machine``
+.. ts:cv:: CONFIG proxy.config.proxy_name STRING build_machine
    :reloadable:
 
    The name of the Traffic Server node.
@@ -389,6 +392,7 @@ this be local"
    Set the interface to use for cluster communications.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.cluster_cache_local INT 0
+   :overwritable:
 
    This turns on the local caching of objects in cluster mode. The point of
    this is to allow for popular or **hot** content to be cached on all nodes
@@ -627,6 +631,7 @@ Supports both wildcards ('\*') and ranges ("0-1023").
 
 .. ts:cv:: CONFIG proxy.config.http.insert_request_via_str INT 1
    :reloadable:
+   :overwritable:
 
    Set how the ``Via`` field is handled on a request to the origin server.
 
@@ -645,6 +650,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.insert_response_via_str INT 0
    :reloadable:
+   :overwritable:
 
    Set how the ``Via`` field is handled on the response to the client.
 
@@ -671,6 +677,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.response_server_enabled INT 1
    :reloadable:
+   :overwritable:
 
    You can specify one of the following:
 
@@ -680,6 +687,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.insert_age_in_response INT 1
    :reloadable:
+   :overwritable:
 
    This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
    estimate of the amount of time since the response was generated or revalidated by the origin server.
@@ -689,6 +697,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.response_server_str STRING ATS/
    :reloadable:
+   :overwritable:
 
    The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
    always appended to this string.
@@ -702,6 +711,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.chunking_enabled INT 1
    :reloadable:
+   :overwritable:
 
    Specifies whether Traffic Sever can generate a chunked response:
 
@@ -721,6 +731,7 @@ Value Effect
 
 .. ts:cv:: CONFIG proxy.config.http.send_http11_requests INT 1
    :reloadable:
+   :overwritable:
 
    Specifies when and how Traffic Sever uses HTTP/1.1 to communicate with the origin server
 
@@ -871,10 +882,12 @@ enabling it and then use identity URL mappings to re-disable it for
 specific domains.
 
 .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_in  INT 1
+   :overwritable:
 
    Enables (``1``) or disables (``0``) incoming keep-alive connections.
 
 .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_out  INT 1
+   :overwritable:
 
    Enables (``1``) or disables (``0``) outgoing keep-alive connections.
 
@@ -884,6 +897,7 @@ specific domains.
         :ts:cv:`proxy.config.http.server_max_connections`.
 
 .. ts:cv:: CONFIG proxy.config.http.keep_alive_post_out  INT 1
+   :overwritable:
 
    Controls wether new POST requests re-use keep-alive sessions (``1``) or
    create new connections per request (``0``).
@@ -936,6 +950,7 @@ Parent Proxy Configuration
 
 .. ts:cv:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
    :reloadable:
+   :overwritable:
 
    Configures Traffic Server to send proxy authentication headers on to the parent cache.
 
@@ -949,6 +964,7 @@ HTTP Connection Timeouts
 
 .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 115
    :reloadable:
+   :overwritable:
 
    Specifies how long Traffic Server keeps connections to clients open for a
    subsequent request after a transaction ends. A value of ``0`` will disable
@@ -956,6 +972,7 @@ HTTP Connection Timeouts
 
 .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 120
    :reloadable:
+   :overwritable:
 
    Specifies how long Traffic Server keeps connections to origin servers open
    for a subsequent transfer of data after a transaction ends. A value of
@@ -963,11 +980,13 @@ HTTP Connection Timeouts
 
 .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 30
    :reloadable:
+   :overwritable:
 
    Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
 
 .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 30
    :reloadable:
+   :overwritable:
 
    Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
 
@@ -981,6 +1000,7 @@ The value of ``0`` specifies that there is no timeout.
 
 .. ts:cv:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
    :reloadable:
+   :overwritable:
 
    The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
    complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
@@ -994,11 +1014,13 @@ The default value of ``0`` specifies that there is no timeout.
 
 .. ts:cv:: CONFIG proxy.config.http.background_fill_active_timeout INT 0
    :reloadable:
+   :overwritable:
 
    Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
 
 .. ts:cv:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.0
    :reloadable:
+   :overwritable:
 
    The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
    from the origin server to get it into the cache (a **background fill**).
@@ -1008,6 +1030,7 @@ Origin Server Connect Attempts
 
 .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
    :reloadable:
+   :overwritable:
 
    The maximum number of connection retries Traffic Server can make when the origin server is not responding.
    Each retry attempt lasts for `proxy.config.http.connect_attempts_timeout`_ seconds.  Once the maximum number of retries is
@@ -1016,6 +1039,7 @@ Origin Server Connect Attempts
 
 .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 3
    :reloadable:
+   :overwritable:
 
    Maximum number of connection retries Traffic Server can make while an origin is marked dead.  Typically this value is smaller than
    `proxy.config.http.connect_attempts_max_retries`_ so an error is returned to the client faster and also to reduce the load on the dead origin.
@@ -1033,6 +1057,7 @@ Origin Server Connect Attempts
 
 .. ts:cv:: CONFIG proxy.config.http.origin_max_connections INT 0
    :reloadable:
+   :overwritable:
 
    Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
 
@@ -1046,28 +1071,33 @@ Origin Server Connect Attempts
 
 .. ts:cv:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 3
    :reloadable:
+   :overwritable:
 
    The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server
    has round-robin DNS entries.
 
 .. ts:cv:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
    :reloadable:
+   :overwritable:
 
    The timeout value (in seconds) for **time to first byte** for an origin server connection.
 
 .. ts:cv:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
    :reloadable:
+   :overwritable:
 
    The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT``
    request.
 
 .. ts:cv:: CONFIG proxy.config.http.down_server.cache_time INT 300
    :reloadable:
+   :overwritable:
 
    Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
 
 .. ts:cv:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
    :reloadable:
+   :overwritable:
 
    The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request
    because the origin server was too slow in sending the response header.
@@ -1086,17 +1116,20 @@ Congestion Control
    congested origin server later. Refer to :ref:`using-congestion-control`.
 
 .. ts:cv:: CONFIG proxy.config.http.flow_control.enabled INT 0
+   :overwritable:
 
    Transaction buffering / flow control is enabled if this is set to a non-zero value. Otherwise no flow control is done.
 
 .. ts:cv:: CONFIG proxy.config.http.flow_control.high_water INT 0
    :metric: bytes
+   :overwritable:
 
    The high water mark for transaction buffer control. External source I/O is halted when the total buffer space in use
    by the transaction exceeds this value.
 
 .. ts:cv:: CONFIG proxy.config.http.flow_control.low_water INT 0
    :metric: bytes
+   :overwritable:
 
    The low water mark for transaction buffer control. External source I/O is resumed when the total buffer space in use
    by the transaction is no more than this value.
@@ -1106,6 +1139,7 @@ Negative Response Caching
 
 .. ts:cv:: CONFIG proxy.config.http.negative_caching_enabled INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does
    not exist. The next time a client requests the same page, Traffic Server serves the negative response directly from
@@ -1131,15 +1165,17 @@ Negative Response Caching
    :ts:cv:`proxy.config.http.negative_caching_lifetime`.
 
 .. ts:cv:: CONFIG proxy.config.http.negative_caching_lifetime INT 1800
+   :overwritable:
 
    How long (in seconds) Traffic Server keeps the negative responses  valid in cache. This value only affects negative
-   responses that do have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
+   responses that do NOT have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
 
 Proxy User Variables
 ====================
 
 .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_from INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
 
@@ -1150,21 +1186,25 @@ Proxy User Variables
 
 .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
 
 .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
 
 .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
 
 .. ts:cv:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
 
@@ -1175,11 +1215,13 @@ Proxy User Variables
 
 .. ts:cv:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 1
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
 
 .. ts:cv:: CONFIG proxy.config.http.normalize_ae_gzip INT 1
    :reloadable:
+   :overwritable:
 
    Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
 
@@ -1241,6 +1283,7 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.http INT 1
    :reloadable:
+   :overwritable:
 
    Enables (``1``) or disables (``0``) caching of HTTP requests.
 
@@ -1254,21 +1297,25 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 1
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 1
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 1
    :reloadable:
+   :overwritable:
 
    Specifies how cookies are cached:
 
@@ -1278,15 +1325,17 @@ Cache Control
    -  ``3`` = cache for all but text content-types
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
+   :overwritable:
 
    When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
    not cached.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
    :reloadable:
+   :overwritable:
 
-   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
-   mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
+   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in ``.asp`` or contain a question
+   mark (``?``), a semicolon (``;``), or ``cgi``. For a full list, please refer to
    `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
 
 .. ts:cv:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
@@ -1296,6 +1345,7 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
    :reloadable:
+   :overwritable:
 
    Specifies when to revalidate content:
 
@@ -1312,6 +1362,7 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.required_headers INT 2
    :reloadable:
+   :overwritable:
 
    The type of headers required in a request for the request to be cacheable.
 
@@ -1321,14 +1372,17 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
    :reloadable:
+   :overwritable:
 
    The maximum age allowed for a stale response before it cannot be cached.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.range.lookup INT 1
+   :overwritable:
 
    When enabled (``1``), Traffic Server looks up range requests in the cache.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.range.write INT 0
+   :overwritable:
 
    When enabled (``1``), Traffic Server will attempt to write (lock) the URL
    to cache. This is rarely useful (at the moment), since it'll only be able
@@ -1401,6 +1455,7 @@ Cache Control
 
 .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
    :reloadable:
+   :overwritable:
 
    When enabled (``1``), Traffic Server ignores any ``Cache-Control:
    max-age`` headers from the client. This technically violates the HTTP RFC,
@@ -1500,35 +1555,41 @@ Heuristic Expiration
 
 .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_min_lifetime INT 3600
    :reloadable:
+   :overwritable:
 
    The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
    considered to be stale.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_max_lifetime INT 86400
    :reloadable:
+   :overwritable:
 
    The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
    considered to be stale.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10
    :reloadable:
+   :overwritable:
 
    The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that
    elapsed since it last changed.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.time INT 240
    :reloadable:
+   :overwritable:
 
    How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval
    specified must be in seconds. See :ref:`fuzzy-revalidation`
 
 .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.005
    :reloadable:
+   :overwritable:
 
    The probability that a refresh is made on a document during the specified fuzz time.
 
 .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
    :reloadable:
+   :overwritable:
 
    Handles requests with a TTL less than fuzz.time – it allows for different times to evaluate the probability of revalidation for small TTLs and big TTLs. Objects with small TTLs will start "rolling the revalidation dice" near the fuzz.min_time, while objects with large TTLs would start at fuzz.time. A logarithmic like function between determines the revalidation evaluation start time (which will be between fuzz.min_time and fuzz.time). As the object gets closer to expiring, the window start becomes more likely. By default this setting is not enabled, but should be enabled anytime you have objects with small TTLs. The default value is ``0``.
 
@@ -1654,7 +1715,7 @@ hostname to ``host_x.y.com``.
 .. note::
 
    If the variable :ts:cv:`proxy.config.http.enable_url_expandomatic` is set to ``1`` (the default value), then you do not have to
-   add *``www.``* and *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values
+   add ``www.`` and ``.com`` to this list because Traffic Server automatically tries www. and .com after trying the values
    you've specified.
 
 .. ts:cv:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
@@ -2241,6 +2302,7 @@ URL Remap Rules
 
 .. ts:cv:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 0
    :reloadable:
+   :overwritable:
 
    Set this variable to ``1`` if you want to retain the client host
    header in a request during remapping.
@@ -2748,15 +2810,18 @@ Sockets
        keepalive options above.
 
 .. ts:cv:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
+   :overwritable:
 
    Sets the send buffer size for connections from Traffic Server to the origin server.
 
 .. ts:cv:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
+   :overwritable:
 
    Sets the receive buffer size for connections from Traffic Server to
    the origin server.
 
 .. ts:cv:: CONFIG proxy.config.net.sock_option_flag_out INT 0x1
+   :overwritable:
 
    Turns different options "on" for the origin server socket:::
 
@@ -2787,6 +2852,7 @@ Sockets
    .. seealso:: `Traffic Shaping`_
 
 .. ts:cv:: CONFIG proxy.config.net.sock_packet_mark_out INT 0x0
+   :overwritable:
 
    Set the packet mark on traffic destined for the origin
    (the packets that make up an origin request).
@@ -2801,6 +2867,7 @@ Sockets
    .. seealso:: `Traffic Shaping`_
 
 .. ts:cv:: CONFIG proxy.config.net.sock_packet_tos_out INT 0x0
+   :overwritable:
 
    Set the ToS/DiffServ Field on packets sent to the origin
    (the packets that make up an origin request).

[6/6] trafficserver git commit: Fix formatting to remove (failed) bold and italics

Posted by ml...@apache.org.

Fix formatting to remove (failed) bold and italics


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/afdfb419
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/afdfb419
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/afdfb419

Branch: refs/heads/master
Commit: afdfb4195a6e1acd4e2766af06966f15c1b8743b
Parents: 2198745
Author: Miles Libbey <ml...@apache.org>
Authored: Tue Apr 7 10:07:01 2015 -0700
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:47 2015 -0700

----------------------------------------------------------------------
 doc/admin/faqs.en.rst                           |   2 +-
 doc/arch/cache/cache-arch.en.rst                |   2 +-
 .../configuration/congestion.config.en.rst      |  36 ++---
 doc/reference/configuration/icp.config.en.rst   |  16 +--
 .../getting-started/naming-conventions.en.rst   |   4 +-
 doc/sdk/new-protocol-plugins.en.rst             | 138 +++++++++----------
 6 files changed, 99 insertions(+), 99 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/doc/admin/faqs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/faqs.en.rst b/doc/admin/faqs.en.rst
index d6dd259..a3a5aaa 100644
--- a/doc/admin/faqs.en.rst
+++ b/doc/admin/faqs.en.rst
@@ -377,7 +377,7 @@ Traffic Line commands do not execute under the following conditions:
 .. XXX: this is wrong
 
     You should always start and stop Traffic Server with the
-    :program:`trafficserver start`` and :program:`trafficserver stop` commands to ensure
+    :program:`trafficserver start` and :program:`trafficserver stop` commands to ensure
     that all the processes start and stop correctly. For more information,
     refer to :ref:`getting-started`.
 

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/doc/arch/cache/cache-arch.en.rst
----------------------------------------------------------------------
diff --git a/doc/arch/cache/cache-arch.en.rst b/doc/arch/cache/cache-arch.en.rst
index fecd0fb..b870a88 100644
--- a/doc/arch/cache/cache-arch.en.rst
+++ b/doc/arch/cache/cache-arch.en.rst
@@ -535,7 +535,7 @@ extraneous bytes.
 
 The computation of the approximate size of the fragment is defined as::
 
-  ( *size* + 1 ) * 2 ^ ( ``CACHE_BLOCK_SHIFT`` + 3 * *big* )
+  ( *size* + 1 ) * 2 ^ ( CACHE_BLOCK_SHIFT + 3 * *big* )
 
 Where ``CACHE_BLOCK_SHIFT`` is the bit width of the size of a basic cache
 block (9, corresponding to a sector size of 512). Therefore the value with

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/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
index 26b3d88..143c46f 100644
--- a/doc/reference/configuration/congestion.config.en.rst
+++ b/doc/reference/configuration/congestion.config.en.rst
@@ -55,16 +55,16 @@ file. Traffic Server recognizes three space-delimited tags::
 The following list shows possible primary destinations with allowed
 values.
 
-*``dest_domain``* {#dest_domain}
+``dest_domain``
     A requested domain name.
 
-*``dest_host``* {#dest_host}
+``dest_host``
     A requested hostname.
 
-*``dest_ip``* {#dest_ip}
+``dest_ip``
     A requested IP address.
 
-*``url_regex``* {#url_regex}
+``url_regex``
     A regular expression (regex) to be found in a URL.
 
 The secondary specifiers are optional in the congestion.config file. The
@@ -72,72 +72,72 @@ 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``* {#port}
+``port``
     A requested URL port or range of ports.
 
-*``prefix``* {#prefix}
+``prefix``
     A prefix in the path part of a URL.
 
 The following list shows the possible tags and their allowed values.
 
-*``max_connection_failures``* {#max_connection_failures}
+``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``* {#fail_window}
+``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``* {#proxy_retry_interval}
+``proxy_retry_interval``
     Default: ``10`` seconds.
     The number of seconds that Traffic Server waits before contacting a
     congested origin server again.
 
-*``client_wait_interval``* {#client_wait_interval}
+``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``* {#wait_interval_alpha}
+``wait_interval_alpha``
     Default: ``30`` seconds
     The upper limit for a random number that is added to the wait
     interval.
 
-*``live_os_conn_timeout``* {#live_os_conn_timeout}
+``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``* {#live_os_conn_retries}
+``live_os_conn_retries``
     Default: ``2``
     The maximum number of retries allowed to the live (uncongested)
     origin server.
 
-*``dead_os_conn_timeout``* {#dead_os_conn_timeout}
+``dead_os_conn_timeout``
     Default: ``15`` seconds.
     The connection timeout to the congested origin server.
 
-*``dead_os_conn_retries``* {#dead_os_conn_retries}
+``dead_os_conn_retries``
     Default: ``1``
     The maximum number of retries allowed to the congested origin
     server.
 
-*``max_connection``* {#max_connection}
+``max_connection``
     Default: ``-1``
     The maximum number of connections allowed from Traffic Server to the
     origin server.
 
-*``error_page``* {#error_page}
+``error_page``
     Default: ``"congestion#retryAfter"``
     The error page sent to the client when a server is congested. You
     must enclose the value in quotes;
 
-*:file:`congestion.config`* {#congestion_scheme}
+``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

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/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
index 94133ba..4757f37 100644
--- a/doc/reference/configuration/icp.config.en.rst
+++ b/doc/reference/configuration/icp.config.en.rst
@@ -41,42 +41,42 @@ information for a single ICP peer in the following format::
 
 Each field is described in the following list.
 
-*``host``* {#host}
+``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``* {#host_IP}
+``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``* {#ctype}
+``ctype``
     Use the following options:
 
     -  1 to indicate an ICP parent cache
     -  2 to indicate an ICP sibling cache
 
-*``proxy_port``* {#proxy_port}
+``proxy_port``
     The port number of the TCP port used by the ICP peer for proxy
     communication.
 
-*``icp_port``* {#icp_port}
+``icp_port``
     The port number of the UDP port used by the ICP peer for ICP
     communication.
 
-*``MC_on``* {#mc_on}
+``MC_on``
     Enable or disable MultiCast:
 
     -  0 if multicast is disabled
     -  1 if multicast is enabled
 
-*``MC_ip``* {#mc_ip}
+``MC_ip``
     The MultiCast IP address.
 
-*``MC_ttl``* {#mc_ttl}
+``MC_ttl``
     The multicast time to live. Use the following options:
 
     -  1 if IP multicast datagrams will not be forwarded beyond a single

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/doc/sdk/getting-started/naming-conventions.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/getting-started/naming-conventions.en.rst b/doc/sdk/getting-started/naming-conventions.en.rst
index 45794a2..04a3aa6 100644
--- a/doc/sdk/getting-started/naming-conventions.en.rst
+++ b/doc/sdk/getting-started/naming-conventions.en.rst
@@ -25,14 +25,14 @@ The Traffic Server API adheres to the following naming conventions:
    ``TS_EVENT_NONE``,\ ``TSMutex``, and ``TSContCreate``
 
 -  Enumerated values are always written in all uppercase letters.
-   **Examples**: *``TS_EVENT_NONE``* and *``TS_VC_CLOSE_ABORT``*
+   **Examples**: ``TS_EVENT_NONE`` and ``TS_VC_CLOSE_ABORT``
 
 -  Constant values are all uppercase; enumerated values can be seen as a
    subset of constants. **Examples**: ``TS_URL_SCHEME_FILE`` and
    ``TS_MIME_FIELD_ACCEPT``
 
 -  The names of defined types are mixed-case. **Examples**:
-   *``TSHttpSsn``* and *``TSHttpTxn``*
+   ``TSHttpSsn`` and ``TSHttpTxn``
 
 -  Function names are mixed-case. **Examples**: ``TSUrlCreate`` and
    ``TSContDestroy``

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/afdfb419/doc/sdk/new-protocol-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/new-protocol-plugins.en.rst b/doc/sdk/new-protocol-plugins.en.rst
index c0f7fc5..f7e281b 100644
--- a/doc/sdk/new-protocol-plugins.en.rst
+++ b/doc/sdk/new-protocol-plugins.en.rst
@@ -226,29 +226,29 @@ The steps below describe the flow of execution illustrated in :ref:`"How
 Transaction State Machines are Implemented in the Protocol
 Plugin" <ImplementTransStMachine>`.
 
-1. The handler for the TSM, (called **``main_handler``** in the Protocol
+1. The handler for the TSM, (called ``main_handler`` in the Protocol
    plugin) receives events from the TSM.
 
-2. **``main_handler``** examines the state of the transaction-in
+2. ``main_handler`` examines the state of the transaction-in
    particular, it examines the current handler.
 
-3. **``main_handler``** calls the **``current_handler``** (which is one
+3. ``main_handler`` calls the ``current_handler`` (which is one
    of the state handler functions), and then passes the current event to
-   **``current_handler``**. In :ref:`the image
+   ``current_handler``. In :ref:`the image
    below <ImplementTransStMachine>` below, the current handler is
-   called **``state2_handler``**.
+   called ``state2_handler``.
 
-4. The **``current_handler``** handles the event and updates the data.
+4. The ``current_handler`` handles the event and updates the data.
    In :ref:`the image below <ImplementTransStMachine>` below, the state is
-   changed from **``state2``** to **``state3``** (and the current
-   handler is changed from **``state2_handler``** to
-   **``state3_handler``**). The next time **``main_handler``** receives
-   an event, it will be processed by **``state3_handler``**.
+   changed from ``state2`` to ``state3`` (and the current
+   handler is changed from ``state2_handler`` to
+   ``state3_handler``). The next time ``main_handler`` receives
+   an event, it will be processed by ``state3_handler``.
 
-5. **``state2_handler``** arranges the next callback of the TSM.
+5. ``state2_handler`` arranges the next callback of the TSM.
    Typically, it gives Traffic Server additional work to do (such as
    writing a file to cache) so that it can progress to the next state.
-   The TSM (**``main_handler``**) then waits for the next event to
+   The TSM (``main_handler``) then waits for the next event to
    arrive from Traffic Server.
 
 **How Transaction State Machines are Implemented in the Protocol
@@ -280,93 +280,93 @@ typical transaction.
     two: a client accept port and a server port) and runs an
     initialization routine, ``init``.
 
-2.  The **``init``** function (in ``Protocol.c``) creates the plugin's
-    log file using **``TSTextLogObjectCreate``**.
+2.  The ``init`` function (in ``Protocol.c``) creates the plugin's
+    log file using ``TSTextLogObjectCreate``.
 
-3.  The **``init``** function creates the accept state machine using
-    **``AcceptCreate``**. The code for **``AcceptCreate``** is in the
+3.  The ``init`` function creates the accept state machine using
+    ``AcceptCreate``. The code for ``AcceptCreate`` is in the
     ``Accept.c`` file.
 
 4.  The accept state machine, like the transaction state machine, keeps
     track of its state with a data structure. This data structure,
-    **``Accept``**, is defined in the ``Accept.h`` file. State data in
-    **``AcceptCreate``** is associated with the new accept state machine
-    via **``TSContDataSet``**.
+    ``Accept``, is defined in the ``Accept.h`` file. State data in
+    ``AcceptCreate`` is associated with the new accept state machine
+    via ``TSContDataSet``.
 
-5.  The **``init``** function arranges the callback of the accept state
+5.  The ``init`` function arranges the callback of the accept state
     machine when there is a network connection by using
-    **``TSNetAccept``**.
+    ``TSNetAccept``.
 
-6.  The handler for the accept state machine is **``accept_event``** in
+6.  The handler for the accept state machine is ``accept_event`` in
     the ``Accept.c`` file. When Traffic Server's Net Processor sends
-    **``TS_EVENT_NET_ACCEPT``** to the accept state machine,
-    **``accept_event``** creates a transaction state machine
-    (**``txn_sm``**) by calling **``TxnSMCreate``**. Notice that
-    **``accept_event``** creates a mutex for the transaction state
+    ``TS_EVENT_NET_ACCEPT`` to the accept state machine,
+    ``accept_event`` creates a transaction state machine
+    (``txn_sm``) by calling ``TxnSMCreate``. Notice that
+    ``accept_event`` creates a mutex for the transaction state
     machine, since each transaction state machine has its own mutex.
 
-7.  The **``TxnSMCreate``** function is in the ``TxnSM.c`` file. The
+7.  The ``TxnSMCreate`` function is in the ``TxnSM.c`` file. The
     first thing it does is initialize the transaction's data, which is
     of type ``TxnSM`` (as defined in ``TxnSM.h``). Notice that the
-    current handler (**``q_current_handler``**) is set to
-    **``state_start``**.
+    current handler (``q_current_handler``) is set to
+    ``state_start``.
 
-8.  **``TxnSMCreate``** then creates a transaction state machine using
-    **``TSContCreate``**. The handler for the transaction state machine
-    is **``main_handler``**, which is in the ``TxnSM.c`` file.
+8.  ``TxnSMCreate`` then creates a transaction state machine using
+    ``TSContCreate``. The handler for the transaction state machine
+    is ``main_handler``, which is in the ``TxnSM.c`` file.
 
-9.  When **``accept_event``** receives **``TS_EVENT_NET_ACCEPT``**, it
+9.  When ``accept_event`` receives ``TS_EVENT_NET_ACCEPT``, it
     calls the transaction state machine (
-    **``TSContCall (txn_sm, 0, NULL);``** ). The event passed to
-    **``main_handler``** is ``0`` (**``TS_EVENT_NONE``**).
+    ``TSContCall (txn_sm, 0, NULL);`` ). The event passed to
+    ``main_handler`` is ``0`` (``TS_EVENT_NONE``).
 
-10. The first thing **``main_handler``** does is examine the current
-    **``txn_sm``** state by calling **``TSContDataGet``**. The state is
-    **``state_start``**.
+10. The first thing ``main_handler`` does is examine the current
+    ``txn_sm`` state by calling ``TSContDataGet``. The state is
+    ``state_start``.
 
-11. **``main_handler``** then invokes the handler for
-    **``state_start``** by using the function pointer
-    **``TxnSMHandler``** (as defined in ``TxnSM.h``).
+11. ``main_handler`` then invokes the handler for
+    ``state_start`` by using the function pointer
+    ``TxnSMHandler`` (as defined in ``TxnSM.h``).
 
-12. The **``state_start``** handler function (in the ``TxnSM.c`` file)
+12. The ``state_start`` handler function (in the ``TxnSM.c`` file)
     is handed an event (at this stage, the event is
-    **``TS_EVENT_NET_ACCEPT``**) and a client vconnection.
-    **``state_start``** checks to see if this client vconnection is
-    closed; if it is not, then **``state_start``** attempts to read data
-    from the client vconnection into an **``TSIOBuffer``**
-    (**``state_start``** is handling the event it receives).
-
-13. **``state_start``** changes the current handler to
-    **``state_interface_with_client``** (that is, it updates the state
+    ``TS_EVENT_NET_ACCEPT``) and a client vconnection.
+    ``state_start`` checks to see if this client vconnection is
+    closed; if it is not, then ``state_start`` attempts to read data
+    from the client vconnection into an ``TSIOBuffer``
+    (``state_start`` is handling the event it receives).
+
+13. ``state_start`` changes the current handler to
+    ``state_interface_with_client`` (that is, it updates the state
     of the transaction to the next state).
 
-14. **``state_start``** initiates a read of the client vconnection
+14. ``state_start`` initiates a read of the client vconnection
     (arranges for Traffic Server to send
-    **``TS_EVENT_VCONN_READ_READY``** events to the TSM) by calling
-    **``TSVConnRead``**.
+    ``TS_EVENT_VCONN_READ_READY`` events to the TSM) by calling
+    ``TSVConnRead``.
 
-15. **``state_interface_with_client``** is activated by the next event
+15. ``state_interface_with_client`` is activated by the next event
     from Traffic Server. It checks for errors and examines the read VIO
-    for the read operation initiated by **``TSVConnRead``**.
+    for the read operation initiated by ``TSVConnRead``.
 
-16. If the read VIO is the **``client_read_VIO``** (which we are
+16. If the read VIO is the ``client_read_VIO`` (which we are
     expecting at this stage in the transaction), then
-    **``state_interface_with_client``** updates the state to
-    **``state_read_request_from_client``** .
+    ``state_interface_with_client`` updates the state to
+    ``state_read_request_from_client`` .
 
-17. **``state_read_request_from_client``** handles actual
-    **``TS_EVENT_READ_READY``** events and reads the client request.
+17. ``state_read_request_from_client`` handles actual
+    ``TS_EVENT_READ_READY`` events and reads the client request.
 
-18. **``state_read_request_from_client``** parses the client request.
+18. ``state_read_request_from_client`` parses the client request.
 
-19. **``state_read_request_from_client``** updates the current state to
-    the next state, **``state_handle_cache_lookup``** .
+19. ``state_read_request_from_client`` updates the current state to
+    the next state, ``state_handle_cache_lookup`` .
 
-20. **``state_read_request_from_client``** arranges for Traffic Server
+20. ``state_read_request_from_client`` arranges for Traffic Server
     to call back the TSM with the next set of events (initiating the
-    cache lookup) by calling **``TSCacheRead``**.
+    cache lookup) by calling ``TSCacheRead``.
 
-21. When the **``TSCacheRead``** sends the TSM either
-    **``TS_EVENT_OPEN_READ``** (a cache hit) or
-    **``TS_EVENT_OPEN_READ_FAILED``** (a cache miss),
-    **``main_handler``** calls **``state_handle_cache_lookup``**.
+21. When the ``TSCacheRead`` sends the TSM either
+    ``TS_EVENT_OPEN_READ`` (a cache hit) or
+    ``TS_EVENT_OPEN_READ_FAILED`` (a cache miss),
+    ``main_handler`` calls ``state_handle_cache_lookup``.

[5/6] trafficserver git commit: ordering explanation for log objects

Posted by ml...@apache.org.

ordering explanation for log objects


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/dfb14525
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/dfb14525
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/dfb14525

Branch: refs/heads/master
Commit: dfb14525ab5f0c1717e7571c037330ad6c2461b2
Parents: 9002499
Author: Miles Libbey <ml...@apache.org>
Authored: Mon Jun 8 15:37:43 2015 -0700
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:47 2015 -0700

----------------------------------------------------------------------
 doc/reference/configuration/logs_xml.config.en.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/dfb14525/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
index 78ce361..c676f59 100644
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -54,7 +54,7 @@ The following list shows ``LogFormat`` specifications.
     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.
+    is no default for this tag. The format object needs to be above the the LogObject object.
 
 .. _LogFormat-Format:

[2/6] trafficserver git commit: missing backtick for formatting

Posted by ml...@apache.org.

missing backtick for formatting


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/f0a6575b
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/f0a6575b
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/f0a6575b

Branch: refs/heads/master
Commit: f0a6575b736edde33a30487cf1490efa4536b7c3
Parents: 9bb9776
Author: Miles Libbey <ml...@apache.org>
Authored: Wed Mar 11 21:43:05 2015 -0700
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:46 2015 -0700

----------------------------------------------------------------------
 doc/reference/configuration/records.config.en.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/f0a6575b/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
index ccced34..93b8f7b 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -1332,7 +1332,7 @@ Cache Control
 
    When enabled (``1``), Traffic Server will attempt to write (lock) the URL
    to cache. This is rarely useful (at the moment), since it'll only be able
-   to write to cache if the origin has ignored the ``Range:` header. For a use
+   to write to cache if the origin has ignored the ``Range:`` header. For a use
    case where you know the origin will respond with a full (``200``) response,
    you can turn this on to allow it to be cached.

[3/6] trafficserver git commit: Describe parent consistent hash; custom log behavior

Posted by ml...@apache.org.

Describe parent consistent hash; custom log behavior


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/6047a8d6
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/6047a8d6
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/6047a8d6

Branch: refs/heads/master
Commit: 6047a8d6bf59ab83cfae4c69dc1f6ca9997010a2
Parents: afdfb41
Author: Miles Libbey <ml...@apache.org>
Authored: Fri Apr 17 18:13:21 2015 -0500
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:47 2015 -0700

----------------------------------------------------------------------
 doc/reference/configuration/logs_xml.config.en.rst | 5 +++--
 doc/reference/configuration/parent.config.en.rst   | 7 ++++++-
 2 files changed, 9 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6047a8d6/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
index 0dd1a37..78ce361 100644
--- a/doc/reference/configuration/logs_xml.config.en.rst
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -171,7 +171,7 @@ The following list shows the ``LogObject`` specifications.
     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.
+    this tag. The format object needs to be above the the LogObject object.
 
 ``<Filename = "file_name"/>``
     Required
@@ -220,7 +220,8 @@ The following list shows the ``LogObject`` specifications.
     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.
+    accept a record for the record to be logged. The filters need
+    to be above the LogObject object.
 
 ``<Protocols = "list_of_valid_protocols"/>``
     Optional

http://git-wip-us.apache.org/repos/asf/trafficserver/blob/6047a8d6/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
index c0ec0b4..91905d0 100644
--- a/doc/reference/configuration/parent.config.en.rst
+++ b/doc/reference/configuration/parent.config.en.rst
@@ -140,7 +140,12 @@ The following list shows the possible actions and their allowed values.
        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.
+    -  ``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:

[4/6] trafficserver git commit: Describe consistent hash parent selection feature

Posted by ml...@apache.org.

Describe consistent hash parent selection feature


Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/90024998
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/90024998
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/90024998

Branch: refs/heads/master
Commit: 90024998b1b48c260d2cec520926fbff2d4939a6
Parents: 6047a8d
Author: Miles Libbey <ml...@apache.org>
Authored: Mon Jun 8 15:29:36 2015 -0700
Committer: Miles Libbey <ml...@apache.org>
Committed: Mon Jun 8 15:44:47 2015 -0700

----------------------------------------------------------------------
 doc/reference/configuration/parent.config.en.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/90024998/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
index 91905d0..83668cb 100644
--- a/doc/reference/configuration/parent.config.en.rst
+++ b/doc/reference/configuration/parent.config.en.rst
@@ -140,11 +140,11 @@ The following list shows the possible actions and their allowed values.
        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 
+    -  ``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 
+       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:

Re: [1/6] trafficserver git commit: Document which configurations are overwritable

Posted by Miles Libbey <ml...@apache.org>.

yes -- thanks! Fixed. 


     On Monday, June 8, 2015 4:07 PM, James Peach <jp...@apache.org> wrote:
   

 Do you mean "overridable"? TSHttpOverridableConfig().


> On Jun 8, 2015, at 3:46 PM, mlibbey@apache.org wrote:
> 
> Repository: trafficserver
> Updated Branches:
>  refs/heads/master 9bb97769e -> dfb14525a
> 
> 
> Document which configurations are overwritable
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
> Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2198745f
> Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2198745f
> Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2198745f
> 
> Branch: refs/heads/master
> Commit: 2198745f15902832b8d110a2a4eefcd31901b3c3
> Parents: f0a6575
> Author: Miles Libbey <ml...@apache.org>
> Authored: Tue Apr 7 10:03:49 2015 -0700
> Committer: Miles Libbey <ml...@apache.org>
> Committed: Mon Jun 8 15:44:46 2015 -0700
> 
> ----------------------------------------------------------------------
> doc/ext/traffic-server.py                      |  3 +
> .../configuration/records.config.en.rst        | 77 ++++++++++++++++++--
> 2 files changed, 75 insertions(+), 5 deletions(-)
> ----------------------------------------------------------------------
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/ext/traffic-server.py
> ----------------------------------------------------------------------
> diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
> index 4b2d9ec..30cb26c 100644
> --- a/doc/ext/traffic-server.py
> +++ b/doc/ext/traffic-server.py
> @@ -49,6 +49,7 @@ class TSConfVar(std.Target):
>        'class' : rst.directives.class_option,
>        'reloadable' : rst.directives.flag,
>        'deprecated' : rst.directives.flag,
> +        'overwritable' : rst.directives.flag,
>        'metric' : rst.directives.unchanged,
>    }
>    required_arguments = 3
> @@ -117,6 +118,8 @@ class TSConfVar(std.Target):
>            fl.append(self.make_field('Metric', self.options['metric']))
>        if ('reloadable' in self.options):
>            fl.append(self.make_field('Reloadable', 'Yes'))
> +        if ('overwritable' in self.options):
> +            fl.append(self.make_field('Overwritable', 'Yes'))
>        if ('deprecated' in self.options):
>            fl.append(self.make_field('Deprecated', 'Yes'))
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/reference/configuration/records.config.en.rst
> ----------------------------------------------------------------------
> diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
> index 93b8f7b..e3e7579 100644
> --- a/doc/reference/configuration/records.config.en.rst
> +++ b/doc/reference/configuration/records.config.en.rst
> @@ -53,6 +53,9 @@ A variable marked as ``Reloadable`` can be updated via the command::
> 
>    traffic_line -x
> 
> +A variable marked as ``Overwritable`` can be changed on a per-remap basis using plugins
> +(like the :ref:`conf-remap-plugin`).
> +
> ``INT`` type configurations are expressed as any normal integer,
> e.g. *32768*. They can also be expressed using more human readable values
> using standard prefixes, e.g. *32K*. The following prefixes are supported
> @@ -140,7 +143,7 @@ System Variables
> 
>    The name of the product.
> 
> -.. ts:cv:: CONFIG proxy.config.proxy_name STRING ``build_machine``
> +.. ts:cv:: CONFIG proxy.config.proxy_name STRING build_machine
>    :reloadable:
> 
>    The name of the Traffic Server node.
> @@ -389,6 +392,7 @@ this be local"
>    Set the interface to use for cluster communications.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cluster_cache_local INT 0
> +  :overwritable:
> 
>    This turns on the local caching of objects in cluster mode. The point of
>    this is to allow for popular or **hot** content to be cached on all nodes
> @@ -627,6 +631,7 @@ Supports both wildcards ('\*') and ranges ("0-1023").
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_request_via_str INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Set how the ``Via`` field is handled on a request to the origin server.
> 
> @@ -645,6 +650,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_response_via_str INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Set how the ``Via`` field is handled on the response to the client.
> 
> @@ -671,6 +677,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_enabled INT 1
>    :reloadable:
> +  :overwritable:
> 
>    You can specify one of the following:
> 
> @@ -680,6 +687,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_age_in_response INT 1
>    :reloadable:
> +  :overwritable:
> 
>    This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
>    estimate of the amount of time since the response was generated or revalidated by the origin server.
> @@ -689,6 +697,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_str STRING ATS/
>    :reloadable:
> +  :overwritable:
> 
>    The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
>    always appended to this string.
> @@ -702,6 +711,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.chunking_enabled INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Specifies whether Traffic Sever can generate a chunked response:
> 
> @@ -721,6 +731,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.send_http11_requests INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Specifies when and how Traffic Sever uses HTTP/1.1 to communicate with the origin server
> 
> @@ -871,10 +882,12 @@ enabling it and then use identity URL mappings to re-disable it for
> specific domains.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_in  INT 1
> +  :overwritable:
> 
>    Enables (``1``) or disables (``0``) incoming keep-alive connections.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_out  INT 1
> +  :overwritable:
> 
>    Enables (``1``) or disables (``0``) outgoing keep-alive connections.
> 
> @@ -884,6 +897,7 @@ specific domains.
>        :ts:cv:`proxy.config.http.server_max_connections`.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_post_out  INT 1
> +  :overwritable:
> 
>    Controls wether new POST requests re-use keep-alive sessions (``1``) or
>    create new connections per request (``0``).
> @@ -936,6 +950,7 @@ Parent Proxy Configuration
> 
> .. ts:cv:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Configures Traffic Server to send proxy authentication headers on to the parent cache.
> 
> @@ -949,6 +964,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 115
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open for a
>    subsequent request after a transaction ends. A value of ``0`` will disable
> @@ -956,6 +972,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 120
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open
>    for a subsequent transfer of data after a transaction ends. A value of
> @@ -963,11 +980,13 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 30
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 30
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
> 
> @@ -981,6 +1000,7 @@ The value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
>    :reloadable:
> +  :overwritable:
> 
>    The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
>    complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
> @@ -994,11 +1014,13 @@ The default value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_active_timeout INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.0
>    :reloadable:
> +  :overwritable:
> 
>    The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
>    from the origin server to get it into the cache (a **background fill**).
> @@ -1008,6 +1030,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
>    :reloadable:
> +  :overwritable:
> 
>    The maximum number of connection retries Traffic Server can make when the origin server is not responding.
>    Each retry attempt lasts for `proxy.config.http.connect_attempts_timeout`_ seconds.  Once the maximum number of retries is
> @@ -1016,6 +1039,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 3
>    :reloadable:
> +  :overwritable:
> 
>    Maximum number of connection retries Traffic Server can make while an origin is marked dead.  Typically this value is smaller than
>    `proxy.config.http.connect_attempts_max_retries`_ so an error is returned to the client faster and also to reduce the load on the dead origin.
> @@ -1033,6 +1057,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.origin_max_connections INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
> 
> @@ -1046,28 +1071,33 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 3
>    :reloadable:
> +  :overwritable:
> 
>    The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server
>    has round-robin DNS entries.
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
>    :reloadable:
> +  :overwritable:
> 
>    The timeout value (in seconds) for **time to first byte** for an origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
>    :reloadable:
> +  :overwritable:
> 
>    The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT``
>    request.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.cache_time INT 300
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
>    :reloadable:
> +  :overwritable:
> 
>    The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request
>    because the origin server was too slow in sending the response header.
> @@ -1086,17 +1116,20 @@ Congestion Control
>    congested origin server later. Refer to :ref:`using-congestion-control`.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.enabled INT 0
> +  :overwritable:
> 
>    Transaction buffering / flow control is enabled if this is set to a non-zero value. Otherwise no flow control is done.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.high_water INT 0
>    :metric: bytes
> +  :overwritable:
> 
>    The high water mark for transaction buffer control. External source I/O is halted when the total buffer space in use
>    by the transaction exceeds this value.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.low_water INT 0
>    :metric: bytes
> +  :overwritable:
> 
>    The low water mark for transaction buffer control. External source I/O is resumed when the total buffer space in use
>    by the transaction is no more than this value.
> @@ -1106,6 +1139,7 @@ Negative Response Caching
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_enabled INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does
>    not exist. The next time a client requests the same page, Traffic Server serves the negative response directly from
> @@ -1131,15 +1165,17 @@ Negative Response Caching
>    :ts:cv:`proxy.config.http.negative_caching_lifetime`.
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_lifetime INT 1800
> +  :overwritable:
> 
>    How long (in seconds) Traffic Server keeps the negative responses  valid in cache. This value only affects negative
> -  responses that do have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> +  responses that do NOT have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> 
> Proxy User Variables
> ====================
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_from INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
> 
> @@ -1150,21 +1186,25 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
> 
> @@ -1175,11 +1215,13 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 1
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.normalize_ae_gzip INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
> 
> @@ -1241,6 +1283,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.http INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Enables (``1``) or disables (``0``) caching of HTTP requests.
> 
> @@ -1254,21 +1297,25 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 1
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 1
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 1
>    :reloadable:
> +  :overwritable:
> 
>    Specifies how cookies are cached:
> 
> @@ -1278,15 +1325,17 @@ Cache Control
>    -  ``3`` = cache for all but text content-types
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
>    not cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
>    :reloadable:
> +  :overwritable:
> 
> -  Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
> -  mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
> +  Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in ``.asp`` or contain a question
> +  mark (``?``), a semicolon (``;``), or ``cgi``. For a full list, please refer to
>    `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
> @@ -1296,6 +1345,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Specifies when to revalidate content:
> 
> @@ -1312,6 +1362,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.required_headers INT 2
>    :reloadable:
> +  :overwritable:
> 
>    The type of headers required in a request for the request to be cacheable.
> 
> @@ -1321,14 +1372,17 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
>    :reloadable:
> +  :overwritable:
> 
>    The maximum age allowed for a stale response before it cannot be cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.lookup INT 1
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server looks up range requests in the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.write INT 0
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server will attempt to write (lock) the URL
>    to cache. This is rarely useful (at the moment), since it'll only be able
> @@ -1401,6 +1455,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
>    :reloadable:
> +  :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores any ``Cache-Control:
>    max-age`` headers from the client. This technically violates the HTTP RFC,
> @@ -1500,35 +1555,41 @@ Heuristic Expiration
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_min_lifetime INT 3600
>    :reloadable:
> +  :overwritable:
> 
>    The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_max_lifetime INT 86400
>    :reloadable:
> +  :overwritable:
> 
>    The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10
>    :reloadable:
> +  :overwritable:
> 
>    The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that
>    elapsed since it last changed.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.time INT 240
>    :reloadable:
> +  :overwritable:
> 
>    How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval
>    specified must be in seconds. See :ref:`fuzzy-revalidation`
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.005
>    :reloadable:
> +  :overwritable:
> 
>    The probability that a refresh is made on a document during the specified fuzz time.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Handles requests with a TTL less than fuzz.time – it allows for different times to evaluate the probability of revalidation for small TTLs and big TTLs. Objects with small TTLs will start "rolling the revalidation dice" near the fuzz.min_time, while objects with large TTLs would start at fuzz.time. A logarithmic like function between determines the revalidation evaluation start time (which will be between fuzz.min_time and fuzz.time). As the object gets closer to expiring, the window start becomes more likely. By default this setting is not enabled, but should be enabled anytime you have objects with small TTLs. The default value is ``0``.
> 
> @@ -1654,7 +1715,7 @@ hostname to ``host_x.y.com``.
> .. note::
> 
>    If the variable :ts:cv:`proxy.config.http.enable_url_expandomatic` is set to ``1`` (the default value), then you do not have to
> -  add *``www.``* and *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values
> +  add ``www.`` and ``.com`` to this list because Traffic Server automatically tries www. and .com after trying the values
>    you've specified.
> 
> .. ts:cv:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
> @@ -2241,6 +2302,7 @@ URL Remap Rules
> 
> .. ts:cv:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 0
>    :reloadable:
> +  :overwritable:
> 
>    Set this variable to ``1`` if you want to retain the client host
>    header in a request during remapping.
> @@ -2748,15 +2810,18 @@ Sockets
>        keepalive options above.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
> +  :overwritable:
> 
>    Sets the send buffer size for connections from Traffic Server to the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
> +  :overwritable:
> 
>    Sets the receive buffer size for connections from Traffic Server to
>    the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_option_flag_out INT 0x1
> +  :overwritable:
> 
>    Turns different options "on" for the origin server socket:::
> 
> @@ -2787,6 +2852,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_mark_out INT 0x0
> +  :overwritable:
> 
>    Set the packet mark on traffic destined for the origin
>    (the packets that make up an origin request).
> @@ -2801,6 +2867,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_tos_out INT 0x0
> +  :overwritable:
> 
>    Set the ToS/DiffServ Field on packets sent to the origin
>    (the packets that make up an origin request).
>

Re: [1/6] trafficserver git commit: Document which configurations are overwritable

Posted by James Peach <jp...@apache.org>.

Do you mean "overridable"? TSHttpOverridableConfig().


> On Jun 8, 2015, at 3:46 PM, mlibbey@apache.org wrote:
> 
> Repository: trafficserver
> Updated Branches:
>  refs/heads/master 9bb97769e -> dfb14525a
> 
> 
> Document which configurations are overwritable
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
> Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2198745f
> Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2198745f
> Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2198745f
> 
> Branch: refs/heads/master
> Commit: 2198745f15902832b8d110a2a4eefcd31901b3c3
> Parents: f0a6575
> Author: Miles Libbey <ml...@apache.org>
> Authored: Tue Apr 7 10:03:49 2015 -0700
> Committer: Miles Libbey <ml...@apache.org>
> Committed: Mon Jun 8 15:44:46 2015 -0700
> 
> ----------------------------------------------------------------------
> doc/ext/traffic-server.py                       |  3 +
> .../configuration/records.config.en.rst         | 77 ++++++++++++++++++--
> 2 files changed, 75 insertions(+), 5 deletions(-)
> ----------------------------------------------------------------------
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/ext/traffic-server.py
> ----------------------------------------------------------------------
> diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
> index 4b2d9ec..30cb26c 100644
> --- a/doc/ext/traffic-server.py
> +++ b/doc/ext/traffic-server.py
> @@ -49,6 +49,7 @@ class TSConfVar(std.Target):
>         'class' : rst.directives.class_option,
>         'reloadable' : rst.directives.flag,
>         'deprecated' : rst.directives.flag,
> +        'overwritable' : rst.directives.flag,
>         'metric' : rst.directives.unchanged,
>     }
>     required_arguments = 3
> @@ -117,6 +118,8 @@ class TSConfVar(std.Target):
>             fl.append(self.make_field('Metric', self.options['metric']))
>         if ('reloadable' in self.options):
>             fl.append(self.make_field('Reloadable', 'Yes'))
> +        if ('overwritable' in self.options):
> +            fl.append(self.make_field('Overwritable', 'Yes'))
>         if ('deprecated' in self.options):
>             fl.append(self.make_field('Deprecated', 'Yes'))
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/reference/configuration/records.config.en.rst
> ----------------------------------------------------------------------
> diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
> index 93b8f7b..e3e7579 100644
> --- a/doc/reference/configuration/records.config.en.rst
> +++ b/doc/reference/configuration/records.config.en.rst
> @@ -53,6 +53,9 @@ A variable marked as ``Reloadable`` can be updated via the command::
> 
>    traffic_line -x
> 
> +A variable marked as ``Overwritable`` can be changed on a per-remap basis using plugins
> +(like the :ref:`conf-remap-plugin`).
> +
> ``INT`` type configurations are expressed as any normal integer,
> e.g. *32768*. They can also be expressed using more human readable values
> using standard prefixes, e.g. *32K*. The following prefixes are supported
> @@ -140,7 +143,7 @@ System Variables
> 
>    The name of the product.
> 
> -.. ts:cv:: CONFIG proxy.config.proxy_name STRING ``build_machine``
> +.. ts:cv:: CONFIG proxy.config.proxy_name STRING build_machine
>    :reloadable:
> 
>    The name of the Traffic Server node.
> @@ -389,6 +392,7 @@ this be local"
>    Set the interface to use for cluster communications.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cluster_cache_local INT 0
> +   :overwritable:
> 
>    This turns on the local caching of objects in cluster mode. The point of
>    this is to allow for popular or **hot** content to be cached on all nodes
> @@ -627,6 +631,7 @@ Supports both wildcards ('\*') and ranges ("0-1023").
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_request_via_str INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Set how the ``Via`` field is handled on a request to the origin server.
> 
> @@ -645,6 +650,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_response_via_str INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Set how the ``Via`` field is handled on the response to the client.
> 
> @@ -671,6 +677,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_enabled INT 1
>    :reloadable:
> +   :overwritable:
> 
>    You can specify one of the following:
> 
> @@ -680,6 +687,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_age_in_response INT 1
>    :reloadable:
> +   :overwritable:
> 
>    This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
>    estimate of the amount of time since the response was generated or revalidated by the origin server.
> @@ -689,6 +697,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_str STRING ATS/
>    :reloadable:
> +   :overwritable:
> 
>    The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
>    always appended to this string.
> @@ -702,6 +711,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.chunking_enabled INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies whether Traffic Sever can generate a chunked response:
> 
> @@ -721,6 +731,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.send_http11_requests INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies when and how Traffic Sever uses HTTP/1.1 to communicate with the origin server
> 
> @@ -871,10 +882,12 @@ enabling it and then use identity URL mappings to re-disable it for
> specific domains.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_in  INT 1
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) incoming keep-alive connections.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_out  INT 1
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) outgoing keep-alive connections.
> 
> @@ -884,6 +897,7 @@ specific domains.
>         :ts:cv:`proxy.config.http.server_max_connections`.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_post_out  INT 1
> +   :overwritable:
> 
>    Controls wether new POST requests re-use keep-alive sessions (``1``) or
>    create new connections per request (``0``).
> @@ -936,6 +950,7 @@ Parent Proxy Configuration
> 
> .. ts:cv:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Configures Traffic Server to send proxy authentication headers on to the parent cache.
> 
> @@ -949,6 +964,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 115
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open for a
>    subsequent request after a transaction ends. A value of ``0`` will disable
> @@ -956,6 +972,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 120
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open
>    for a subsequent transfer of data after a transaction ends. A value of
> @@ -963,11 +980,13 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 30
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 30
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
> 
> @@ -981,6 +1000,7 @@ The value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
>    :reloadable:
> +   :overwritable:
> 
>    The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
>    complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
> @@ -994,11 +1014,13 @@ The default value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_active_timeout INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.0
>    :reloadable:
> +   :overwritable:
> 
>    The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
>    from the origin server to get it into the cache (a **background fill**).
> @@ -1008,6 +1030,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
>    :reloadable:
> +   :overwritable:
> 
>    The maximum number of connection retries Traffic Server can make when the origin server is not responding.
>    Each retry attempt lasts for `proxy.config.http.connect_attempts_timeout`_ seconds.  Once the maximum number of retries is
> @@ -1016,6 +1039,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 3
>    :reloadable:
> +   :overwritable:
> 
>    Maximum number of connection retries Traffic Server can make while an origin is marked dead.  Typically this value is smaller than
>    `proxy.config.http.connect_attempts_max_retries`_ so an error is returned to the client faster and also to reduce the load on the dead origin.
> @@ -1033,6 +1057,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.origin_max_connections INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
> 
> @@ -1046,28 +1071,33 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 3
>    :reloadable:
> +   :overwritable:
> 
>    The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server
>    has round-robin DNS entries.
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
>    :reloadable:
> +   :overwritable:
> 
>    The timeout value (in seconds) for **time to first byte** for an origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
>    :reloadable:
> +   :overwritable:
> 
>    The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT``
>    request.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.cache_time INT 300
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
>    :reloadable:
> +   :overwritable:
> 
>    The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request
>    because the origin server was too slow in sending the response header.
> @@ -1086,17 +1116,20 @@ Congestion Control
>    congested origin server later. Refer to :ref:`using-congestion-control`.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.enabled INT 0
> +   :overwritable:
> 
>    Transaction buffering / flow control is enabled if this is set to a non-zero value. Otherwise no flow control is done.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.high_water INT 0
>    :metric: bytes
> +   :overwritable:
> 
>    The high water mark for transaction buffer control. External source I/O is halted when the total buffer space in use
>    by the transaction exceeds this value.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.low_water INT 0
>    :metric: bytes
> +   :overwritable:
> 
>    The low water mark for transaction buffer control. External source I/O is resumed when the total buffer space in use
>    by the transaction is no more than this value.
> @@ -1106,6 +1139,7 @@ Negative Response Caching
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_enabled INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does
>    not exist. The next time a client requests the same page, Traffic Server serves the negative response directly from
> @@ -1131,15 +1165,17 @@ Negative Response Caching
>    :ts:cv:`proxy.config.http.negative_caching_lifetime`.
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_lifetime INT 1800
> +   :overwritable:
> 
>    How long (in seconds) Traffic Server keeps the negative responses  valid in cache. This value only affects negative
> -   responses that do have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> +   responses that do NOT have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> 
> Proxy User Variables
> ====================
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_from INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
> 
> @@ -1150,21 +1186,25 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
> 
> @@ -1175,11 +1215,13 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.normalize_ae_gzip INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
> 
> @@ -1241,6 +1283,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.http INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) caching of HTTP requests.
> 
> @@ -1254,21 +1297,25 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how cookies are cached:
> 
> @@ -1278,15 +1325,17 @@ Cache Control
>    -  ``3`` = cache for all but text content-types
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
>    not cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
>    :reloadable:
> +   :overwritable:
> 
> -   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
> -   mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
> +   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in ``.asp`` or contain a question
> +   mark (``?``), a semicolon (``;``), or ``cgi``. For a full list, please refer to
>    `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
> @@ -1296,6 +1345,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Specifies when to revalidate content:
> 
> @@ -1312,6 +1362,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.required_headers INT 2
>    :reloadable:
> +   :overwritable:
> 
>    The type of headers required in a request for the request to be cacheable.
> 
> @@ -1321,14 +1372,17 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
>    :reloadable:
> +   :overwritable:
> 
>    The maximum age allowed for a stale response before it cannot be cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.lookup INT 1
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server looks up range requests in the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.write INT 0
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server will attempt to write (lock) the URL
>    to cache. This is rarely useful (at the moment), since it'll only be able
> @@ -1401,6 +1455,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores any ``Cache-Control:
>    max-age`` headers from the client. This technically violates the HTTP RFC,
> @@ -1500,35 +1555,41 @@ Heuristic Expiration
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_min_lifetime INT 3600
>    :reloadable:
> +   :overwritable:
> 
>    The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_max_lifetime INT 86400
>    :reloadable:
> +   :overwritable:
> 
>    The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10
>    :reloadable:
> +   :overwritable:
> 
>    The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that
>    elapsed since it last changed.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.time INT 240
>    :reloadable:
> +   :overwritable:
> 
>    How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval
>    specified must be in seconds. See :ref:`fuzzy-revalidation`
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.005
>    :reloadable:
> +   :overwritable:
> 
>    The probability that a refresh is made on a document during the specified fuzz time.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Handles requests with a TTL less than fuzz.time – it allows for different times to evaluate the probability of revalidation for small TTLs and big TTLs. Objects with small TTLs will start "rolling the revalidation dice" near the fuzz.min_time, while objects with large TTLs would start at fuzz.time. A logarithmic like function between determines the revalidation evaluation start time (which will be between fuzz.min_time and fuzz.time). As the object gets closer to expiring, the window start becomes more likely. By default this setting is not enabled, but should be enabled anytime you have objects with small TTLs. The default value is ``0``.
> 
> @@ -1654,7 +1715,7 @@ hostname to ``host_x.y.com``.
> .. note::
> 
>    If the variable :ts:cv:`proxy.config.http.enable_url_expandomatic` is set to ``1`` (the default value), then you do not have to
> -   add *``www.``* and *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values
> +   add ``www.`` and ``.com`` to this list because Traffic Server automatically tries www. and .com after trying the values
>    you've specified.
> 
> .. ts:cv:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
> @@ -2241,6 +2302,7 @@ URL Remap Rules
> 
> .. ts:cv:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Set this variable to ``1`` if you want to retain the client host
>    header in a request during remapping.
> @@ -2748,15 +2810,18 @@ Sockets
>        keepalive options above.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
> +   :overwritable:
> 
>    Sets the send buffer size for connections from Traffic Server to the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
> +   :overwritable:
> 
>    Sets the receive buffer size for connections from Traffic Server to
>    the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_option_flag_out INT 0x1
> +   :overwritable:
> 
>    Turns different options "on" for the origin server socket:::
> 
> @@ -2787,6 +2852,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_mark_out INT 0x0
> +   :overwritable:
> 
>    Set the packet mark on traffic destined for the origin
>    (the packets that make up an origin request).
> @@ -2801,6 +2867,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_tos_out INT 0x0
> +   :overwritable:
> 
>    Set the ToS/DiffServ Field on packets sent to the origin
>    (the packets that make up an origin request).
>

Re: [1/6] trafficserver git commit: Document which configurations are overwritable

Posted by James Peach <jp...@apache.org>.

Do you mean "overridable"? TSHttpOverridableConfig().


> On Jun 8, 2015, at 3:46 PM, mlibbey@apache.org wrote:
> 
> Repository: trafficserver
> Updated Branches:
>  refs/heads/master 9bb97769e -> dfb14525a
> 
> 
> Document which configurations are overwritable
> 
> 
> Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
> Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/2198745f
> Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/2198745f
> Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/2198745f
> 
> Branch: refs/heads/master
> Commit: 2198745f15902832b8d110a2a4eefcd31901b3c3
> Parents: f0a6575
> Author: Miles Libbey <ml...@apache.org>
> Authored: Tue Apr 7 10:03:49 2015 -0700
> Committer: Miles Libbey <ml...@apache.org>
> Committed: Mon Jun 8 15:44:46 2015 -0700
> 
> ----------------------------------------------------------------------
> doc/ext/traffic-server.py                       |  3 +
> .../configuration/records.config.en.rst         | 77 ++++++++++++++++++--
> 2 files changed, 75 insertions(+), 5 deletions(-)
> ----------------------------------------------------------------------
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/ext/traffic-server.py
> ----------------------------------------------------------------------
> diff --git a/doc/ext/traffic-server.py b/doc/ext/traffic-server.py
> index 4b2d9ec..30cb26c 100644
> --- a/doc/ext/traffic-server.py
> +++ b/doc/ext/traffic-server.py
> @@ -49,6 +49,7 @@ class TSConfVar(std.Target):
>         'class' : rst.directives.class_option,
>         'reloadable' : rst.directives.flag,
>         'deprecated' : rst.directives.flag,
> +        'overwritable' : rst.directives.flag,
>         'metric' : rst.directives.unchanged,
>     }
>     required_arguments = 3
> @@ -117,6 +118,8 @@ class TSConfVar(std.Target):
>             fl.append(self.make_field('Metric', self.options['metric']))
>         if ('reloadable' in self.options):
>             fl.append(self.make_field('Reloadable', 'Yes'))
> +        if ('overwritable' in self.options):
> +            fl.append(self.make_field('Overwritable', 'Yes'))
>         if ('deprecated' in self.options):
>             fl.append(self.make_field('Deprecated', 'Yes'))
> 
> 
> http://git-wip-us.apache.org/repos/asf/trafficserver/blob/2198745f/doc/reference/configuration/records.config.en.rst
> ----------------------------------------------------------------------
> diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
> index 93b8f7b..e3e7579 100644
> --- a/doc/reference/configuration/records.config.en.rst
> +++ b/doc/reference/configuration/records.config.en.rst
> @@ -53,6 +53,9 @@ A variable marked as ``Reloadable`` can be updated via the command::
> 
>    traffic_line -x
> 
> +A variable marked as ``Overwritable`` can be changed on a per-remap basis using plugins
> +(like the :ref:`conf-remap-plugin`).
> +
> ``INT`` type configurations are expressed as any normal integer,
> e.g. *32768*. They can also be expressed using more human readable values
> using standard prefixes, e.g. *32K*. The following prefixes are supported
> @@ -140,7 +143,7 @@ System Variables
> 
>    The name of the product.
> 
> -.. ts:cv:: CONFIG proxy.config.proxy_name STRING ``build_machine``
> +.. ts:cv:: CONFIG proxy.config.proxy_name STRING build_machine
>    :reloadable:
> 
>    The name of the Traffic Server node.
> @@ -389,6 +392,7 @@ this be local"
>    Set the interface to use for cluster communications.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cluster_cache_local INT 0
> +   :overwritable:
> 
>    This turns on the local caching of objects in cluster mode. The point of
>    this is to allow for popular or **hot** content to be cached on all nodes
> @@ -627,6 +631,7 @@ Supports both wildcards ('\*') and ranges ("0-1023").
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_request_via_str INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Set how the ``Via`` field is handled on a request to the origin server.
> 
> @@ -645,6 +650,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_response_via_str INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Set how the ``Via`` field is handled on the response to the client.
> 
> @@ -671,6 +677,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_enabled INT 1
>    :reloadable:
> +   :overwritable:
> 
>    You can specify one of the following:
> 
> @@ -680,6 +687,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_age_in_response INT 1
>    :reloadable:
> +   :overwritable:
> 
>    This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
>    estimate of the amount of time since the response was generated or revalidated by the origin server.
> @@ -689,6 +697,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.response_server_str STRING ATS/
>    :reloadable:
> +   :overwritable:
> 
>    The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
>    always appended to this string.
> @@ -702,6 +711,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.chunking_enabled INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies whether Traffic Sever can generate a chunked response:
> 
> @@ -721,6 +731,7 @@ Value Effect
> 
> .. ts:cv:: CONFIG proxy.config.http.send_http11_requests INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies when and how Traffic Sever uses HTTP/1.1 to communicate with the origin server
> 
> @@ -871,10 +882,12 @@ enabling it and then use identity URL mappings to re-disable it for
> specific domains.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_in  INT 1
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) incoming keep-alive connections.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_enabled_out  INT 1
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) outgoing keep-alive connections.
> 
> @@ -884,6 +897,7 @@ specific domains.
>         :ts:cv:`proxy.config.http.server_max_connections`.
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_post_out  INT 1
> +   :overwritable:
> 
>    Controls wether new POST requests re-use keep-alive sessions (``1``) or
>    create new connections per request (``0``).
> @@ -936,6 +950,7 @@ Parent Proxy Configuration
> 
> .. ts:cv:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Configures Traffic Server to send proxy authentication headers on to the parent cache.
> 
> @@ -949,6 +964,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 115
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open for a
>    subsequent request after a transaction ends. A value of ``0`` will disable
> @@ -956,6 +972,7 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 120
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open
>    for a subsequent transfer of data after a transaction ends. A value of
> @@ -963,11 +980,13 @@ HTTP Connection Timeouts
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 30
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 30
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
> 
> @@ -981,6 +1000,7 @@ The value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
>    :reloadable:
> +   :overwritable:
> 
>    The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
>    complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
> @@ -994,11 +1014,13 @@ The default value of ``0`` specifies that there is no timeout.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_active_timeout INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.0
>    :reloadable:
> +   :overwritable:
> 
>    The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
>    from the origin server to get it into the cache (a **background fill**).
> @@ -1008,6 +1030,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
>    :reloadable:
> +   :overwritable:
> 
>    The maximum number of connection retries Traffic Server can make when the origin server is not responding.
>    Each retry attempt lasts for `proxy.config.http.connect_attempts_timeout`_ seconds.  Once the maximum number of retries is
> @@ -1016,6 +1039,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 3
>    :reloadable:
> +   :overwritable:
> 
>    Maximum number of connection retries Traffic Server can make while an origin is marked dead.  Typically this value is smaller than
>    `proxy.config.http.connect_attempts_max_retries`_ so an error is returned to the client faster and also to reduce the load on the dead origin.
> @@ -1033,6 +1057,7 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.origin_max_connections INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
> 
> @@ -1046,28 +1071,33 @@ Origin Server Connect Attempts
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 3
>    :reloadable:
> +   :overwritable:
> 
>    The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server
>    has round-robin DNS entries.
> 
> .. ts:cv:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
>    :reloadable:
> +   :overwritable:
> 
>    The timeout value (in seconds) for **time to first byte** for an origin server connection.
> 
> .. ts:cv:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
>    :reloadable:
> +   :overwritable:
> 
>    The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT``
>    request.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.cache_time INT 300
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
> 
> .. ts:cv:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
>    :reloadable:
> +   :overwritable:
> 
>    The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request
>    because the origin server was too slow in sending the response header.
> @@ -1086,17 +1116,20 @@ Congestion Control
>    congested origin server later. Refer to :ref:`using-congestion-control`.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.enabled INT 0
> +   :overwritable:
> 
>    Transaction buffering / flow control is enabled if this is set to a non-zero value. Otherwise no flow control is done.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.high_water INT 0
>    :metric: bytes
> +   :overwritable:
> 
>    The high water mark for transaction buffer control. External source I/O is halted when the total buffer space in use
>    by the transaction exceeds this value.
> 
> .. ts:cv:: CONFIG proxy.config.http.flow_control.low_water INT 0
>    :metric: bytes
> +   :overwritable:
> 
>    The low water mark for transaction buffer control. External source I/O is resumed when the total buffer space in use
>    by the transaction is no more than this value.
> @@ -1106,6 +1139,7 @@ Negative Response Caching
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_enabled INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does
>    not exist. The next time a client requests the same page, Traffic Server serves the negative response directly from
> @@ -1131,15 +1165,17 @@ Negative Response Caching
>    :ts:cv:`proxy.config.http.negative_caching_lifetime`.
> 
> .. ts:cv:: CONFIG proxy.config.http.negative_caching_lifetime INT 1800
> +   :overwritable:
> 
>    How long (in seconds) Traffic Server keeps the negative responses  valid in cache. This value only affects negative
> -   responses that do have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> +   responses that do NOT have explicit ``Expires:`` or ``Cache-Control:`` lifetimes set by the server.
> 
> Proxy User Variables
> ====================
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_from INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
> 
> @@ -1150,21 +1186,25 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
> 
> .. ts:cv:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
> 
> @@ -1175,11 +1215,13 @@ Proxy User Variables
> 
> .. ts:cv:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.normalize_ae_gzip INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
> 
> @@ -1241,6 +1283,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.http INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Enables (``1``) or disables (``0``) caching of HTTP requests.
> 
> @@ -1254,21 +1297,25 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 1
>    :reloadable:
> +   :overwritable:
> 
>    Specifies how cookies are cached:
> 
> @@ -1278,15 +1325,17 @@ Cache Control
>    -  ``3`` = cache for all but text content-types
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
>    not cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
>    :reloadable:
> +   :overwritable:
> 
> -   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
> -   mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
> +   Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in ``.asp`` or contain a question
> +   mark (``?``), a semicolon (``;``), or ``cgi``. For a full list, please refer to
>    `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
> @@ -1296,6 +1345,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Specifies when to revalidate content:
> 
> @@ -1312,6 +1362,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.required_headers INT 2
>    :reloadable:
> +   :overwritable:
> 
>    The type of headers required in a request for the request to be cacheable.
> 
> @@ -1321,14 +1372,17 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
>    :reloadable:
> +   :overwritable:
> 
>    The maximum age allowed for a stale response before it cannot be cached.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.lookup INT 1
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server looks up range requests in the cache.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.range.write INT 0
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server will attempt to write (lock) the URL
>    to cache. This is rarely useful (at the moment), since it'll only be able
> @@ -1401,6 +1455,7 @@ Cache Control
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
>    :reloadable:
> +   :overwritable:
> 
>    When enabled (``1``), Traffic Server ignores any ``Cache-Control:
>    max-age`` headers from the client. This technically violates the HTTP RFC,
> @@ -1500,35 +1555,41 @@ Heuristic Expiration
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_min_lifetime INT 3600
>    :reloadable:
> +   :overwritable:
> 
>    The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_max_lifetime INT 86400
>    :reloadable:
> +   :overwritable:
> 
>    The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is
>    considered to be stale.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10
>    :reloadable:
> +   :overwritable:
> 
>    The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that
>    elapsed since it last changed.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.time INT 240
>    :reloadable:
> +   :overwritable:
> 
>    How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval
>    specified must be in seconds. See :ref:`fuzzy-revalidation`
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.005
>    :reloadable:
> +   :overwritable:
> 
>    The probability that a refresh is made on a document during the specified fuzz time.
> 
> .. ts:cv:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Handles requests with a TTL less than fuzz.time – it allows for different times to evaluate the probability of revalidation for small TTLs and big TTLs. Objects with small TTLs will start "rolling the revalidation dice" near the fuzz.min_time, while objects with large TTLs would start at fuzz.time. A logarithmic like function between determines the revalidation evaluation start time (which will be between fuzz.min_time and fuzz.time). As the object gets closer to expiring, the window start becomes more likely. By default this setting is not enabled, but should be enabled anytime you have objects with small TTLs. The default value is ``0``.
> 
> @@ -1654,7 +1715,7 @@ hostname to ``host_x.y.com``.
> .. note::
> 
>    If the variable :ts:cv:`proxy.config.http.enable_url_expandomatic` is set to ``1`` (the default value), then you do not have to
> -   add *``www.``* and *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values
> +   add ``www.`` and ``.com`` to this list because Traffic Server automatically tries www. and .com after trying the values
>    you've specified.
> 
> .. ts:cv:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
> @@ -2241,6 +2302,7 @@ URL Remap Rules
> 
> .. ts:cv:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 0
>    :reloadable:
> +   :overwritable:
> 
>    Set this variable to ``1`` if you want to retain the client host
>    header in a request during remapping.
> @@ -2748,15 +2810,18 @@ Sockets
>        keepalive options above.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
> +   :overwritable:
> 
>    Sets the send buffer size for connections from Traffic Server to the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
> +   :overwritable:
> 
>    Sets the receive buffer size for connections from Traffic Server to
>    the origin server.
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_option_flag_out INT 0x1
> +   :overwritable:
> 
>    Turns different options "on" for the origin server socket:::
> 
> @@ -2787,6 +2852,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_mark_out INT 0x0
> +   :overwritable:
> 
>    Set the packet mark on traffic destined for the origin
>    (the packets that make up an origin request).
> @@ -2801,6 +2867,7 @@ Sockets
>    .. seealso:: `Traffic Shaping`_
> 
> .. ts:cv:: CONFIG proxy.config.net.sock_packet_tos_out INT 0x0
> +   :overwritable:
> 
>    Set the ToS/DiffServ Field on packets sent to the origin
>    (the packets that make up an origin request).
>