trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject [incubator-trafficcontrol] 22/36: More DDC documentation
Date Wed, 24 Jan 2018 17:23:31 GMT
This is an automated email from the ASF dual-hosted git repository.

elsloo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git

commit 5b890a008a073d6e36f114152ac22c76f0ab8003
Author: Rawlin Peters <rawlin_peters@comcast.com>
AuthorDate: Tue Nov 7 15:44:47 2017 -0700

    More DDC documentation
---
 docs/source/admin/traffic_ops/using.rst            | 20 ++++++-----
 docs/source/admin/traffic_router.rst               |  8 +++++
 .../traffic_ops_api/v12/deliveryservice.rst        | 40 +++++++++++++++++++++-
 .../development/traffic_ops_api/v12/server.rst     |  5 +++
 .../development/traffic_ops_api/v12/user.rst       |  5 +++
 5 files changed, 69 insertions(+), 9 deletions(-)

diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 19fb72a..e37be4d 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -306,7 +306,7 @@ The fields in the Delivery Service view are:
 +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Content Routing Type                             | The type of content routing this delivery
service will use. See :ref:`rl-ds-types`.                                                
                                                                                |
 +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Deep Caching                                     | (for HTTP routed delivery services only)
When to do deep caching for this delivery service (see :ref:`Deep Caching <insert-ref-here>`
for more details:                                                             |
+| Deep Caching                                     | (for HTTP routed delivery services only)
When to do deep caching for this delivery service (see :ref:`Deep Caching <insert-ref-here>`
for more details):                                                            |
 |                                                  | - NEVER                            
                                                                                         
                                                                                      |
 |                                                  | - ALWAYS                           
                                                                                         
                                                                                      |
 +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -714,7 +714,11 @@ Traffic Router Profile
 +-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | coveragezone.polling.interval           | CRConfig.json          | How often to refresh
the coverage zone map in ms                                                              
                                                                                         
 |
 +-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| coveragezone.polling.url                | CRConfig.json          | The location (URL) to
retrieve the coverage zone map file in XML format from.                                  
                                                                                         
|
+| coveragezone.polling.url                | CRConfig.json          | The location (URL) to
retrieve the coverage zone map file in JSON format from.                                 
                                                                                         
|
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| deepcoveragezone.polling.interval       | CRConfig.json          | How often to refresh
the deep coverage zone map in ms                                                         
                                                                                         
 |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| deepcoveragezone.polling.url            | CRConfig.json          | The location (URL) to
retrieve the deep coverage zone map file in JSON format from.                            
                                                                                         
|
 +-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | tld.soa.expire                          | CRConfig.json          | The value for the expire
field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records.
                                                                                      |
 +-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -852,7 +856,7 @@ The Coverage Zone File (CZF) should contain a cachegroup name to network
prefix
       "cache-group-01": {
         "coordinates": {
           "latitude":  1.1,
-          "longitude": 2.2,
+          "longitude": 2.2
         },
         "network6": [
           "1234:5678::/64",
@@ -866,7 +870,7 @@ The Coverage Zone File (CZF) should contain a cachegroup name to network
prefix
       "cache-group-02": {
         "coordinates": {
           "latitude":  3.3,
-          "longitude": 4.4,
+          "longitude": 4.4
         },
         "network6": [
           "1234:567a::/64",
@@ -890,14 +894,14 @@ The script that generates the CZF file is not part of Traffic Control,
since it
 
 The Deep Coverage Zone File
 +++++++++++++++++++++++++++
-The Deep Coverage Zone File (DCZF) format is similar the CZF format but contains a ``caches``
list under each ``coverageZone``: ::
+The Deep Coverage Zone File (DCZF) format is similar to the CZF format but adds a ``caches``
list under each ``coverageZone``: ::
 
   {
     "coverageZones": {
       "location-01": {
         "coordinates": {
           "latitude":  5.5,
-          "longitude": 6.6,
+          "longitude": 6.6
         },
         "network6": [
           "1234:5678::/64",
@@ -915,7 +919,7 @@ The Deep Coverage Zone File (DCZF) format is similar the CZF format but
contains
       "location-02": {
         "coordinates": {
           "latitude":  7.7,
-          "longitude": 8.8,
+          "longitude": 8.8
         },
         "network6": [
           "1234:567a::/64",
@@ -933,7 +937,7 @@ The Deep Coverage Zone File (DCZF) format is similar the CZF format but
contains
     }
   }
 
-Each entry in the ``caches`` list is the hostname of an edge cache registered in Traffic
Ops which will be used for "deep" caching in that Deep Coverage Zone. Unlike a regular CZF,
coverage zones in the DCZF do not map to a Cache Group in Traffic Ops, so currently the deep
coverage zone name can be chosen arbitrarily.
+Each entry in the ``caches`` list is the hostname of an edge cache registered in Traffic
Ops which will be used for "deep" caching in that Deep Coverage Zone. Unlike a regular CZF,
coverage zones in the DCZF do not map to a Cache Group in Traffic Ops, so currently the deep
coverage zone name only needs to be unique.
 
 If the Traffic Router gets a DCZF "hit" for a requested Delivery Service that has Deep Caching
enabled, the client will be routed to an available "deep" cache from that zone's ``caches``
list.
 
diff --git a/docs/source/admin/traffic_router.rst b/docs/source/admin/traffic_router.rst
index 3a37781..0fe1707 100644
--- a/docs/source/admin/traffic_router.rst
+++ b/docs/source/admin/traffic_router.rst
@@ -102,6 +102,10 @@ Configuration files
 |                            +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
 |                            | cache.czmap.database.refresh.period       | The interval in
milliseconds which Traffic Router will poll for a new coverage zone file            | 10800000
                                         |
 |                            +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+|                            | cache.dczmap.database                     | Full path to the
local copy of the deep coverage zone file                                          | /opt/traffic_router/db/dczmap.json
               |
+|                            +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+|                            | cache.dczmap.database.refresh.period      | The interval in
milliseconds which Traffic Router will poll for a new deep coverage zone file       | 10800000
                                         |
+|                            +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
 |                            | cache.health.json                         | Full path to the
local copy of the health state                                                     | /opt/traffic_router/db/health.json
               |
 |                            +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
 |                            | cache.health.json.refresh.period          | The interval in
milliseconds which Traffic Router will poll for a new health state file             | 1000
                                             |
@@ -210,6 +214,10 @@ Fields Always Present
 +-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |CZ           |The result was derived from Coverage Zone data based on the address in the
chi field                                                                                
   |
 +-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DEEP_CZ      |The result was derived from Deep Coverage Zone data based on the address in
the chi field                                                                            
  |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DEEP_CZ_MISS |Traffic Router was unable to find a "deep" cache for the requested resource
but fell back to the regular Coverage Zone to derive a result based on the chi address   
  |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |GEO          |The result was derived from geolocation service based on the address in the
chi field                                                                                
  |
 +-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 |MISS         |Traffic Router was unable to resolve a DNS request or find a cache for the
requested resource                                                                       
   |
diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
index 2884a4b..3eaff73 100644
--- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
+++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
@@ -66,6 +66,10 @@ Delivery Service
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassCname``       | string |                                                 
                                                                                    |
@@ -206,6 +210,7 @@ Delivery Service
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
@@ -301,6 +306,10 @@ Delivery Service
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassCname``       | string |                                                 
                                                                                    |
@@ -449,6 +458,7 @@ Delivery Service
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
@@ -1918,6 +1928,10 @@ URL Sig Keys
   +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
   | ``>customer``                          | string | yes      | Name of the customer
to associated with the delivery service.                               |
   +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+  | ``>deepCachingType``                   |  int   | no       | When to do Deep Caching
for this Delivery Service:                                          |
+  |                                        |        |          | - 0: NEVER (default)   
                                                                    |
+  |                                        |        |          | - 1: ALWAYS            
                                                                    |
+  +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
   | ``>deliveryProtocol``                  | string | yes      | Eg. http or http/https
                                                                     |
   +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
   | ``>routingType``                       | string | yes      | Eg. DNS or HTTP Redirect
                                                                   |
@@ -1978,6 +1992,7 @@ URL Sig Keys
        "details": {
           "customer": "XYZ Corporation",
           "contentType": "video-on-demand",
+          "deepCachingType": 0,
           "deliveryProtocol": "http",
           "routingType": "dns",
           "routingName": "foo",
@@ -2062,6 +2077,10 @@ URL Sig Keys
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | checkPath              | no       | The path portion of the URL to check this deliveryservice
for health.                                   |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+  | deepCachingType        | no       | When to do Deep Caching for this Delivery Service:
                                                     |
+  |                        |          | - 0: NEVER (default)                            
                                                       |
+  |                        |          | - 1: ALWAYS                                     
                                                       |
+  +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | displayName            | yes      | Display name                                    
                                                       |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | dnsBypassCname         | no       | Bypass CNAME                                    
                                                       |
@@ -2232,6 +2251,10 @@ URL Sig Keys
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassCname``       | string |                                                 
                                                                                    |
@@ -2376,6 +2399,7 @@ URL Sig Keys
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
@@ -2472,6 +2496,10 @@ URL Sig Keys
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | checkPath              | no       | The path portion of the URL to check this deliveryservice
for health.                                   |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+  | deepCachingType        | no       | When to do Deep Caching for this Delivery Service:
                                                     |
+  |                        |          | - 0: NEVER (default)                            
                                                       |
+  |                        |          | - 1: ALWAYS                                     
                                                       |
+  +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | displayName            | yes      | Display name                                    
                                                       |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
   | dnsBypassCname         | no       | Bypass CNAME                                    
                                                       |
@@ -2602,7 +2630,7 @@ URL Sig Keys
     {
         "xmlId": "my_ds_1",
         "displayName": "my_ds_displayname_1",
-	"tenantId": 1,
+        "tenantId": 1,
         "protocol": 1,
         "orgServerFqdn": "http://10.75.168.91",
         "cdnId": 2,
@@ -2642,6 +2670,10 @@ URL Sig Keys
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassCname``       | string |                                                 
                                                                                    |
@@ -2786,6 +2818,7 @@ URL Sig Keys
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
@@ -2911,6 +2944,10 @@ URL Sig Keys
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassCname``       | string |                                                 
                                                                                    |
@@ -3055,6 +3092,7 @@ URL Sig Keys
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
diff --git a/docs/source/development/traffic_ops_api/v12/server.rst b/docs/source/development/traffic_ops_api/v12/server.rst
index 77ae9f8..bae5b8a 100644
--- a/docs/source/development/traffic_ops_api/v12/server.rst
+++ b/docs/source/development/traffic_ops_api/v12/server.rst
@@ -378,6 +378,10 @@ Server
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassIp``          | string | The IPv4 IP to use for bypass on a DNS deliveryservice
 - bypass starts when serving more than the                                   |
@@ -516,6 +520,7 @@ Server
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",
diff --git a/docs/source/development/traffic_ops_api/v12/user.rst b/docs/source/development/traffic_ops_api/v12/user.rst
index fe07920..f89b566 100644
--- a/docs/source/development/traffic_ops_api/v12/user.rst
+++ b/docs/source/development/traffic_ops_api/v12/user.rst
@@ -454,6 +454,10 @@ Users
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``checkPath``            | string | The path portion of the URL to check this deliveryservice
for health.                                                                |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+  | ``deepCachingType``      |  int   | When to do Deep Caching for this Delivery Service:
                                                                                  |
+  |                          |        | - 0: NEVER (default)                            
                                                                                    |
+  |                          |        | - 1: ALWAYS                                     
                                                                                    |
+  +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``displayName``          | string | The display name of the delivery service.       
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
   | ``dnsBypassIp``          | string | The IPv4 IP to use for bypass on a DNS deliveryservice
 - bypass starts when serving more than the                                   |
@@ -592,6 +596,7 @@ Users
             "cdnId": "2",
             "cdnName": "over-the-top",
             "checkPath": "",
+            "deepCachingType": 0,
             "displayName": "My Cool Delivery Service",
             "dnsBypassCname": "",
             "dnsBypassIp": "",

-- 
To stop receiving notification emails like this one, please contact
elsloo@apache.org.

Mime
View raw message