This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit 66dc8ed2908044a5423d52b9a2e6542e0d96268a
Author: Ashish Timilsina <at...@drexel.edu>
AuthorDate: Fri Apr 27 13:33:28 2018 -0600
update using.rst
---
docs/source/admin/traffic_ops/using.rst | 40 +++++++++++++++++++--------------
1 file changed, 23 insertions(+), 17 deletions(-)
diff --git a/docs/source/admin/traffic_ops/using.rst
b/docs/source/admin/traffic_ops/using.rst
index b4bdece..dd7e0fb 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -291,6 +291,7 @@ Delivery Service
================
The fields in the Delivery Service view are:
+
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Name | Description
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
@@ -299,13 +300,13 @@ The fields in the Delivery Service view are:
| Content Routing Type | DNS is the standard routing
type for most CDN services. HTTP Redirect is a specialty routing service that
is primarily used for video and large file downloads where localization and
latency are significant concerns.
[...]
| | A "Live" routing type should
be used for all live services. See :ref:`rl-ds-types`.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Key (XML ID) | This id becomes a part of the
CDN service domain in the form ``http://cdn.service-key.top.comcast.net/``.
Must be all lowercase, no spaces or special characters. May contain dashes.
[...]
+| Key (XML ID) | This id becomes a part of the
CDN service domain in the form ``http://cdn.service-key.company.com/``. Must be
all lowercase, no spaces or special characters. May contain dashes.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Display Name | Name of the service that
appears in the CDN portal. No character restrictions.
[...]
+| Display Name | Name of the service that
appears in the Traffic portal. No character restrictions.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Tenant | Name of company or division
of company who owns account. Allows you to group your services and control
access. Tenants are setup as a simple hierarchy where you may create parent /
child accounts.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| CDN | The CDN in which the delivery
service belongs. Over-the-top is used to deliver video, web and software
downloads over the data connection.
[...]
+| CDN | The CDN in which the delivery
service belongs
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| 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. Typical values would be ccr, edge and
cdn. [2]_
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
@@ -320,7 +321,8 @@ The fields in the Delivery Service view are:
| | - “uri_signing”: URI Signing
token based auth is enabled for this delivery service.
[...]
| |
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| URL Signing bypass | Regex value which determines
files/folders to bypass during the signing process at the CDN
[...]
+| Deep Caching | Enables clients to be routed
to the closest possible "deep" edge caches on a per Delivery Service basis.
[...]
+| | See `Deep Caching
<http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#deep-caching-deep-coverage-zone-topology>`_
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Query String Handling | How to treat query strings:
[...]
| |
[...]
@@ -345,9 +347,10 @@ The fields in the Delivery Service view are:
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Geo Limit Redirect URL | (For HTTP routed delivery
services only) This is the URL, Traffic Router will redirect to when Geo Limit
check fails. See :ref:`rl-tr-ngb`
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Regional Geoblocking | Define regional geo-blocking
rules for delivery services.
[...]
+| Regional Geoblocking | (For HTTP routed delivery
services only) Define regional geo-blocking rules for delivery services in a
JSON format and set it to True/False.
[...]
+| | See `regional geo-blocking
<http://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/regionalgeo.html#configure-regional-geo-blocking-rgb>`_
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| IPv6 Routing Enabled | Default is yes, entering "No"
allows you to turn off cdn response to IPv6 requests
[...]
+| IPv6 Routing Enabled | Default is "True", entering
"False" allows you to turn off CDN response to IPv6 requests
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Range Request Handling | How to treat range requests:
[...]
| |
[...]
@@ -364,7 +367,7 @@ The fields in the Delivery Service view are:
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| DNS Bypass TTL | TTL for the DNS bypass domain
or IP when threshold exceeded.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Maximum Bytes per Second allowed per session | The maximum bytes per second
a cache will delivery on any single TCP connection. This uses the Linux
kernel’s Fair Queuing setsockopt(SO_MAX_PACING_RATE) to limit the rate of
delivery. Traffic exceeding this speed will only be rate-limited and not
diverted. This option requires net.core.default_qdisc = fq in /etc/sysctl.conf.
[...]
+| Maximum Bytes per Second allowed per session | The maximum bytes per second
a cache will delivery on any single TCP connection. This uses the Linux
kernel’s Fair Queuing setsockopt (SO_MAX_PACING_RATE) to limit the rate of
delivery. Traffic exceeding this speed will only be rate-limited and not
diverted. This option requires net.core.default_qdisc = fq in /etc/sysctl.conf.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| 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.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
@@ -379,9 +382,9 @@ The fields in the Delivery Service view are:
| Origin Server Base URL | The Origin Server’s base URL.
This includes the protocol (http or https). Example:
``http://movies.origin.com``
[...]
| | Must be a domain only, no
directories or IP addresses
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Use Multi Site Origin Feature | Enable the Multi Site Origin
feature for this delivery service. Is the Multi Site Origin feature enabled for
this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin`
[...]
+| Use Multi Site Origin Feature | Enable the Multi Site Origin
feature for this delivery service. Is the Multi Site Origin feature enabled for
this delivery service (True/False). See :ref:`rl-multi-site-origin`
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Delivery Service Profile | Only used if a delivery
service uses configurations that specifically require a profile.
[...]
+| Delivery Service Profile | Only used if a delivery
service uses configurations that specifically require a profile. Example: MSO
configurations or cachekey plugin would require a ds profile to be used.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Geo Miss Default Latitude | Default Latitude for this
delivery service. When client localization fails for both Coverage Zone and Geo
Lookup, this the client will be routed as if it was at this lat.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
@@ -409,23 +412,26 @@ The fields in the Delivery Service view are:
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Traffic Router Log Request Headers | List of header keys separated
by __RETURN__. Listed headers will be included in TR access log entries under
the “rh=” token.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Regex remap expression | Allows remapping of incoming
requests URL using regex pattern matching to search/replace text. See `ATS
documentation on regex_remap
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_.
[1]_
[...]
-| |
[...]
+| Regex remap expression | Allows remapping of incoming
requests URL using regex pattern matching to search/replace text.
[...]
+| | 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`.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Cache key expression | Allows you to manipulate the
cache key of the incoming requests. Normally, the cache key is the origin
domain. This can be changed so that multiple services can share a cache key,
can also be used to preserve cached content if service origin is changed.
[...]
-| | See `ATS documentation on
cachekey
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html>`_.
[1]_
[...]
+| Cache URL expression | Allows you to manipulate the
cache key of the incoming requests. Normally, the cache key is the origin
domain. This can be changed so that multiple services can share a cache key,
can also be used to preserve cached content if service origin is changed.
[...]
+| |
[...]
+| | **Note:** Only valid in ATS
6.X and earlier. Must be empty if using ATS 7.X and/or the `cachekey plugin
<https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html>`_.
[1]_
[...]
+| |
[...]
+| | See `ATS documentation on
cacheurl
<https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/plugins/cacheurl.en.html>`_.
[1]_
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| Raw remap text | For HTTP and DNS delivery
services, this will get added to the end of the remap line on the cache
verbatim. For ANY_MAP delivery services this is the remap line. [1]_
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Long Description | A short text field that
describes the purpose of the delivery service and will be displayed in the
portal as a description field. For example, you can use this field to describe
your service. To be consumed from the APIs by downstream tools (Portal)
[...]
+| Long Description | A short text field that
describes the purpose of the delivery service and will be displayed in the
portal as a description field. For example, you can use this field to describe
your service. To be consumed from the APIs by downstream tools such as the
Traffic Portal
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Long Description 1 | Free text field not currently
used in configuration. For example, you can use this field to describe your
customer type. To be consumed from the APIs by downstream tools (Portal)
[...]
+| Long Description 1 | Free text field not currently
used in configuration. For example, you can use this field to describe your
customer type. To be consumed from the APIs by downstream tools such as the
Traffic Portal
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Long Description 2 | Free text field not currently
used in configuration. To be consumed from the APIs by downstream tools
(Portal)
[...]
+| Long Description 2 | Free text field not currently
used in configuration. To be consumed from the APIs by downstream tools such as
the Traffic Portal
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
-| Info URL | Free text field allowing you
to enter a URL which provides information about the service. To be consumed
from the APIs by downstream tools (Portal)
[...]
+| Info URL | Free text field allowing you
to enter a URL which provides information about the service. To be consumed
from the APIs by downstream tools such as the Traffic Portal
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
| 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.
[...]
+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
[...]
--
To stop receiving notification emails like this one, please contact
mitchell...@apache.org.
