dneuman64 commented on a change in pull request #1825: updated docs to add some
missing data
URL:
https://github.com/apache/incubator-trafficcontrol/pull/1825#discussion_r167021851
##########
File path: docs/source/admin/traffic_ops/using.rst
##########
@@ -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.
|
++---------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 imcomplete without
Traffic Logs
|
Review comment:
fixed
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
