git commit: TS-2189 Document proxy.config.http.cache.cluster_cache_local.

[zw...@apache.org]

Updated Branches:
  refs/heads/master 898d0a558 -> cfc86f1ea


TS-2189 Document proxy.config.http.cache.cluster_cache_local.

This is confusing for sure, in that it's actually an alternative to
controlling local caching via records.config. The intent, as far as I can
tell, is that you'd use this as an overridable configuration.


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

Branch: refs/heads/master
Commit: cfc86f1eab0e95b25bc57be7d47720d23e42f6c3
Parents: 898d0a5
Author: Leif Hedstrom <zw...@apache.org>
Authored: Sat Oct 12 10:42:00 2013 -0600
Committer: Leif Hedstrom <zw...@apache.org>
Committed: Sat Oct 12 10:42:00 2013 -0600

----------------------------------------------------------------------
 .../configuration/records.config.en.rst          | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/trafficserver/blob/cfc86f1e/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 7d7c149..ea329e2 100644
--- a/doc/reference/configuration/records.config.en.rst
+++ b/doc/reference/configuration/records.config.en.rst
@@ -301,6 +301,25 @@ Value Effect
 
    Set the interface to use for cluster communications.
 
+.. ts:cv:: CONFIG proxy.config.http.cache.cluster_cache_local INT 0
+
+   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
+   in a cluster. Be aware that the primary way to configure this behavior is
+   via the :file:`cache.config` configuration file using
+   ``action=cluster-cache-local`` directives.
+
+   This particular :file:`records.config` configuration can be controlled per
+   transaction or per remap rule. As such, it augments the
+   :file:`cache.config` directives, since you can turn on the local caching
+   feature without complex regular expression matching.
+
+   This implies that turning this on in your global :file:`records.config` is
+   almost never what you want; instead, you want to use this either via
+   e.g. ``conf_remap.so`` overrides for a certain remap rule, or through a
+   custom plugin using the appropriate APIs.
+
+
 Local Manager
 =============