You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by dg...@apache.org on 2019/01/30 20:13:37 UTC

[trafficcontrol] branch 3.0.x updated: Cache url deprecation (#3282)

This is an automated email from the ASF dual-hosted git repository.

dgelinas pushed a commit to branch 3.0.x
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git


The following commit(s) were added to refs/heads/3.0.x by this push:
     new ddd56f8  Cache url deprecation (#3282)
ddd56f8 is described below

commit ddd56f823c14537ae036e50bc01a6bc757268ee7
Author: Jonathan G <jh...@users.noreply.github.com>
AuthorDate: Wed Jan 30 13:13:31 2019 -0700

    Cache url deprecation (#3282)
    
    * Add deprecation notice for CacheURL DS Field
    
    This is the precursor to #3225.
    
    * Add deprecation notice for CacheURL to API Documentation
    
    This is a precursor to work being performed on #3225
---
 CHANGELOG.md                            |  1 +
 docs/source/admin/traffic_ops/using.rst |  4 +++-
 docs/source/api/v12/deliveryservice.rst | 14 +++++++-------
 docs/source/api/v12/server.rst          |  2 +-
 docs/source/api/v12/user.rst            |  2 +-
 5 files changed, 13 insertions(+), 10 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index fab981b..7a0f176 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -19,6 +19,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Traffic Monitor Client Update: Traffic Monitor is updated to use the Traffic Ops v13 client.
 - Removed previously deprecated `traffic_monitor_java`
 - Added `infrastructure/cdn-in-a-box` for Apachecon 2018 demonstration
+- The CacheURL Delivery service field is deprecated.  If you still need this functionality, you can create the configuration explicitly via the raw remap field.
 
 ## [2.2.0] - 2018-06-07
 ### Added
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index ca075e3..af40b1f 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -441,7 +441,9 @@ The fields in the Delivery Service view are:
 |                                            |                                                                                                                                                                        |
 |                                            | **Note:** you will not be able to save a Regex Remap Expression if you have Query String Handling set to drop query strings at the edge. See :ref:`regex-remap`.       |
 +--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Cache URL expression                       | Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share |
+| Cache URL expression                       | Deprecated.                                                                                                                                                            |
+|                                            |                                                                                                                                                                        |
+|                                            | Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share |
 |                                            | a cache key, can also be used to preserve cached content if service origin is changed.                                                                                 |
 |                                            |                                                                                                                                                                        |
 |                                            | **Note:** Only valid in ATS 6.X and earlier. Must be empty if using ATS 7.X and/or the                                                                                 |
diff --git a/docs/source/api/v12/deliveryservice.rst b/docs/source/api/v12/deliveryservice.rst
index 6d5c042..c97538b 100644
--- a/docs/source/api/v12/deliveryservice.rst
+++ b/docs/source/api/v12/deliveryservice.rst
@@ -59,7 +59,7 @@ Delivery Service
   | ``anonymousBlockingEnabled`` | bool   | - true: enable blocking clients with anonymous ips                                                                                   |
   |                              |        | - false: disabled                                                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``                 | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``                 | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``                | int    | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -305,7 +305,7 @@ Delivery Service
   | ``anonymousBlockingEnabled`` | bool   | - true: enable blocking clients with anonymous ips                                                                                   |
   |                              |        | - false: disabled                                                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``                 | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``                 | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``                | int    | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2085,7 +2085,7 @@ URL Sig Keys
   | anonymousBlockingEnabled     | no       | - true: enable blocking clients with anonymous ips                                                      |
   |                              |          | - false: disabled                                                                                       |
   +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
-  | cacheurl                     | no       | Cache URL rule to apply to this delivery service.                                                       |
+  | cacheurl                     | no       | Deprecated. Cache URL rule to apply to this delivery service.                                                       |
   +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | ccrDnsTtl                    | no       | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.             |
   +------------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2264,7 +2264,7 @@ URL Sig Keys
   | ``anonymousBlockingEnabled`` | bool   | - true: enable blocking clients with anonymous ips                                                                                   |
   |                              |        | - false: disabled                                                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``                 | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``                 | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``                | int    | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2517,7 +2517,7 @@ URL Sig Keys
   | anonymousBlockingEnabled | no       | - true: enable blocking clients with anonymous ips                                                      |
   |                          |          | - false: disabled                                                                                       |
   +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
-  | cacheurl                 | no       | Cache URL rule to apply to this delivery service.                                                       |
+  | cacheurl                 | no       | Deprecated. Cache URL rule to apply to this delivery service.                                                       |
   +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | ccrDnsTtl                | no       | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host.             |
   +--------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2696,7 +2696,7 @@ URL Sig Keys
   | ``anonymousBlockingEnabled`` | bool   | - true: enable blocking clients with anonymous ips                                                                                   |
   |                              |        | - false: disabled                                                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``                 | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``                 | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``                | int    | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2976,7 +2976,7 @@ URL Sig Keys
   | ``anonymousBlockingEnabled`` | bool   | - true: enable blocking clients with anonymous ips                                                                                   |
   |                              |        | - false: disabled                                                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``                 | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``                 | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``                | int    | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/api/v12/server.rst b/docs/source/api/v12/server.rst
index c141097..1850d6a 100644
--- a/docs/source/api/v12/server.rst
+++ b/docs/source/api/v12/server.rst
@@ -368,7 +368,7 @@ Server
   +==========================+========+======================================================================================================================================+
   | ``active``               |  bool  | true if active, false if inactive.                                                                                                   |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``             | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``             | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``            | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/api/v12/user.rst b/docs/source/api/v12/user.rst
index 33cf1e3..95c2cd9 100644
--- a/docs/source/api/v12/user.rst
+++ b/docs/source/api/v12/user.rst
@@ -444,7 +444,7 @@ Users
   +==========================+========+======================================================================================================================================+
   | ``active``               |  bool  | true if active, false if inactive.                                                                                                   |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-  | ``cacheurl``             | string | Cache URL rule to apply to this delivery service.                                                                                    |
+  | ``cacheurl``             | string | Deprecated. Cache URL rule to apply to this delivery service.                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``ccrDnsTtl``            | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.                                         |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+