limited closed pull request #1825: updated docs to add some missing data
URL: https://github.com/apache/incubator-trafficcontrol/pull/1825
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/source/admin/traffic_ops/using.rst 
b/docs/source/admin/traffic_ops/using.rst
index e7e8eb215a..d0f4127f59 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -239,7 +239,7 @@ The server checks page is inteded to give an overview of 
the Servers managed by
 
 Daily Summary
 +++++++++++++
-Displays daily max gbps and bytes served for all CDNs.  In order for the 
graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to 
be be created, assigned to the global profile, and have a value of a grafana 
graph.  For more information on configuring grafana, see the `Traffic Stats 
<traffic_stats.html>`_  section.
+Displays daily max gbps and bytes served for all CDNs.  In order for the 
graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to 
be be created, assigned to the global profile, and have a value of a grafana 
graph.  For more information on configuring grafana, see the `Traffic Stats 
<../traffic_stats.html>`_  section.
 
 .. _rl-server:
 
@@ -293,135 +293,136 @@ The fields in the Delivery Service view are:
 
 .. Sorry for the width of this table, don't know how to make the bullet lists 
work otherwise. Just set your monitor to 2560*1600, and put on your glasses.
 
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|                       Name                       |                           
                                                                          
Description                                                                     
                                |
-+==================================================+=====================================================================================================================================================================================================================+
-| Active                                           | When this is set to false 
Traffic Router will not serve DNS or HTTP responses for this delivery service.  
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Cache URL expression                             | Cache URL rule to apply 
to this delivery service. See `ATS documentation on cacheurl 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html>`_.
 [1]_                                 |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CDN                                              | The CDN in which the 
delivery service belongs to.                                                    
                                                                                
                               |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Check Path                                       | A path (ex: 
/crossdomain.xml) to verify the connection to the origin server with. This can 
be used by Check Extension scripts to do periodic health checks against the 
delivery service.                            |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 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                  
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 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.                                          
                                  |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Display Name                                     | A human-readable name for 
the delivery service.                                                           
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS Bypass CNAME                                 |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS Bypass Ip                                    | (For DNS routed delivery 
services only) This is the address to respond to A requests with when the max 
Bps or Max Tps for this delivery service are exceeded.                          
                             |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS Bypass IPv6                                  | (For DNS routed delivery 
services only) This is the address to respond to AAAA requests with when the 
max Bps or Max Tps for this delivery service are exceeded.                      
                              |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS Bypass TTL                                   |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DSCP Tag                                         | The DSCP value to mark IP 
packets to the client with.                                                     
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Edge Header Rewrite Rules                        | Header Rewrite rules to 
apply for this delivery service at the EDGE tier. See :ref:`rl-header-rewrite`. 
[1]_                                                                            
                            |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Limit?                                       | Some services are 
intended to be limited by geography. The possible settings are are:             
                                                                                
                                  |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | - None - Do not limit by 
geography.                                                                      
                                                                                
                           |
-|                                                  | - CZF only - If the 
requesting IP is not in the Coverage Zone File, do not serve the request.       
                                                                                
                                |
-|                                                  | - CZF + US - If the 
requesting IP is not in the Coverage Zone File or not in the United States, do 
not serve the request.                                                          
                                 |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Limit Redirect URL                           | (for HTTP routed delivery 
services only) This is the URL Traffic Router will redirect to when Geo Limit 
Failure. See :ref:`rl-tr-ngb`                                                   
                            |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Limit Countries                              |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Miss Default Latitude                        | Default Latitude for this 
delivery service. When client localization fails for both Coverage Zone and Geo 
Lookup, the client will be routed as if it was at this lat.                     
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Miss Default Longitude                       | Default Longitude for 
this delivery service. When client localization fails for both Coverage Zone 
and Geo Lookup, the client will be routed as if it was at this long.            
                                 |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geolocation Provider                             |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Global Max Mbps                                  | The maximum bits per 
second this delivery service can serve across all EDGE caches before traffic 
will be diverted to the bypass destination. For a DNS delivery service, the 
Bypass Ipv4 or Ipv6  will be used     |
-|                                                  | (depending on whether 
this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN 
will be used.                                                                   
                                |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Global Max TPS                                   | The maximum transactions 
this delivery service can serve across all EDGE caches before traffic will be 
diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 
or Ipv6  will be used        |
-|                                                  | (depending on whether 
this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN 
will be used.                                                                   
                                |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP Bypass FQDN                                 | (for HTTP routed delivery 
services only) This is the FQDN Traffic Router will redirect to (with the same 
path) when the max Bps or Max Tps for this deliveryservice are exceeded.        
                           |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Info URL                                         | Info URL  for this 
delivery service. To be consumed from the APIs by downstream tools (Portal).    
                                                                                
                                 |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Initial Dispersion                               |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| IPv6 Routing Enabled                             | When set to yes, the 
Traffic Router will respond to AAAA DNS requests for the routed name of this 
delivery service. Otherwise, only A records will be served.                     
                                  |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Key (XML ID)                                     | A unique string that 
identifies this delivery service.                                               
                                                                                
                               |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Logs Enabled?                                    |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Long Description                                 | Long description for this 
delivery service. To be consumed from the APIs by downstream tools (Portal).    
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Long Description 2                               |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Long Description 3                               |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Max DNS Answers                                  |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Mid Header Rewrite Rules                         | Header Rewrite rules to 
apply for this delivery service at the MID tier. See :ref:`rl-header-rewrite`. 
[1]_                                                                            
                             |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Multi Site Origin                                | Enable the Multi Site 
Origin feature for this delivery service. See :ref:`rl-multi-site-origin`       
                                                                                
                              |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Origin Server Base URL                           | The Origin Server's base 
URL. This includes the protocol (http or https). Example: 
``http://movies.origin.com``                                                    
                                                 |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Origin Shield (Pipe Delimited String)            | Origin Shield string.     
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Profile                                          | The profile for this 
delivery service.                                                               
                                                                                
                               |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Protocol                                         | The protocol to serve 
this delivery service to the clients with:                                      
                                                                                
                              |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | -  0 http                 
                                                                                
                                                                                
                          |
-|                                                  | -  1 https                
                                                                                
                                                                                
                          |
-|                                                  | -  2 both http and https  
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Query String Handling                            | How to treat query 
strings:                                                                        
                                                                                
                                 |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | - 0 use in cache key and 
hand up to origin - this means each unique query string is treated as a unique 
URL.                                                                            
                            |
-|                                                  | - 1 Do not use in cache 
key, but pass up to origin - this means 2 URLs that are the same except for the 
query string will match, and cache HIT, while the origin still sees original 
query string in the request.   |
-|                                                  | - 2 Drop at edge - this 
means 2 URLs that are the same except for  the query string will match, and 
cache HIT, while the origin will not see original query string in the request.  
                                |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | **Note:** Choosing to 
drop query strings at the edge will preclude the use of a Regex Remap 
Expression. See :ref:`rl-regex-remap`.                                          
                                        |
-|                                                  | To set the qstring 
without the use of regex remap, or for further options, see 
:ref:`rl-qstring-handling`.                                                     
                                                     |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Range Request Handling                           | How to treat range 
requests:                                                                       
                                                                                
                                 |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | - 0 Do not cache (ranges 
requested from files that are already cached due to a non range request will be 
a HIT)                                                                          
                           |
-|                                                  | - 1 Use the 
`background_fetch 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_
 plugin.                                                                        
      |
-|                                                  | - 2 Use the 
cache_range_requests plugin.                                                    
                                                                                
                                        |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Raw Remap Text                                   | For HTTP and DNS 
deliveryservices, this will get added to the end of the remap line on the cache 
verbatim. For ANY_MAP deliveryservices this is the remap line. [1]_             
                                   |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Regex Remap Expression                           | Regex Remap rule to apply 
to this delivery service at the Edge tier. See `ATS documentation on 
regex_remap 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_.
 [1]_        |
-|                                                  |                           
                                                                                
                                                                                
                          |
-|                                                  | **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:`rl-regex-remap`.                      
                           |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Regional Geo-Blocking                            |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Routing Name                                     | The routing name to use 
for the delivery FQDN, i.e. ``<routing-name>.<deliveryservice>.<cdn-domain>``. 
It must be a valid hostname without periods. [2]_                               
                             |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Signing Algorithm                                |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| SSL Key Version                                  |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Tenant                                           | By selecting a tenant for 
the delivery service, you restrict access of that delivery service to only 
those users that belong to the same tenant or a parent tenant.                  
                               |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Traffic Router Request Headers                   |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Traffic Router Response Headers                  |                           
                                                                                
                                                                                
                          |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|                  Name                 |                                      
                                                              Description       
                                                                                
             |
++=======================================+===================================================================================================================================================================================================================+
+| Active                                | When this is set to false Traffic 
Router will not serve DNS or HTTP responses for this delivery service.          
                                                                                
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Cache URL expression                  | Cache URL rule to apply to this 
delivery service. See `ATS documentation on cacheurl 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html>`_.
 [1]_                               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CDN                                   | The CDN in which the delivery 
service belongs to.                                                             
                                                                                
                    |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Check Path                            | A path (ex: /crossdomain.xml) to 
verify the connection to the origin server with. This can be used by Check 
Extension scripts to do periodic health checks against the delivery service.    
                      |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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                             
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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.                                                      
                    |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Display Name                          | A human-readable name for the 
delivery service.                                                               
                                                                                
                    |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass CNAME                      | (For DNS routed delivery services 
only) This is a CNAME to respond to DNS requests with when a Delivery Service 
is unavailable.                                                                 
                  |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass Ip                         | (For DNS routed delivery services 
only) This is the address to respond to A requests with when the max Bps or Max 
Tps for this delivery service are exceeded.                                     
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass IPv6                       | (For DNS routed delivery services 
only) This is the address to respond to AAAA requests with when the max Bps or 
Max Tps for this delivery service are exceeded.                                 
                 |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass TTL                        | (For DNS routed delivery services 
only) This is the TTL to use for DNS Bypass responses when a delivery service 
is unavailable.                                                                 
                  |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DSCP Tag                              | The DSCP value to mark IP packets to 
the client with.                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Edge Header Rewrite Rules             | Header Rewrite rules to apply for 
this delivery service at the EDGE tier. See :ref:`rl-header-rewrite`. [1]_      
                                                                                
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit?                            | Some services are intended to be 
limited by geography. The possible settings are are:                            
                                                                                
                 |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | - None - Do not limit by geography.  
                                                                                
                                                                                
             |
+|                                       | - CZF only - If the requesting IP is 
not in the Coverage Zone File, do not serve the request.                        
                                                                                
             |
+|                                       | - CZF + US - If the requesting IP is 
not in the Coverage Zone File or not in the United States, do not serve the 
request.                                                                        
                 |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Redirect URL                | (for HTTP routed delivery services 
only) This is the URL Traffic Router will redirect to when Geo Limit Failure. 
See :ref:`rl-tr-ngb`                                                            
                 |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Countries                   | A comma delimited list of Country 
Codes that will be allowed to make requests from the Delivery Service           
                                                                                
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Latitude             | Default Latitude for this delivery 
service. When client localization fails for both Coverage Zone and Geo Lookup, 
the client will be routed as if it was at this lat.                             
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Longitude            | Default Longitude for this delivery 
service. When client localization fails for both Coverage Zone and Geo Lookup, 
the client will be routed as if it was at this long.                            
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geolocation Provider                  | An ordered list of Geolocation 
Providers to be used in make geo location decisions.                            
                                                                                
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Global Max Mbps                       | The maximum bits per second this 
delivery service can serve across all EDGE caches before traffic will be 
diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 
or Ipv6  will be used   |
+|                                       | (depending on whether this was a A 
or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.  
                                                                                
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Global Max TPS                        | The maximum transactions this 
delivery service can serve across all EDGE caches before traffic will be 
diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 
or Ipv6  will be used      |
+|                                       | (depending on whether this was a A 
or AAAA request), and for HTTP delivery services the Bypass FQDN will be used.  
                                                                                
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP Bypass FQDN                      | (for HTTP routed delivery services 
only) This is the FQDN Traffic Router will redirect to (with the same path) 
when the max Bps or Max Tps for this deliveryservice are exceeded.              
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Info URL                              | Info URL  for this delivery service. 
To be consumed from the APIs by downstream tools (Portal).                      
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Initial Dispersion                    | For HTTP delivery services - the 
number of caches that will be used by Traffic Router.  Traffic Router will 
consistently return the same caches as long as they are healthy.                
                      |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| IPv6 Routing Enabled                  | When set to yes, the Traffic Router 
will respond to AAAA DNS requests for the routed name of this delivery service. 
Otherwise, only A records will be served.                                       
              |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Key (XML ID)                          | A unique string that identifies this 
delivery service.                                                               
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Logs Enabled?                         | Whether or not Traffic Logs is 
enabled for the delivery service.  This feature is currently incomplete without 
Traffic Logs                                                                    
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description                      | Long description for this delivery 
service. To be consumed from the APIs by downstream tools (Portal).             
                                                                                
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 2                    | Another Long Description             
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 3                    | Another Long Description             
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Max DNS Answers                       | For DNS delivery services - the max 
number of DNS answers that will be returned by Traffic Router.                  
                                                                                
              |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Mid Header Rewrite Rules              | Header Rewrite rules to apply for 
this delivery service at the MID tier. See :ref:`rl-header-rewrite`. [1]_       
                                                                                
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Multi Site Origin                     | Enable the Multi Site Origin feature 
for this delivery service. See :ref:`rl-multi-site-origin`                      
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Server Base URL                | The Origin Server's base URL. This 
includes the protocol (http or https). Example: ``http://movies.origin.com``    
                                                                                
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Shield (Pipe Delimited String) | Origin Shield string.                
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Profile                               | The profile for this delivery 
service.                                                                        
                                                                                
                    |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Protocol                              | The protocol to serve this delivery 
service to the clients with:                                                    
                                                                                
              |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | -  0 http                            
                                                                                
                                                                                
             |
+|                                       | -  1 https                           
                                                                                
                                                                                
             |
+|                                       | -  2 both http and https             
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Query String Handling                 | How to treat query strings:          
                                                                                
                                                                                
             |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | - 0 use in cache key and hand up to 
origin - this means each unique query string is treated as a unique URL.        
                                                                                
              |
+|                                       | - 1 Do not use in cache key, but 
pass up to origin - this means 2 URLs that are the same except for the query 
string will match, and cache HIT, while the origin still sees original query 
string in the request. |
+|                                       | - 2 Drop at edge - this means 2 URLs 
that are the same except for  the query string will match, and cache HIT, while 
the origin will not see original query string in the request.                   
             |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | **Note:** Choosing to drop query 
strings at the edge will preclude the use of a Regex Remap Expression. See 
:ref:`rl-regex-remap`.                                                          
                      |
+|                                       | To set the qstring without the use 
of regex remap, or for further options, see :ref:`rl-qstring-handling`.         
                                                                                
               |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Range Request Handling                | How to treat range requests:         
                                                                                
                                                                                
             |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | - 0 Do not cache (ranges requested 
from files that are already cached due to a non range request will be a HIT)    
                                                                                
               |
+|                                       | - 1 Use the `background_fetch 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_
 plugin.                                                                        
    |
+|                                       | - 2 Use the cache_range_requests 
plugin.                                                                         
                                                                                
                 |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Raw Remap Text                        | For HTTP and DNS deliveryservices, 
this will get added to the end of the remap line on the cache verbatim. For 
ANY_MAP deliveryservices this is the remap line. [1]_                           
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regex Remap Expression                | Regex Remap rule to apply to this 
delivery service at the Edge tier. See `ATS documentation on regex_remap 
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_.
 [1]_      |
+|                                       |                                      
                                                                                
                                                                                
             |
+|                                       | **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:`rl-regex-remap`.                           
                    |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regional Geo-Blocking                 | `See documentation here 
<../quick_howto/regionalgeo.html>`_                                             
                                                                                
                          |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Routing Name                          | The routing name to use for the 
delivery FQDN, i.e. ``<routing-name>.<deliveryservice>.<cdn-domain>``. It must 
be a valid hostname without periods. [2]_                                       
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Signing Algorithm                     |                                      
                                                                                
                                                                                
             |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| SSL Key Version                       | The most recent version for SSL 
keys, this is incremented each time new certificates or generated or pasted in 
traffic ops                                                                     
                   |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Tenant                                | By selecting a tenant for the 
delivery service, you restrict access of that delivery service to only those 
users that belong to the same tenant or a parent tenant.                        
                       |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Traffic Router Request Headers        | Additional request header to be 
logged by Traffic Router                                                        
                                                                                
                  |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Traffic Router Response Headers       | Reponse headers to be returned by 
Traffic Router for each request                                                 
                                                                                
                |
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
 
 .. [1] These fields are not validated by Traffic Ops to be correct 
syntactically, and can cause Traffic Server to not start if invalid. Please use 
with caution.
 .. [2] It is not recommended to change the Routing Name of a Delivery Service 
after deployment because this changes its Delivery FQDN (i.e. 
``<routing-name>.<deliveryservice>.<cdn-domain>``), which means that SSL 
certificates may need to be updated and clients using the Delivery Service will 
need to be transitioned to the new Delivery URL.
@@ -436,34 +437,34 @@ Delivery Service Types
 ++++++++++++++++++++++
 One of the most important settings when creating the delivery service is the 
selection of the delivery service *type*. This type determines the routing 
method and the primary storage for the delivery service.
 
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|       Name      |                                                            
                                                                                
             Description                                                        
                                                                                
                  |
-+=================+==============================================================================================================================================================================================================================================================================================================================+
-| HTTP            | HTTP Content Routing  - The Traffic Router DNS auth server 
returns its own IP address on DNS queries, and the client gets redirected to a 
specific cache                                                                  
                                                                                
                   |
-|                 | in the nearest cache group using HTTP 302.  Use this for 
long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is 
not a.                                                                          
                                                                                
                     |
-|                 | problem.                                                   
                                                                                
                                                                                
                                                                                
                  |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS             | DNS Content Routing - The Traffic Router DNS auth server 
returns an edge cache IP address to the client right away. The client will find 
the cache quickly                                                               
                                                                                
                    |
-|                 | but the Traffic Router can not route to a cache that 
already has this content in the cache group. Use this for smaller objects like 
web page images / objects.                                                      
                                                                                
                         |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_NO_CACHE   | HTTP Content Routing, but the caches will not actually 
cache the content, they act as just proxies. The MID tier is bypassed.          
                                                                                
                                                                                
                      |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_LIVE       | HTTP Content routing, but where for "standard" HTTP 
content routing the objects are stored on disk, for this delivery service type 
the objects are stored                                                          
                                                                                
                          |
-|                 | on the RAM disks. Use this for linear TV. The MID tier is 
bypassed for this type.                                                         
                                                                                
                                                                                
                   |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier 
is NOT bypassed.                                                                
                                                                                
                                                                                
                   |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS_LIVE_NATNL  | DNS Content routing, but where for "standard" DNS content 
routing the objects are stored on disk, for this delivery service type the 
objects are stored                                                              
                                                                                
                        |
-|                 | on the RAM disks. Use this for linear TV. The MID tier is 
NOT bypassed for this type.                                                     
                                                                                
                                                                                
                   |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS_LIVE        | DNS Content routing, same as DNS_LIVE_NATNL, but the MID 
tier is bypassed.                                                               
                                                                                
                                                                                
                    |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ANY_MAP         | ANY_MAP is not known to Traffic Router. For this 
deliveryservice, the "Raw remap text" field in the input form will be used as 
the remap line on the cache.                                                    
                                                                                
                              |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| STEERING        | The Delivery Service will be used to route to other 
delivery services. The target delivery services and the routing weights for 
those delivery services will be defined by an admin or steering user. For more 
information see the `steering feature 
<../traffic_router.html#steering-feature>`_ documentation               |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CLIENT_STEERING |                                                            
                                                                                
                                                                                
                                                                                
                  |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|       Name      |                                                            
                                                                                
              Description                                                       
                                                                                
                    |
++=================+================================================================================================================================================================================================================================================================================================================================+
+| HTTP            | HTTP Content Routing  - The Traffic Router DNS auth server 
returns its own IP address on DNS queries, and the client gets redirected to a 
specific cache                                                                  
                                                                                
                     |
+|                 | in the nearest cache group using HTTP 302.  Use this for 
long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is 
not a.                                                                          
                                                                                
                       |
+|                 | problem.                                                   
                                                                                
                                                                                
                                                                                
                    |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS             | DNS Content Routing - The Traffic Router DNS auth server 
returns an edge cache IP address to the client right away. The client will find 
the cache quickly                                                               
                                                                                
                      |
+|                 | but the Traffic Router can not route to a cache that 
already has this content in the cache group. Use this for smaller objects like 
web page images / objects.                                                      
                                                                                
                           |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_NO_CACHE   | HTTP Content Routing, but the caches will not actually 
cache the content, they act as just proxies. The MID tier is bypassed.          
                                                                                
                                                                                
                        |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE       | HTTP Content routing, but where for "standard" HTTP 
content routing the objects are stored on disk, for this delivery service type 
the objects are stored                                                          
                                                                                
                            |
+|                 | on the RAM disks. Use this for linear TV. The MID tier is 
bypassed for this type.                                                         
                                                                                
                                                                                
                     |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier 
is NOT bypassed.                                                                
                                                                                
                                                                                
                     |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE_NATNL  | DNS Content routing, but where for "standard" DNS content 
routing the objects are stored on disk, for this delivery service type the 
objects are stored                                                              
                                                                                
                          |
+|                 | on the RAM disks. Use this for linear TV. The MID tier is 
NOT bypassed for this type.                                                     
                                                                                
                                                                                
                     |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE        | DNS Content routing, same as DNS_LIVE_NATNL, but the MID 
tier is bypassed.                                                               
                                                                                
                                                                                
                      |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ANY_MAP         | ANY_MAP is not known to Traffic Router. For this 
deliveryservice, the "Raw remap text" field in the input form will be used as 
the remap line on the cache.                                                    
                                                                                
                                |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| STEERING        | The Delivery Service will be used to route to other 
delivery services. The target delivery services and the routing weights for 
those delivery services will be defined by an admin or steering user. For more 
information see the `steering feature 
<../traffic_router.html#steering-feature>`_ documentation                 |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CLIENT_STEERING | Simliar to STEERING except that a client can send a 
request to Traffic Router with a query param of `trred=false` and Traffic 
Router will return a HTTP 200 reponse with a body that contians a list of 
Delivery Service URLs that the client connect to.  Therefore the client is 
doing the steering, not the Traffic Router. |
++-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 
 .. Note:: Once created, the Traffic Ops user interface does not allow you to 
change the delivery service type; the drop down is greyed out. There are many 
things that can go wrong when changing the type, and it is safer to delete the 
delivery service, and recreate it.


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to