trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From els...@apache.org
Subject [incubator-trafficcontrol] 24/36: DDC documentation cleanup
Date Wed, 24 Jan 2018 17:23:33 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 b9d4b5ead62d8d2b4287b040a441b4ff2f8b2dec
Author: Rawlin Peters <rawlin_peters@comcast.com>
AuthorDate: Wed Nov 8 15:35:39 2017 -0700

    DDC documentation cleanup
---
 docs/source/admin/traffic_ops/using.rst            |  9 +-
 docs/source/admin/traffic_router.rst               | 96 +++++++++++-----------
 .../traffic_ops_api/v12/deliveryservice.rst        |  8 ++
 .../development/traffic_ops_api/v12/server.rst     |  1 +
 .../development/traffic_ops_api/v12/user.rst       |  1 +
 5 files changed, 63 insertions(+), 52 deletions(-)

diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 334eb58..5ac1a0d 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -307,8 +307,9 @@ 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 <rl-deep-cache>`
for more details):                                                              |
-|                                                  | - NEVER                            
                                                                                         
                                                                                      |
-|                                                  | - ALWAYS                           
                                                                                         
                                                                                      |
+|                                                  |                                    
                                                                                         
                                                                                      |
+|                                                  | - 0 - NEVER                        
                                                                                         
                                                                                      |
+|                                                  | - 1 - 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>``).
                                                                                  |
 +--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -888,7 +889,7 @@ 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).
+.. 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:
 
@@ -941,7 +942,7 @@ Each entry in the ``caches`` list is the hostname of an edge cache registered
in
 
 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.
+.. note:: The ``"coordinates"`` section is optional.
 
 
 .. _rl-working-with-profiles:
diff --git a/docs/source/admin/traffic_router.rst b/docs/source/admin/traffic_router.rst
index 7dd60d9..84b0f25 100644
--- a/docs/source/admin/traffic_router.rst
+++ b/docs/source/admin/traffic_router.rst
@@ -144,54 +144,6 @@ Traffic Router currently follows the zone signing key pre-publishing
operational
 
 .. _section 4.1.1.1 of RFC 6781: https://tools.ietf.org/html/rfc6781#section-4.1.1.1
 
-
-.. _rl-deep-cache:
-
-Deep Caching - Deep Coverage Zone Topology
-==========================================
-
-Overview
---------
-
-Deep Caching is a feature that enables clients to be routed to the closest
-possible "deep" edge caches on a per Delivery Service basis. The term "deep" is
-used in the networking sense, meaning that the edge caches are located deep in
-the network where the number of network hops to a client is as minimal as
-possible. This deep caching topology is desirable because storing content closer
-to the client gives better bandwidth savings, and sometimes the cost of
-bandwidth usage in the network outweighs the cost of adding storage. While it
-may not be feasible to cache an entire copy of the CDN's contents in every deep
-location (for the best possible bandwidth savings), storing just a relatively
-small amount of the CDN's most requested content can lead to very high bandwidth
-savings.
-
-Getting started
----------------
-
-What you need:
-
-#. Edge caches deployed in "deep" locations and registered in Traffic Ops
-#. A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network
prefixes (see :ref:`rl-deep-czf` for details)
-#. Deep caching parameters in the Traffic Router Profile (see :ref:`rl-ccr-profile` for details):
-
-   * ``deepcoveragezone.polling.interval``
-   * ``deepcoveragezone.polling.url``
-
-#. Deep Caching enabled on one or more HTTP Delivery Services (i.e. ``deepCachingType`` =
ALWAYS)
-
-How it works
-------------
-
-Deep Coverage Zone routing is very similar to that of regular Coverage Zone
-routing, except that the DCZF is preferred over the regular  CZF for Delivery
-Services with DC (Deep Caching) enabled. If the client requests a DC-enabled
-Delivery Service and their IP address gets a "hit" in the DCZF, Traffic Router
-will attempt to route that client to one of the available deep caches in the
-client's corresponding zone. If there are no deep caches available for a
-client's request, Traffic Router will "fall back" to the regular CZF and
-continue regular CZF routing from there.
-
-
 Troubleshooting and log files
 =============================
 Traffic Router log files are in ``/opt/traffic_router/var/log``, and Tomcat log files are
in ``/opt/tomcat/logs``. Application related logging is in ``/opt/traffic_router/var/log/traffic_router.log``,
while access logs are written to ``/opt/traffic_router/var/log/access.log``.
@@ -403,6 +355,54 @@ The URL has 3 kinds of formats, which have different meanings:
 
 3. URL with domain that doesn't match with the delivery service. For this URL, the router
will return the configured url directly to the client.
 
+
+.. _rl-deep-cache:
+
+Deep Caching - Deep Coverage Zone Topology
+==========================================
+
+Overview
+--------
+
+Deep Caching is a feature that enables clients to be routed to the closest
+possible "deep" edge caches on a per Delivery Service basis. The term "deep" is
+used in the networking sense, meaning that the edge caches are located deep in
+the network where the number of network hops to a client is as minimal as
+possible. This deep caching topology is desirable because storing content closer
+to the client gives better bandwidth savings, and sometimes the cost of
+bandwidth usage in the network outweighs the cost of adding storage. While it
+may not be feasible to cache an entire copy of the CDN's contents in every deep
+location (for the best possible bandwidth savings), storing just a relatively
+small amount of the CDN's most requested content can lead to very high bandwidth
+savings.
+
+Getting started
+---------------
+
+What you need:
+
+#. Edge caches deployed in "deep" locations and registered in Traffic Ops
+#. A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network
prefixes (see :ref:`rl-deep-czf` for details)
+#. Deep caching parameters in the Traffic Router Profile (see :ref:`rl-ccr-profile` for details):
+
+   * ``deepcoveragezone.polling.interval``
+   * ``deepcoveragezone.polling.url``
+
+#. Deep Caching enabled on one or more HTTP Delivery Services (i.e. ``deepCachingType`` =
ALWAYS)
+
+How it works
+------------
+
+Deep Coverage Zone routing is very similar to that of regular Coverage Zone
+routing, except that the DCZF is preferred over the regular  CZF for Delivery
+Services with DC (Deep Caching) enabled. If the client requests a DC-enabled
+Delivery Service and their IP address gets a "hit" in the DCZF, Traffic Router
+will attempt to route that client to one of the available deep caches in the
+client's corresponding zone. If there are no deep caches available for a
+client's request, Traffic Router will "fall back" to the regular CZF and
+continue regular CZF routing from there.
+
+
 .. _rl-tr-steering:
 
 Steering feature
diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
index 3eaff73..42005f7 100644
--- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
+++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
@@ -67,6 +67,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -307,6 +308,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -1929,6 +1931,7 @@ 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            
                                                                    |
   +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
@@ -2078,6 +2081,7 @@ 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                                     
                                                       |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2252,6 +2256,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2497,6 +2502,7 @@ 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                                     
                                                       |
   +------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -2671,6 +2677,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
@@ -2945,6 +2952,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/development/traffic_ops_api/v12/server.rst b/docs/source/development/traffic_ops_api/v12/server.rst
index bae5b8a..9b2a42b 100644
--- a/docs/source/development/traffic_ops_api/v12/server.rst
+++ b/docs/source/development/traffic_ops_api/v12/server.rst
@@ -379,6 +379,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/development/traffic_ops_api/v12/user.rst b/docs/source/development/traffic_ops_api/v12/user.rst
index f89b566..b589a3b 100644
--- a/docs/source/development/traffic_ops_api/v12/user.rst
+++ b/docs/source/development/traffic_ops_api/v12/user.rst
@@ -455,6 +455,7 @@ 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                                     
                                                                                    |
   +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+

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

Mime
View raw message