dangogh closed pull request #2024: Fix some typos in the docs
URL: https://github.com/apache/incubator-trafficcontrol/pull/2024
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 825bf2668..5b0f2a8e5 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -434,34 +434,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 | 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. |
-+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 | Similar 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 an HTTP 200 response with a body that contains a list of
Delivery Service URLs that the client can connect to. Therefore, the client is
doing the steering, not the Traffic Router. |
++-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. _rl-federations:
diff --git a/docs/source/overview/traffic_ops.rst
b/docs/source/overview/traffic_ops.rst
index ad026ced7..b6ede6e23 100644
--- a/docs/source/overview/traffic_ops.rst
+++ b/docs/source/overview/traffic_ops.rst
@@ -19,7 +19,7 @@ Traffic Ops
===========
Traffic Ops is the tool for administration (configuration and monitoring) of
all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops
to manage servers, cache groups, delivery services, etc. In many cases, a
configuration change requires propagation to several, or even all, caches and
only explicitly after or before the same change propagates to Traffic Router.
Traffic Ops takes care of this required consistency between the different
components and their configuration. Traffic Ops exposes its data through a
series of HTTP APIs and has a user interface that is interactive and viewable
using a standard web browser.
-Traffic Ops uses a PostgreSQL database to store the configuration information,
and the `Mojolicious framework <http://mojolicio.us/>`_ and `Go
https://golang.org/`_ to generate APIs used by the Traffic Portal. Not all
configuration data is in this database however; for sensitive data like SSL
private keys or token based authentication shared secrets, a separate key-value
store is used, allowing the operator to harden the server that runs this
key-value store better from a security perspective (i.e only allow Traffic Ops
access it with a cert). The Traffic Ops server, by design, needs to be
accessible from all the other servers in the Traffic Control CDN.
+Traffic Ops uses a PostgreSQL database to store the configuration information,
and the `Mojolicious framework <http://mojolicio.us/>`_ and `Go
<https://golang.org/>`_ to generate APIs used by the Traffic Portal. Not all
configuration data is in this database however; for sensitive data like SSL
private keys or token based authentication shared secrets, a separate key-value
store is used, allowing the operator to harden the server that runs this
key-value store better from a security perspective (i.e only allow Traffic Ops
access it with a cert). The Traffic Ops server, by design, needs to be
accessible from all the other servers in the Traffic Control CDN.
Traffic Ops generates all the application specific configuration files for the
caches and other servers. The caches and other servers check in with Traffic
Ops at a regular interval (default 15 minutes) to see if updated configuration
files require application.
----------------------------------------------------------------
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
