trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject [incubator-trafficcontrol] 21/36: WIP Dynamic Deep Caching docs
Date Wed, 24 Jan 2018 17:23:30 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 696caf1361750f797bdfe8fa540fdb8f542ad451
Author: Rawlin Peters <rawlin_peters@comcast.com>
AuthorDate: Mon Nov 6 16:50:31 2017 -0700

    WIP Dynamic Deep Caching docs
---
 docs/source/admin/traffic_ops/using.rst | 84 +++++++++++++++++++++++++++++----
 1 file changed, 76 insertions(+), 8 deletions(-)

diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 7a78bd1..19fb72a 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -306,6 +306,10 @@ 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:                                                             |
+|                                                  | - NEVER                            
                                                                                         
                                                                                      |
+|                                                  | - ALWAYS                           
                                                                                         
                                                                                      |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Delivery Service DNS TTL                         | The Time To Live on the DNS record for
the Traffic Router A and AAAA records (``<routing-name>.<deliveryservice>.<cdn-domain>``).
                                                                                  |
 +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Delivery Servics URLs                            | (Read Only) An example of how the delivery
URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.
                                                                           |
@@ -846,23 +850,31 @@ The Coverage Zone File (CZF) should contain a cachegroup name to network
prefix
   {
     "coverageZones": {
       "cache-group-01": {
+        "coordinates": {
+          "latitude":  1.1,
+          "longitude": 2.2,
+        },
         "network6": [
-          "1234:5678::\/64",
-          "1234:5679::\/64"
+          "1234:5678::/64",
+          "1234:5679::/64"
         ],
         "network": [
-          "192.168.8.0\/24",
-          "192.168.9.0\/24"
+          "192.168.8.0/24",
+          "192.168.9.0/24"
         ]
       }
       "cache-group-02": {
+        "coordinates": {
+          "latitude":  3.3,
+          "longitude": 4.4,
+        },
         "network6": [
-          "1234:567a::\/64",
-          "1234:567b::\/64"
+          "1234:567a::/64",
+          "1234:567b::/64"
         ],
         "network": [
-          "192.168.4.0\/24",
-          "192.168.5.0\/24"
+          "192.168.4.0/24",
+          "192.168.5.0/24"
         ]
       }
     }
@@ -872,6 +884,62 @@ The CZF is an input to the Traffic Control CDN, and as such does not
get generat
 
 The script that generates the CZF file is not part of Traffic Control, since it is different
for each situation.
 
+.. note:: The "coordinates" section is optional and may be used by Traffic Router for localization
in the case of a CZF "hit" where the zone name does not map to a Cache Group name in Traffic
Ops (i.e. Traffic Router will route to the closest Cache Group(s) geographically).
+
+.. _rl-deep-czf:
+
+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``: ::
+
+  {
+    "coverageZones": {
+      "location-01": {
+        "coordinates": {
+          "latitude":  5.5,
+          "longitude": 6.6,
+        },
+        "network6": [
+          "1234:5678::/64",
+          "1234:5679::/64"
+        ],
+        "network": [
+          "192.168.8.0/24",
+          "192.168.9.0/24"
+        ],
+        "caches": [
+          "edge-01",
+          "edge-02"
+        ]
+      }
+      "location-02": {
+        "coordinates": {
+          "latitude":  7.7,
+          "longitude": 8.8,
+        },
+        "network6": [
+          "1234:567a::/64",
+          "1234:567b::/64"
+        ],
+        "network": [
+          "192.168.4.0/24",
+          "192.168.5.0/24"
+        ],
+        "caches": [
+          "edge-02",
+          "edge-03"
+        ]
+      }
+    }
+  }
+
+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.
+
+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.
+
+.. note:: The "coordinates" section is optional.
+
+
 .. _rl-working-with-profiles:
 
 Parameters and Profiles

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

Mime
View raw message