You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2018/09/26 13:51:25 UTC
[trafficcontrol] 08/46: Removing superfluous reference prefixes
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/trafficcontrol.git
commit a083ec5de70ea28cb86703cd6694d85b2d17fa6b
Author: ocket8888 <oc...@gmail.com>
AuthorDate: Tue Sep 11 12:30:55 2018 -0600
Removing superfluous reference prefixes
---
docs/source/_static/theme_overrides.css | 8 +-
.../admin/quick_howto/anonymous_blocking.rst | 12 +-
docs/source/admin/quick_howto/dnssec.rst | 38 +-
docs/source/admin/quick_howto/federations.rst | 40 +-
docs/source/admin/quick_howto/multi_site.rst | 14 +-
docs/source/admin/quick_howto/regionalgeo.rst | 2 +-
docs/source/admin/quick_howto/steering.rst | 2 +-
docs/source/admin/traffic_monitor.rst | 16 +-
docs/source/admin/traffic_monitor_golang.rst | 18 +-
docs/source/admin/traffic_ops/configuration.rst | 4 +-
docs/source/admin/traffic_ops/default_profiles.rst | 8 +-
docs/source/admin/traffic_ops/extensions.rst | 39 +-
docs/source/admin/traffic_ops/installation.rst | 6 +-
.../admin/traffic_ops/migration_from_10_to_20.rst | 81 ++--
.../admin/traffic_ops/migration_from_20_to_22.rst | 170 +++++----
docs/source/admin/traffic_ops/using.rst | 413 +++++++++++----------
.../admin/traffic_portal/usingtrafficportal.rst | 12 +-
docs/source/admin/traffic_router.rst | 32 +-
docs/source/admin/traffic_server.rst | 2 +-
docs/source/api/v11/deliveryservice.rst | 32 +-
docs/source/api/v12/deliveryservice.rst | 10 +-
docs/source/api/v12/server.rst | 4 +-
docs/source/api/v12/user.rst | 26 +-
docs/source/basics/caching_proxies.rst | 27 +-
docs/source/basics/content_delivery_networks.rst | 2 +-
docs/source/development/traffic_ops.rst | 56 +--
docs/source/faq/administration.rst | 30 +-
docs/source/glossary.rst | 38 +-
docs/source/overview/traffic_monitor.rst | 6 +-
docs/source/overview/traffic_ops.rst | 2 +-
docs/source/overview/traffic_router.rst | 22 +-
docs/source/overview/traffic_stats.rst | 25 +-
docs/source/overview/traffic_vault.rst | 4 +-
33 files changed, 616 insertions(+), 585 deletions(-)
diff --git a/docs/source/_static/theme_overrides.css b/docs/source/_static/theme_overrides.css
index b5202a5..0ffb274 100644
--- a/docs/source/_static/theme_overrides.css
+++ b/docs/source/_static/theme_overrides.css
@@ -39,8 +39,8 @@
.wy-alert.wy-alert-info, .rst-content .note, .rst-content .wy-alert-info.attention, .rst-content .wy-alert-info.caution, .rst-content
.wy-alert-info.danger, .rst-content .wy-alert-info.error, .rst-content .wy-alert-info.hint, .rst-content .wy-alert-info.important,
.rst-content .wy-alert-info.tip, .rst-content .wy-alert-info.warning, .rst-content .seealso, .rst-content .wy-alert-info.admonition-todo {
- /*background: #edf0f2;*/
- background-color: powderblue;
+ background: #edf0f2;
+ /*background-color: powderblue;*/
}
.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title,
@@ -65,7 +65,7 @@
.wy-nav-content {
padding:1.618em 3.236em;
height:100%;
- /*max-width:1100px;*/
- max-width: 100%;
+ max-width:1100px;
+ /*max-width: 100%;*/
/*margin:auto;*/
}
diff --git a/docs/source/admin/quick_howto/anonymous_blocking.rst b/docs/source/admin/quick_howto/anonymous_blocking.rst
index 4ee0ad5..1d462a1 100644
--- a/docs/source/admin/quick_howto/anonymous_blocking.rst
+++ b/docs/source/admin/quick_howto/anonymous_blocking.rst
@@ -13,7 +13,7 @@
.. limitations under the License.
..
-.. _rl-anonymous_blocking-qht:
+.. _anonymous_blocking-qht:
**************************************
Configure Anonymous Blocking
@@ -33,14 +33,14 @@ Anonymous Blocking uses a configuration file in JSON format to define blocking r
"name": "Anonymous IP Blocking Policy",
"anonymousIp": { "blockAnonymousVPN": true,
- "blockHostingProvider": true,
+ "blockHostingProvider": true,
"blockPublicProxy": true,
"blockTorExitNode": true},
-
+
"ip4Whitelist": ["192.168.30.0/24", "10.0.2.0/24", "10.1.1.1/32"],
-
+
"ip6Whitelist": ["2001:550:90a::/48", "::1/128"],
-
+
"redirectUrl": "http://youvebeenblocked.com"
}
@@ -83,5 +83,5 @@ Anonymous Blocking extends the field of "rtype" and adds a new field "ANON_BLOCK
If rtype=ANON_BLOCK then the client's IP was found in the Anonymous IP Database and was blocked.
-
+
diff --git a/docs/source/admin/quick_howto/dnssec.rst b/docs/source/admin/quick_howto/dnssec.rst
index d336057..4af1ce3 100644
--- a/docs/source/admin/quick_howto/dnssec.rst
+++ b/docs/source/admin/quick_howto/dnssec.rst
@@ -1,19 +1,19 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
-.. _rl-dnssec-qht:
+.. _dnssec-qht:
****************
Configure DNSSEC
@@ -29,13 +29,13 @@ Configure DNSSEC
:scale: 100%
:align: center
-2) Generate keys for a CDN by clicking Generate Keys then entering the following information:
-
+2) Generate keys for a CDN by clicking Generate Keys then entering the following information:
+
- Expiration in days for the Zone Signing Key (ZSK)
- Expiration in days for the Key Signing Key (KSK)
- Effective Date
- Once the required information has been entered click on the 'Generate Keys' button.
+ Once the required information has been entered click on the 'Generate Keys' button.
Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.
@@ -43,7 +43,7 @@ Configure DNSSEC
:scale: 100%
:align: center
-3) In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN's domain (e.g. If the CDN's domain is 'cdn.kabletown.net' the parent zone is 'kabletown.net').
+3) In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN's domain (e.g. If the CDN's domain is 'cdn.kabletown.net' the parent zone is 'kabletown.net').
If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.
@@ -51,22 +51,22 @@ Configure DNSSEC
:scale: 70%
:align: center
-4) Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.
-
- Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.
+4) Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.
+
+ Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.
- This will add a 'dnssec.enabled = "true"' entry to CRConfig for the chosen CDN.
+ This will add a 'dnssec.enabled = "true"' entry to CRConfig for the chosen CDN.
.. image:: dnssec04.png
:scale: 70%
:align: center
-5) DNSSEC should now be active on your CDN and Traffic Router should be signing responses.
-
- A dig command with +dnssec added should show you the signed responses.
+5) DNSSEC should now be active on your CDN and Traffic Router should be signing responses.
+
+ A dig command with +dnssec added should show you the signed responses.
``dig edge.cdn.kabletown.net. +dnssec``
-6) When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.
+6) When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.
- A new KSK can be generated by clicking the 'Regenerate KSK' button on the Manage DNSSEC Keys screen (see screenshot above).
+ A new KSK can be generated by clicking the 'Regenerate KSK' button on the Manage DNSSEC Keys screen (see screenshot above).
diff --git a/docs/source/admin/quick_howto/federations.rst b/docs/source/admin/quick_howto/federations.rst
index a57473e..279e8a5 100644
--- a/docs/source/admin/quick_howto/federations.rst
+++ b/docs/source/admin/quick_howto/federations.rst
@@ -1,26 +1,26 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
-.. _rl-federations-qht:
+.. _federations-qht:
*********************
Configure Federations
*********************
-1) Create a user with a federations role (Misc -> Users -> Add User). This user will have the ability to perform the following actions:
-
+1) Create a user with a federations role (Misc -> Users -> Add User). This user will have the ability to perform the following actions:
+
- Edit the federation
- Delete the federation
- Add IPV4 resolvers
@@ -38,17 +38,17 @@ Configure Federations
:scale: 100%
:align: center
-4) After the Federation is added, Traffic Ops will display the Federation.
+4) After the Federation is added, Traffic Ops will display the Federation.
- Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.
+ Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.
- If no further action is necessary, the Close button will close the window and display the list of all Federations.
+ If no further action is necessary, the Close button will close the window and display the list of all Federations.
.. image:: federation03.png
:scale: 100%
:align: center
-
+
**The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.**
5) The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.
@@ -73,19 +73,19 @@ Configure Federations
{"alerts":[{"level":"success","text":"Successfully logged in."}]}
6) The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers
-
+
Example::
$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
- {"federations": [
- { "deliveryService": "images-c1",
- "mappings":
+ {"federations": [
+ { "deliveryService": "images-c1",
+ "mappings":
{ "resolve4": [ "8.8.8.8/32", "8.8.4.4/32" ],
"resolve6": ["2001:4860:4860::8888/128", "2001:4860:4860::8844"]
- }
- }
- ]
+ }
+ }
+ ]
}'
HTTP/1.1 200 OK
@@ -132,4 +132,4 @@ Configure Federations
;; Query time: 9 msec
;; SERVER: 10.10.10.10#53(10.10.10.10)
;; WHEN: Wed Dec 2 22:05:26 2015
- ;; MSG SIZE rcvd: 84
\ No newline at end of file
+ ;; MSG SIZE rcvd: 84
diff --git a/docs/source/admin/quick_howto/multi_site.rst b/docs/source/admin/quick_howto/multi_site.rst
index 6e0f0dd..2f3fb20 100644
--- a/docs/source/admin/quick_howto/multi_site.rst
+++ b/docs/source/admin/quick_howto/multi_site.rst
@@ -1,19 +1,19 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
-.. _rl-multi-site-origin-qht:
+.. _multi-site-origin-qht:
***************************
Configure Multi Site Origin
@@ -50,7 +50,7 @@ Configure Multi Site Origin
:scale: 100%
:align: center
-.. Note:: “Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The [...]
+.. Note:: “Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The [...]
1. If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.
2. If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.
diff --git a/docs/source/admin/quick_howto/regionalgeo.rst b/docs/source/admin/quick_howto/regionalgeo.rst
index 36fd508..0b6aa35 100644
--- a/docs/source/admin/quick_howto/regionalgeo.rst
+++ b/docs/source/admin/quick_howto/regionalgeo.rst
@@ -13,7 +13,7 @@
.. limitations under the License.
..
-.. _rl-regionalgeo-qht:
+.. _regionalgeo-qht:
**************************************
Configure Regional Geo-blocking (RGB)
diff --git a/docs/source/admin/quick_howto/steering.rst b/docs/source/admin/quick_howto/steering.rst
index 96ae5bd..61fa862 100644
--- a/docs/source/admin/quick_howto/steering.rst
+++ b/docs/source/admin/quick_howto/steering.rst
@@ -13,7 +13,7 @@
.. limitations under the License.
..
-.. _rl-steering-qht:
+.. _steering-qht:
***********************************
Configure Delivery Service Steering
diff --git a/docs/source/admin/traffic_monitor.rst b/docs/source/admin/traffic_monitor.rst
index 859000a..c4e2ad1 100755
--- a/docs/source/admin/traffic_monitor.rst
+++ b/docs/source/admin/traffic_monitor.rst
@@ -1,25 +1,25 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
***************************************
Traffic Monitor Administration (Legacy)
***************************************
-.. _rl-tm-java:
+.. _tm-java:
-* These instructions are for the legacy Java Traffic Monitor, for the new Golang version, see :ref:`here <rl-tm-golang>`.
+* These instructions are for the legacy Java Traffic Monitor, for the new Golang version, see :ref:`here <tm-golang>`.
Installing Traffic Monitor
==========================
@@ -137,7 +137,7 @@ The following are requirements to ensure an accurate set up:
#. Update the 'allow_ip' and 'allow_ip6' parameters in the profiles of all caches defined in traffic ops, both edge and mid,
with the address of the traffic monitor being installed, so that the traffic servers will allow this Traffic Monitor
to access the astats plugin.
- For details see :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
+ For details see :ref:`param-prof` in the *Configuring Traffic Ops* section.
#. Start Tomcat: ``sudo service tomcat start`` ::
diff --git a/docs/source/admin/traffic_monitor_golang.rst b/docs/source/admin/traffic_monitor_golang.rst
index 649cf78..8ac9baf 100755
--- a/docs/source/admin/traffic_monitor_golang.rst
+++ b/docs/source/admin/traffic_monitor_golang.rst
@@ -1,25 +1,25 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
******************************
Traffic Monitor Administration
******************************
-.. _rl-tm-golang:
+.. _tm-golang:
-* These instructions are for the Golang Traffic Monitor, for the legacy Java version, see :ref:`here <rl-tm-java>`.
+* These instructions are for the Golang Traffic Monitor, for the legacy Java version, see :ref:`here <tm-java>`.
Installing Traffic Monitor
==========================
@@ -36,7 +36,7 @@ The following are requirements to ensure an accurate set up:
1. Enter the Traffic Monitor server into Traffic Ops
2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
3. Install Traffic Monitor: ``sudo yum -y install traffic_monitor``
-4. Configure Traffic Monitor. See :ref:`here <rl-tm-configure>`
+4. Configure Traffic Monitor. See :ref:`here <tm-configure>`
5. Start the service: ``sudo service traffic_monitor start`` ::
Starting traffic_monitor:
@@ -49,7 +49,7 @@ Configuring Traffic Monitor
Configuration Overview
----------------------
-.. _rl-tm-configure:
+.. _tm-configure:
Traffic Monitor is configured via two JSON configuration files, ``traffic_ops.cfg`` and ``traffic_monitor.cfg``, by default located in the ``conf`` directory in the install location.
diff --git a/docs/source/admin/traffic_ops/configuration.rst b/docs/source/admin/traffic_ops/configuration.rst
index 0661f90..92335b2 100644
--- a/docs/source/admin/traffic_ops/configuration.rst
+++ b/docs/source/admin/traffic_ops/configuration.rst
@@ -120,7 +120,7 @@ You will need to update the file ``/opt/traffic_ops/app/conf/cdn.conf`` with the
Content Delivery Networks
=========================
-.. _rl-param-prof:
+.. _param-prof:
Profile Parameters
------------------
@@ -199,7 +199,7 @@ Below is a list of cache parameters that are likely to need changes from the def
+--------------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Drive_Letters | storage.config | The letter part of the disks, in the same example as above set this to ``a,b,c,d,e,f`` |
+--------------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`rl-purge`) |
+| purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`purge`) |
+--------------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| coalesce_masklen_v4 | ip_allow.config | The mask length to use when coalescing IPv4 networks into one line using `the NetAddr\:\:IP Perl library. <http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm>`_ |
+--------------------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
diff --git a/docs/source/admin/traffic_ops/default_profiles.rst b/docs/source/admin/traffic_ops/default_profiles.rst
index a7f98de..6ce28d4 100644
--- a/docs/source/admin/traffic_ops/default_profiles.rst
+++ b/docs/source/admin/traffic_ops/default_profiles.rst
@@ -16,16 +16,16 @@
.. index::
Traffic Ops - Default Profiles
-.. _rl-to-default-profiles:
+.. _to-default-profiles:
Traffic Ops - Default Profiles
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-Traffic Ops has the concept of :ref:`rl-working-with-profiles`, which are an integral component of Traffic Ops. To get started, a set of default Traffic Ops profiles are provided. These can be imported into Traffic Ops, and are required by the Traffic Control components Traffic Router, Traffic Monitor, and Apache Traffic Server (Edge-tier and Mid-tier caches).
+Traffic Ops has the concept of :ref:`working-with-profiles`, which are an integral component of Traffic Ops. To get started, a set of default Traffic Ops profiles are provided. These can be imported into Traffic Ops, and are required by the Traffic Control components Traffic Router, Traffic Monitor, and Apache Traffic Server (Edge-tier and Mid-tier caches).
`Download Default Profiles from here <http://trafficcontrol.apache.org/downloads/profiles/>`_
-.. _rl-to-profiles-min-needed:
+.. _to-profiles-min-needed:
Minimum Traffic Ops Profiles needed
-----------------------------------
@@ -53,4 +53,4 @@ Steps to Import a Profile
#. Click 'Import'
-#. Continue these steps for each of the :ref:`rl-to-profiles-min-needed`.
+#. Continue these steps for each of the :ref:`to-profiles-min-needed`.
diff --git a/docs/source/admin/traffic_ops/extensions.rst b/docs/source/admin/traffic_ops/extensions.rst
index 4aceebb..8e52d10 100644
--- a/docs/source/admin/traffic_ops/extensions.rst
+++ b/docs/source/admin/traffic_ops/extensions.rst
@@ -1,32 +1,33 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _admin-to-ext-script:
+*******************************
Managing Traffic Ops Extensions
*******************************
-Each script is a separate bash script located in ``$TO_HOME/bin/checks/``.
+Each script is a separate bash script located in ``$TO_HOME/bin/checks/``.
The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running ``/opt/traffic_ops/app/bin/extensions -a``.
-The below extensions are automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_ops/app/db/seeds.sql``). However, cron must still be configured to run these checks periodically.
+The below extensions are automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_ops/app/db/seeds.sql``). However, cron must still be configured to run these checks periodically.
The scripts are called as follows: ::
-
+
$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
where:
@@ -42,9 +43,9 @@ Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to ma
::
-
+
PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
-
+
# IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
@@ -53,11 +54,11 @@ Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to ma
# IPv6 ping examples
*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
+
# iLO ping
18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
-
+
# MTU ping
45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
@@ -67,22 +68,22 @@ Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to ma
# FQDN
27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # DSCP
+
+ # DSCP
36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
+
# RTR
10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
+
# CHR
*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
+
# CDU
20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
+
# ORT
40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
+
diff --git a/docs/source/admin/traffic_ops/installation.rst b/docs/source/admin/traffic_ops/installation.rst
index 144aaa6..807d3a6 100644
--- a/docs/source/admin/traffic_ops/installation.rst
+++ b/docs/source/admin/traffic_ops/installation.rst
@@ -16,7 +16,7 @@
.. index::
Traffic Ops - Installing
-.. _rl-to-install:
+.. _to-install:
Traffic Ops - Installing
%%%%%%%%%%%%%%%%%%%%%%%%
@@ -236,7 +236,7 @@ Installation
Traffic Ops is now installed!
-**To complete the Traffic Ops Setup See:** :ref:`rl-to-default-profiles`
+**To complete the Traffic Ops Setup See:** :ref:`to-default-profiles`
Upgrading Traffic Ops
@@ -248,6 +248,6 @@ To upgrade from older Traffic Ops versions, run the following commands as the ro
pushd /opt/traffic_ops/app/
PERL5LIB=/opt/traffic_ops/app/lib:/opt/traffic_ops/app/local/lib/perl5 ./db/admin.pl --env production upgrade
-After this completes, see :ref:`rl-to-install` to run the ``postinstall`` script.
+After this completes, see :ref:`to-install` to run the ``postinstall`` script.
Once the ``postinstall`` script, has finished, run the following command as the root user (or with ``sudo``):
``systemctl start traffic_ops``
diff --git a/docs/source/admin/traffic_ops/migration_from_10_to_20.rst b/docs/source/admin/traffic_ops/migration_from_10_to_20.rst
index 4133fee..6a66ce8 100644
--- a/docs/source/admin/traffic_ops/migration_from_10_to_20.rst
+++ b/docs/source/admin/traffic_ops/migration_from_10_to_20.rst
@@ -1,88 +1,71 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. index::
- Traffic Ops - Migrating from Traffic Ops 1.x to Traffic Ops 2.x
-
-.. _rl-ps:
+ Traffic Ops - Migrating from Traffic Ops 1.x to Traffic Ops 2.x
+
+.. _ps:
Traffic Ops - Migrating from 1.x to 2.x
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-In Traffic Ops 2.x MySQL was removed and Postgres was replaced as the database of choice for the unforeseen future. A Docker-based migration tool was developed to
-help with that conversion using an open source Postgres tool called `pgloader <http://pgloader.io/>`_. The following instructions will help configuring the Migration tool
+In Traffic Ops 2.x the database used to store CDN information was changed from MySQL to PostgreSQL. PostgreSQL will remain the Traffic Ops database for the foreseeable future.
+A Docker-based migration tool was developed to help with the conversion process using an open-source PostgreSQL tool called `pgloader <http://pgloader.io/>`_.
+The following instructions will help configuring the Migration tool
System Requirements
-------------------
The user must have the following for a successful minimal install:
* CentOS 7.2+
-* Docker installed (this migration was tested against version **docker-engine-selinux-17.05.0.ce-1.el7.centos.noarch.rpm**)
-* Postgres has been installed according to :ref:`rl-to-install`
-
-Setup the traffic_ops_db directory
-----------------------------------
-
- Modify /opt dir permission to make it writable and owned by postgres:postgres
+* Docker installed [1]_
+* PostgreSQL installed according to :ref:`to-install`
- ::
+Setup the ``traffic_ops_db`` Directory
+--------------------------------------
- $ sudo chmod 755 /opt
-
- Download the Traffic Control tarball for 2.0.0
+#. Modify the permissions of the ``/opt`` directory to make it writable by and owned by the ``postgres`` user and the ``postgres`` group. This can easily be accomplished by running the command ``chmod 755 /opt`` as the root user, or with ``sudo``.
- ::
+#. Download the Traffic Control 2.0.0 tarball like so::
- $ cd /opt
- $ wget https://dist.apache.org/repos/dist/release/incubator/trafficcontrol/<tarball_version>
+ cd /opt
+ wget https://dist.apache.org/repos/dist/release/incubator/trafficcontrol/<tarball_version>
- Extract the **traffic_ops_db** dir to **/opt/traffic_ops_db**
+#. Extract the **only** the ``traffic_ops_db`` directory to ``/opt/traffic_ops_db``::
- ::
-
- $ tar -zxvf trafficcontrol-incubating-<version>.tar.gz --strip=1 trafficcontrol-incubating-<version>/traffic_ops_db
- $ sudo chown -R postgres:postgres /opt/traffic_ops_db
-
-.. highlight:: none
+ tar -zxvf trafficcontrol-incubating-<version>.tar.gz --strip=1 trafficcontrol-incubating-<version>/traffic_ops_db
+ chown -R postgres:postgres /opt/traffic_ops_db
Migration Preparation
---------------------
-Be sure there is connectivity between your MySQL server's IP address/port and your Postgres server's IP address/port.
+Be sure there is connectivity between your MySQL server's IP address/port and your PostgreSQL server's IP address/port.
Navigating the Database Migration
---------------------------------
-Begin the database migration after settings up the **/opt/traffic_ops_db** directory
-
- Switch to the postgres user so permissions stay intact.
- ::
-
- $ su - postgres
- $ cd /opt/traffic_ops_db/
-
-1. Configure the **/opt/traffic_ops_db/pg-migration/mysql-to-postgres.env** migration for your source MySQL and target Postgres settings
-
-
-2. Run the migration, watch the console output for any errors (it may take some time)
- ::
-
- $ ./migrate.sh
-
+Begin the database migration after settings up the ``/opt/traffic_ops_db`` directory
+Switch to the postgres user, so that permissions remain intact.::
- Your MySQL data should now be ported into your new instance of Postgres!
+ su - postgres
+ cd /opt/traffic_ops_db/
+#. Configure the ``/opt/traffic_ops_db/pg-migration/mysql-to-postgres.env`` file for your source MySQL and target PostgresQL settings.
+ This part ought to be self-explanatory, given the names used in that file.
+#. Run the ``migrate.sh`` script, watching the console output for any errors (this may take some time).
+Your MySQL data should now be ported into your new instance of PostgreSQL!
+.. [1] This migration was tested against version ``docker-engine-selinux-17.05.0.ce-1``
diff --git a/docs/source/admin/traffic_ops/migration_from_20_to_22.rst b/docs/source/admin/traffic_ops/migration_from_20_to_22.rst
index db642a8..1caa149 100644
--- a/docs/source/admin/traffic_ops/migration_from_20_to_22.rst
+++ b/docs/source/admin/traffic_ops/migration_from_20_to_22.rst
@@ -1,137 +1,151 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Traffic Ops - Migrating from 2.0 to 2.2
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Per-DeliveryService Routing Names
---------------------------------
-Before this release, DNS Delivery Services were hardcoded to use the name "edge", i.e. "edge.myds.mycdn.com", and HTTP Delivery Services use the name "tr" (or previously "ccr"), i.e. "tr.myds.mycdn.com". As of 2.2, Routing Names will default to "cdn" if left unspecified and can be set to any arbitrary non-dotted hostname.
+Before this release, DNS Delivery Services were hard-coded to use the name ``edge``, so that URLs would appear as e.g. ``edge.myds.mycdn.com``, and HTTP Delivery Services use the name ``tr`` [1]_, e.g. ``tr.myds.mycdn.com``. As of Traffic Control version 2.2, DNS routing names will default to ``cdn`` if left unspecified and can be set to any valid hostname, provided it does not contain the ``.`` character.
-Pre-2.2 the HTTP Routing Name is configurable via the http.routing.name option in in the Traffic Router http.properties config file. If your CDN uses that option to change the name from "tr" to something else, then you will need to perform the following steps for each CDN affected:
+Prior to Traffic Control 2.2, the HTTP routing name was configurable via the ``http.routing.name`` option in in the Traffic Router ``http.properties`` configuration file. If your CDN uses that option to change the name from ``tr`` to something else, then you will need to perform the following steps for each CDN affected:
-1. In Traffic Ops, create the following profile parameter (double-check for typos, trailing spaces, etc):
+#. In Traffic Portal (if possible, else use the legacy Traffic Ops UI), create the following profile parameter ('Configure' -> 'Parameters' -> '+'). Be sure to double-check for typos, trailing spaces, etc.
- * **name**: upgrade_http_routing_name
- * **config file**: temp
- * **value**: whatever value is used for the affected CDN's http.routing.name
+ * name
+ upgrade_http_routing_name
-2. Add this parameter to a single profile in the affected CDN
+ * config_file
+ temp
-With those profile parameters in place Traffic Ops can be safely upgraded to 2.2. Before taking a post-upgrade snapshot, make sure to check your Delivery Service example URLs for unexpected Routing Name changes. Once Traffic Ops has been upgraded to 2.2 and a post-upgrade snapshot has been taken, your Traffic Routers can be upgraded to 2.2 (Traffic Routers must be upgraded after Traffic Ops so that they can work with custom per-DeliveryService Routing Names).
+ * value
+ Whatever value is used for the affected CDN's ``http.routing.name``
+
+#. Add this parameter to a single profile in the affected CDN
+
+With those profile parameters in place, Traffic Ops can be safely upgraded to 2.2. Before taking a post-upgrade snapshot, make sure to check your Delivery Service example URLs for unexpected routing name changes. Once Traffic Ops has been upgraded to 2.2 and a post-upgrade snapshot has been taken, your Traffic Routers can be upgraded to 2.2 (Traffic Routers must be upgraded after Traffic Ops so that they can work with custom per-Delivery Service routing names).
Apache Traffic Server 7.x (Cachekey Plugin)
-------------------------------------------
-In Traffic Ops 2.2 we have added support for Apache Traffic Server 7.x. With 7.x comes support for the new cachekey plugin which replaces the cacheurl plugin which is now deprecated.
-While not needed immediately it is recommended to start replacing cacheurl usages with cachekey as soon as possible because ATS 6.x already supports the new cachekey plugin.
+In Traffic Ops 2.2 we have added support for Apache Traffic Server (ATS) 7.x. With 7.x comes support for the new Cachekey Plugin which replaces the now-deprecated Cacheurl Plugin.
+While not needed immediately it is recommended to start replacing Cacheurl usages with Cachekey as soon as possible, because ATS 6.x already supports the new Cachekey Plugin.
-It is also recommended to thoroughly vet your cachekey replacement by comparing with an existing key value. There are inconsistencies in the 6.x version of cachekey which have been
-fixed in 7.x (or require this patch(`cachekeypatch`_) on 6.x to match 7.x). So to ensure you have a matching key value you should use the xdebug plugin before fully implementing your cachekey replacement.
+It is also recommended to thoroughly vet your Cachekey replacement by comparing with an existing key value. There are inconsistencies in the 6.x version of Cachekey which have been
+fixed in 7.x (or require this patch(`cachekeypatch`_) on 6.x to match 7.x). So to ensure you have a matching key value you should use the XDebug Plugin before fully implementing your Cachekey replacement.
.. _cachekeypatch: https://github.com/apache/trafficserver/commit/244288fab01bdad823f9de19dcece62a7e2a0c11
-First if you are currently using a regex for your delivery service you will have to remove that existing value. Then you will need to make a new DS profile and assign parameters in
-it to the cachekey.config file.
+First, if you are currently using a regular expression for your Delivery Service you will have to remove that existing value. Then you will need to make a new Delivery Service profile and assign parameters to it that use the ``cachekey.config`` file.
Some common parameters are
-.. highlight:: none
+ static-prefix
+ This is used for a simple domain replacement.
+
+ separator
+ Used by Cachekey and in general is always a single space.
+
+ remove-path
+ Removes path information from the URL.
-::
+ remove-all-params
+ Removes query parameters from the URL.
- static-prefix - This is used for a simple domain replacement
- separator - Used by cachekey and in general is always a single space
- remove-path - Removes path information from the URL
- remove-all-params - Removes parameters from the URL
- capture-prefix-uri - This is usually used in combination with remove-path and remove-all-params.
- Capture-prefix-uri will let you use your own full regex value for non simple cases
+ capture-prefix-uri
+ This is usually used in concert with remove-path and remove-all-params parameters. Capture-prefix-uri will let you use your own, full regular expression for non-trivial cases.
Examples of Cacheurl to Cachekey Replacements
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-**Original regex value:**
+Static Prefix Example
+"""""""""""""""""""""
+Original regex value: ::
-``http://test.net/(.*) http://test-cdn.net/$1``
+ http://test.net/(.*) http://test-cdn.net/$1
-**Cachekey parameters:**
+.. table:: Cachekey Parameters
-+---------------+-----------------+---------------------------------+
-| Parameter | File | Value |
-+===============+=================+=================================+
-| static-prefix | cachekey.config | ``http://test-cdn.net/`` |
-+---------------+-----------------+---------------------------------+
-| separator | cachekey.config | (empty space) |
-+---------------+-----------------+---------------------------------+
+ +---------------+-----------------+---------------------------------+
+ |Parameter |File |Value |
+ +===============+=================+=================================+
+ | static-prefix | cachekey.config | ``http://test-cdn.net/`` |
+ +---------------+-----------------+---------------------------------+
+ | separator | cachekey.config | (empty space) |
+ +---------------+-----------------+---------------------------------+
-**Original regex value:**
-``http://([^?]+)(?:?|$) http://test-cdn.net/$1``
+Removing Query Parameters and Path Information
+""""""""""""""""""""""""""""""""""""""""""""""
+Original regex value: ::
-**Cachekey parameters:**
+ http://([^?]+)(?:?|$) http://test-cdn.net/$1
-+-----------------------+-----------------+-----------------------------------------------------+
-| Parameter | File | Value |
-+=======================+=================+=====================================================+
-| remove-path | cachekey.config | true |
-+-----------------------+-----------------+-----------------------------------------------------+
-| remove-all-params | cachekey.config | true |
-+-----------------------+-----------------+-----------------------------------------------------+
-| separator | cachekey.config | (empty space) |
-+-----------------------+-----------------+-----------------------------------------------------+
-| capture-prefix-uri | cachekey.config | ``/https?:\/\/([^?]*)/http:\/\/test-cdn.net\/$1/`` |
-+-----------------------+-----------------+-----------------------------------------------------+
+.. table:: Cachekey Parameters
-Also note the ``s?`` used here so that both http and https requests will end up with the same key value
+ +-----------------------+-----------------+-----------------------------------------------------+
+ |Parameter |File |Value |
+ +=======================+=================+=====================================================+
+ | remove-path | cachekey.config | true |
+ +-----------------------+-----------------+-----------------------------------------------------+
+ | remove-all-params | cachekey.config | true |
+ +-----------------------+-----------------+-----------------------------------------------------+
+ | separator | cachekey.config | (empty space) |
+ +-----------------------+-----------------+-----------------------------------------------------+
+ | capture-prefix-uri | cachekey.config | ``/https?:\/\/([^?]*)/http:\/\/test-cdn.net\/$1/`` |
+ +-----------------------+-----------------+-----------------------------------------------------+
-**Original regex value:**
+Also note the ``s?`` used here so that both HTTP and HTTPS requests will end up with the same key value
-``http://test.net/([^?]+)(?:\?|$) http://test-cdn.net/$1``
-**Cachekey parameters:**
+Removing Query Parameters with a Static Prefix
+""""""""""""""""""""""""""""""""""""""""""""""
+Original regex value: ::
-+-------------------+-----------------+---------------------------------+
-| Parameter | File | Value |
-+===================+=================+=================================+
-| static-prefix | cachekey.config | ``http://test-cdn.net/`` |
-+-------------------+-----------------+---------------------------------+
-| separator | cachekey.config | (empty space) |
-+-------------------+-----------------+---------------------------------+
-| remove-all-params | cachekey.config | true |
-+-------------------+-----------------+---------------------------------+
+ http://test.net/([^?]+)(?:\?|$) http://test-cdn.net/$1
-.. _ApacheTrafficServerDocs: https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html
+.. table:: Cachekey Parameters
-Further documentation on the cachekey plugin can be found at `ApacheTrafficServerDocs`_
+ +-------------------+-----------------+---------------------------------+
+ |Parameter |File |Value |
+ +===================+=================+=================================+
+ | static-prefix | cachekey.config | ``http://test-cdn.net/`` |
+ +-------------------+-----------------+---------------------------------+
+ | separator | cachekey.config | (empty space) |
+ +-------------------+-----------------+---------------------------------+
+ | remove-all-params | cachekey.config | true |
+ +-------------------+-----------------+---------------------------------+
+
+.. note:: Further documentation on the Cachekey Plugin can be found at `the Apache Traffic Server Documentation <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html>`_.
Apache Traffic Server 7.x (Logging)
--------------------------------------------
-Trafficserver v7 has changed the logging format. Previously this was an xml file and now it is a lua file. Traffic Control compensates for this
-automatically depending upon the filename used for the logging parameters. Previously the file used was ``logs_xml.config``, for ATS 7 it is now
-``logging.config``. The same parameters will work this new file, ``LogFormat.Format``, ``LogFormat.Name``, ``LogObject.Format`` etc.
+-----------------------------------
+Traffic Server has changed the logging format as of version 7.0. Previously, this was ``logs_xml.config`` - an XML file - and now it is ``logging.config`` - a Lua file. Traffic Control compensates for this
+automatically depending upon the filename used for the logging parameters. The same parameters will work this new file, ``LogFormat.Format``, ``LogFormat.Name``, ``LogObject.Format`` etc.
Traffic Ops Profile Modifications
--------------------------------------------
-When upgrading to ATS 7.x, the Traffic Ops EDGE and MID cache profiles must be modified to provide new configuration values. Trafficserver recommends changes to the following parameters: https://cwiki.apache.org/confluence/display/TS/Upgrading+to+v7.0
+---------------------------------
+When upgrading to ATS 7.x, the Traffic Ops EDGE and MID cache profiles must be modified to provide new configuration values. Traffic Server's recommended parameter changes can be found `on their wiki <https://cwiki.apache.org/confluence/display/TS/Upgrading+to+v7.0>`_.
-Most users of Traffic Control have enough profiles where making these modifications manually is a tedious and time consuming process. A new utility `traffic_ops/install/bin/convert_profile/convert_profile` is provided to automatically convert an ATS6 profile to an ATS7 profile. This utility can be reused in the future for ATS7->8 as well.
+Most users of Traffic Control have enough profiles to make the task of making these modifications manually a tedious and time-consuming process. A new utility ``traffic_ops/install/bin/convert_profile/convert_profile`` is provided to automatically convert an ATS 6.x profile into an ATS 7.x profile. This utility can be reused in the future for converting ATS 7.x profiles into ATS 8.x profiles.
Usage example:
- 1. Use Traffic Portal GUI to export profile to JSON
- 2. Modify the trafficserver version numbers to match your current Traffic Server v6 RPM version and planned Traffic Server v7 RPM version
- 3. Run ``convert_profile -input_profile <exported_file> -rules convert622to713.json -out <new_profile_name>``
- 4. Review output messages and make manual updates if needed. If you have modified a default value the script also wants to change, it will prompt you to make the update manually. You may either do this directly in the JSON file or through the Traffic Portal GUI after import.
- 5. Use Traffic Portal GUI to import the newly created profile
+ #. Use Traffic Portal GUI to export profile to JSON ('Configure' -> 'Profiles' -> Desired profile -> 'More' -> 'Export Profile')
+ #. Modify the Traffic Server version numbers to match your current Traffic Server 6.x RPM version and planned Traffic Server 7.x RPM version
+ #. Run ``convert_profile -input_profile <exported_file> -rules convert622to713.json -out <new_profile_name>``
+ #. Review output messages and make manual updates as needed. If you have modified a default value which the script also wants to change, it will prompt you to make the update manually. You may either do this directly in the JSON file or through the Traffic Portal GUI after import.
+ #. Use Traffic Portal GUI to import the newly created profile ('Configure' -> 'Profiles' -> 'More' -> 'Import Profile')
+.. [1] Another previously-used name for HTTP Delivery Services was ``ccr``
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 97e20cb..79e015a 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -43,14 +43,14 @@ The following tabs are available in the menu at the top of the Traffic Ops user
| Table View | A real time view into the main performance indicators of the CDNs managed by Traffic Control. |
| | This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds. |
| | This is the default screen of Traffic Ops. |
- | | See :ref:`rl-health-table` for details. |
+ | | See :ref:`health-table` for details. |
+---------------+------------------------------------------------------------------------------------------------------------------------------------+
| Graph View | A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control. |
| | This view is sourced by the Traffic Monitor data and is updated every 10 seconds. |
| | On loading, this screen will show a history of 24 hours of data from Traffic Stats |
- | | See :ref:`rl-health-graph` for details. |
+ | | See :ref:`health-graph` for details. |
+---------------+------------------------------------------------------------------------------------------------------------------------------------+
- | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`rl-server-checks` |
+ | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`server-checks` |
+---------------+------------------------------------------------------------------------------------------------------------------------------------+
| Daily Summary | A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation |
| | per CDN. |
@@ -73,7 +73,7 @@ The following tabs are available in the menu at the top of the Traffic Ops user
+-------------------+------------------------------------------------------------------------------------------+
| Option | Description |
+===================+==========================================================================================+
- | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`rl-bulkserver` |
+ | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`bulkserver` |
+-------------------+------------------------------------------------------------------------------------------+
* **Parameters**
@@ -83,7 +83,7 @@ The following tabs are available in the menu at the top of the Traffic Ops user
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+=====================+=====================================================================================================================================================================+
- | Global Profile | The table of global parameters. See :ref:`rl-param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
+ | Global Profile | The table of global parameters. See :ref:`param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| All Cache Groups | The table of all parameters *that are assigned to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. |
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -105,15 +105,15 @@ The following tabs are available in the menu at the top of the Traffic Ops user
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+====================+===================================================================================================================================+
- | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`rl-generate-iso` |
+ | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`generate-iso` |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Queue Updates | Send Updates to the caches. See :ref:`rl-queue-updates` |
+ | Queue Updates | Send Updates to the caches. See :ref:`queue-updates` |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| DB Dump | Backup the Database to a .sql file. |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`rl-queue-updates` |
+ | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`queue-updates` |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`rl-purge` |
+ | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`purge` |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN. |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
@@ -132,9 +132,9 @@ The following tabs are available in the menu at the top of the Traffic Ops user
+--------------------+-------------------------------------------------------------------------------------------+
| Users | Create/Read/Update/Delete users |
+--------------------+-------------------------------------------------------------------------------------------+
- | Profiles | Create/Read/Update/Delete profiles. See :ref:`rl-working-with-profiles` |
+ | Profiles | Create/Read/Update/Delete profiles. See :ref:`working-with-profiles` |
+--------------------+-------------------------------------------------------------------------------------------+
- | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`rl-asn-czf` |
+ | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`asn-czf` |
+--------------------+-------------------------------------------------------------------------------------------+
| Hardware | Get detailed hardware information (note: this should be moved to a Traffic Ops Extension) |
+--------------------+-------------------------------------------------------------------------------------------+
@@ -177,7 +177,7 @@ The following tabs are available in the menu at the top of the Traffic Ops user
Health
======
-.. _rl-health-table:
+.. _health-table:
The Health Table
++++++++++++++++
@@ -194,14 +194,14 @@ The Health table is the default landing screen for Traffic Ops, it displays the
Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops.
-.. _rl-health-graph:
+.. _health-graph:
Graph View
++++++++++
The Graph View shows a live view of the last 24 hours of bits per seconds served and open connections at the edge in a graph. This data is sourced from Traffic Stats. If there are 2 CDNs configured, this view will show the statistis for both, and the graphs are stacked. On the left-hand side, the totals and immediate values as well as the percentage of total possible capacity are displayed. This view is update every 10 seconds.
-.. _rl-server-checks:
+.. _server-checks:
Server Checks
+++++++++++++
@@ -241,7 +241,7 @@ 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.
-.. _rl-server:
+.. _server:
Server
======
@@ -280,7 +280,7 @@ These are the types of servers that can be managed in Traffic Ops:
.. index::
Bulk Upload Server
-.. _rl-bulkserver:
+.. _bulkserver:
Bulk Upload Server
++++++++++++++++++
@@ -292,163 +292,184 @@ Delivery Service
The fields in the Delivery Service view are:
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Name | Description [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Active | Whether or not this delivery service is active on the CDN and is capable of traffic. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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.company.com/``. Must be all lowercase, no spaces or special characters. May contain dashes. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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 to. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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]_ [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Protocol | The protocol to serve this delivery service to the clients with: [...]
-| | [...]
-| | - HTTP: Delivery only HTTP traffic [...]
-| | - HTTPS: Delivery only HTTPS traffic [...]
-| | - HTTP AND HTTPS: Deliver both types of traffic. [...]
-| | - HTTP TO HTTPS: Delivery HTTP traffic as HTTPS traffic [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| DSCP Tag | The Differentiated Services Code Point (DSCP) value to mark IP packets to the client with. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Signing Algorithm | Type of URL signing method to sign the URLs: [...]
-| | [...]
-| | - null: token based auth is not enabled for this delivery service. [...]
-| | - “url_sig”: URL Sign token based auth is enabled for this delivery service. [...]
-| | - “uri_signing”: URI Signing token based auth is enabled for this delivery service. [...]
-| | [...]
-| | See :ref:`rl-signed-urls`. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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: [...]
-| | [...]
-| | - 0 use in cache key and hand up to origin: Each unique query string is treated as a unique URL. [...]
-| | - 1 Do not use in cache key, but pass up to origin: 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: 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`. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Geolocation Provider | Choose which Geolocation database provider, company that collects data on the location of IP addresses, to use. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Anonymous Blocking | Set to true to enable blocking of anonymous IPs for this delivery service. **Note:** Requires Geolocation provider's Anonymous IP database. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Geo Limit | Some services are intended to be limited by geography. The possible settings 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 Countries | How (if at all) is this service to be limited by geography. Example Country Codes: CA, IN, PR. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Geo Limit Redirect URL | Traffic Router will redirect to this URL when Geo Limit check fails. See :ref:`rl-tr-ngb` [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Regional Geoblocking | 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 "True", entering "False" allows you to turn off CDN response to IPv6 requests [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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. [...]
-| | [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| DNS Bypass IP | IPv4 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| DNS Bypass IPv6 | IPv6 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| DNS Bypass CNAME | Domain name to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| DNS Bypass TTL | TTL for the DNS bypass domain or IP when threshold exceeds [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| HTTP Bypass FQDN | Traffic Router will redirect to this FQDN (with the same path) when the Max Bps or Max Tps for this delivery service exceeds. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records. Setting too high or too low will result in poor caching performance. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Fair Queuing Pacing Rate Bps | 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. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Global Max TPS | The maximum transactions per se 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. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Max DNS Answers | It is used to restrict the number of cache IP addresses that the CCR will hand back. A numeric value from 1 to 15 which determines how many caches your content will be spread across in a particular site. When a customer requests your content they will get 1 to 15 IP addresses back they can use. These are rotated in each response. Ideally the number will reflect the amount of traffic. 1 = trial account with very little traffic, 2 = small prod [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Initial Dispersion | Determines number of machines content will be placed on within a cache group. Setting too high will result in poor caching performance. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Origin Server Base URL | The Origin Server’s base URL which 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 | Set True/False to enable/disable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Edge Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the [...]
-| | [...]
-| | - Action: Set [...]
-| | - Header Name: X-CDN [...]
-| | - Header Value: Foo [...]
-| | - Direction: Edge Response to Client [...]
-| | [...]
-| | See :ref:`rl-header-rewrite`. [1]_ [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Mid Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the [...]
-| | [...]
-| | - Action: Set [...]
-| | - Header Name: Host [...]
-| | - Header Value: code_abc123 [...]
-| | - Direction: Mid Request to Origin [...]
-| | [...]
-| | See :ref:`rl-header-rewrite`. [1]_ [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Traffic Router Additional Response Headers | List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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]_ [...]
-| | [...]
-| | **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 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 | Free 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. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Long Description 2 | Free text field not currently used in configuration. For example, you can use this field to describe your customer type. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Long Description 3 | Free text field not currently used in configuration. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Info URL | Free text field allowing you to enter a URL which provides information about the service. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| 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. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Origin Shield (Pipe Delimited String) | Add another forward proxy upstream of the mid caches. Example: go_direct=true will allow the Mid to hit the origin directly instead of failing if the origin shield is down. Experimental Feature. [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
-| Logs Enabled | Allows you to turn on/off logging for the service [...]
-+--------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...]
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Active | Whether or not this delivery service is active on the CDN and is capable of traffic. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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:`ds-types`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 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 to. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Protocol | The protocol to serve this delivery service to the clients with: |
+| | |
+| | - HTTP: Delivery only HTTP traffic |
+| | - HTTPS: Delivery only HTTPS traffic |
+| | - HTTP AND HTTPS: Deliver both types of traffic. |
+| | - HTTP TO HTTPS: Delivery HTTP traffic as HTTPS traffic |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DSCP Tag | The Differentiated Services Code Point (DSCP) value to mark IP packets to the client with. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Signing Algorithm | Type of URL signing method to sign the URLs: |
+| | |
+| | - null: token based auth is not enabled for this delivery service. |
+| | - “url_sig”: URL Sign token based auth is enabled for this delivery service. |
+| | - “uri_signing”: URI Signing token based auth is enabled for this delivery service. |
+| | |
+| | See :ref:`signed-urls`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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: |
+| | |
+| | 0. use in cache key and hand up to origin: Each unique query string is treated as a unique URL. |
+| | 1. Do not use in cache key, but pass up to origin: 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: 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:`regex-remap`. |
+| | |
+| | To set the qstring without the use of regex remap, or for further options, see :ref:`qstring-handling`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geolocation Provider | Choose which Geolocation database provider, company that collects data on the location of IP addresses, to use. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Anonymous Blocking | Set to true to enable blocking of anonymous IPs for this delivery service. **Note:** Requires Geolocation provider's Anonymous IP database. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit | Some services are intended to be limited by geography. The possible settings 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 Countries | How (if at all) is this service to be limited by geography. Example Country Codes: CA, IN, PR. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Redirect URL | Traffic Router will redirect to this URL when Geo Limit check fails. See :ref:`tr-ngb` |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regional Geoblocking | 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 "True", entering "False" allows you to turn off CDN response to IPv6 requests |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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. |
+| | |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass IP | IPv4 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass IPv6 | IPv6 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass CNAME | Domain name to overflow requests when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS Bypass TTL | TTL for the DNS bypass domain or IP when threshold exceeds |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP Bypass FQDN | Traffic Router will redirect to this FQDN (with the same path) when the Max Bps or Max Tps for this delivery service exceeds. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records. Setting too high or too low will result in poor caching performance. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Fair Queuing Pacing Rate Bps | 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. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Global Max TPS | The maximum transactions per se 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. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Max DNS Answers | It is used to restrict the number of cache IP addresses that the CCR will hand back. A numeric value from 1 to 15 which determines how many caches your content will |
+| | be spread across in a particular site. When a customer requests your content they will get 1 to 15 IP addresses back they can use. These are rotated in each response. |
+| | Ideally the number will reflect the amount of traffic. 1 = trial account with very little traffic, 2 = small production service. Add 1 more server for every 20 Gbps |
+| | of traffic you expect at peak. So 20 Gbps = 3, 40 Gbps = 4, 60 Gbps = 5 |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Initial Dispersion | Determines number of machines content will be placed on within a cache group. Setting too high will result in poor caching performance. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Server Base URL | The Origin Server’s base URL which 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 | Set True/False to enable/disable the Multi Site Origin feature for this delivery service. See :ref:`multi-site-origin` |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this |
+| | long. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Edge Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The |
+| | action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will |
+| | determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include: |
+| | |
+| | - Action: Set |
+| | - Header Name: X-CDN |
+| | - Header Value: Foo |
+| | - Direction: Edge Response to Client |
+| | |
+| | See :ref:`header-rewrite`. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Mid Header Rewrite Rules | Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The |
+| | action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will |
+| | determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Examples include: |
+| | |
+| | - Action: Set |
+| | - Header Name: Host |
+| | - Header Value: code_abc123 |
+| | - Direction: Mid Request to Origin |
+| | |
+| | See :ref:`header-rewrite`. [1]_ |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Traffic Router Additional Response Headers | List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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]_ |
+| | |
+| | **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:`regex-remap`. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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 | Free 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. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 2 | Free text field not currently used in configuration. For example, you can use this field to describe your customer type. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description 3 | Free text field not currently used in configuration. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Info URL | Free text field allowing you to enter a URL which provides information about the service. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| 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. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Shield (Pipe Delimited String) | Add another forward proxy upstream of the mid caches. Example: go_direct=true will allow the Mid to hit the origin directly instead of failing if the origin shield is |
+| | down. Experimental Feature. |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Logs Enabled | Allows you to turn on/off logging for the service |
++--------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. [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.
@@ -457,7 +478,7 @@ The fields in the Delivery Service view are:
.. index::
Delivery Service Type
-.. _rl-ds-types:
+.. _ds-types:
Delivery Service Types
++++++++++++++++++++++
@@ -492,7 +513,7 @@ One of the most important settings when creating the delivery service is the sel
| 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:
+.. _federations:
Federations
+++++++++++
@@ -503,7 +524,7 @@ Federations
.. index::
Header Rewrite
-.. _rl-header-rewrite:
+.. _header-rewrite:
Header Rewrite Options and DSCP
+++++++++++++++++++++++++++++++
@@ -526,7 +547,7 @@ The deliveryservice screen also allows you to set the DSCP value of traffic sent
Token Based Authentication
Signed URLs
-.. _rl-signed-urls:
+.. _signed-urls:
Token Based Authentication
++++++++++++++++++++++++++
@@ -581,7 +602,7 @@ Generate URL Sig Keys
To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the **Generate URL Sig Keys** button at the bottom of the delivery service details screen.
-.. rl-parent-selection:
+.. parent-selection:
Parent Selection
++++++++++++++++
@@ -651,7 +672,7 @@ Parameters in the Mid (parent) profile that influence this feature:
| use_ip_address | parent.config | 0 | 1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation. |
+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-.. _rl-qstring-handling:
+.. _qstring-handling:
Qstring Handling
++++++++++++++++
@@ -665,12 +686,12 @@ Delivery services have a Query String Handling option that, when set to ignore,
| | | | for associated servers when assigned to a server profile. Value must be "consider" or "ignore". |
+-----------------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-.. _rl-multi-site-origin:
+.. _multi-site-origin:
Multi Site Origin
+++++++++++++++++
-.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`rl-multi-site-origin-qht` for more details.
+.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`multi-site-origin-qht` for more details.
Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the deli [...]
@@ -713,9 +734,9 @@ Parameters in the deliveryservice profile that influence this feature:
-see :ref:`rl-multi-site-origin-qht` for a *quick how to* on this feature.
+see :ref:`multi-site-origin-qht` for a *quick how to* on this feature.
-.. _rl-ccr-profile:
+.. _ccr-profile:
Traffic Router Profile
++++++++++++++++++++++
@@ -812,7 +833,7 @@ Traffic Router Profile
.. index::
Regex Remap Expression
-.. _rl-regex-remap:
+.. _regex-remap:
Regex Remap Expression
++++++++++++++++++++++
@@ -830,7 +851,7 @@ The regex remap expression allows to to use a regex and resulting match group(s)
HEADER_REGEXP
Delivery Service regexp
-.. _rl-ds-regexp:
+.. _ds-regexp:
Delivery Service Regexp
+++++++++++++++++++++++
@@ -856,7 +877,7 @@ Example:
.. index::
Static DNS Entries
-.. _rl-static-dns:
+.. _static-dns:
Static DNS Entries
++++++++++++++++++
@@ -865,14 +886,14 @@ Static DNS entries allow you to create other names *under* the delivery service
.. index::
Server Assignments
-.. _rl-assign-edges:
+.. _assign-edges:
Server Assignments
++++++++++++++++++
Click the **Server Assignments** button at the bottom of the screen to assign servers to this delivery service. Servers can be selected by drilling down in a tree, starting at the profile, then the cache group, and then the individual servers. Traffic Router will only route traffic for this delivery service to servers that are assigned to it.
-.. _rl-asn-czf:
+.. _asn-czf:
The Coverage Zone File and ASN Table
++++++++++++++++++++++++++++++++++++
@@ -917,7 +938,7 @@ The script that generates the CZF file is not part of Traffic Control, since it
.. note:: The ``"coordinates"`` section is optional and may be used by Traffic Router for localization in the case of a CZF "hit" where the zone name does not map to a Cache Group name in Traffic Ops (i.e. Traffic Router will route to the closest Cache Group(s) geographically).
-.. _rl-deep-czf:
+.. _deep-czf:
The Deep Coverage Zone File
+++++++++++++++++++++++++++
@@ -971,13 +992,13 @@ If the Traffic Router gets a DCZF "hit" for a requested Delivery Service that ha
.. note:: The ``"coordinates"`` section is optional.
-.. _rl-working-with-profiles:
+.. _working-with-profiles:
Parameters and Profiles
=======================
Parameters are shared between profiles if the set of ``{ name, config_file, value }`` is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (**Add Parameter** button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the **Misc > Profiles** view - just use the **Add/Copy Profile** button at the bottom of [...]
-.. seealso:: :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
+.. seealso:: :ref:`param-prof` in the *Configuring Traffic Ops* section.
@@ -988,7 +1009,7 @@ Tools
ISO
Generate ISO
-.. _rl-generate-iso:
+.. _generate-iso:
Generate ISO
++++++++++++
@@ -1086,7 +1107,7 @@ We have included the two scripts we use in the "misc" directory of the git repo:
These scripts were written to support a very narrow set of expectations and environment and are almost certainly not suitable to just drop in, but they might provide a good starting point.
-.. _rl-queue-updates:
+.. _queue-updates:
Queue Updates and Snapshot CRConfig
+++++++++++++++++++++++++++++++++++
@@ -1124,12 +1145,12 @@ To schedule updates for just one cache, use the "Server Checks" page, and click
.. index::
Snapshot CRConfig
-.. _rl-snapshot-crconfig:
+.. _snapshot-crconfig:
Snapshot CRConfig
^^^^^^^^^^^^^^^^^
-Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See :ref:`rl-ccr-profile` for more information on the CRConfig file.
+Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See :ref:`ccr-profile` for more information on the CRConfig file.
To create a new snapshot, use the *Tools > Snapshot CRConfig* menu:
@@ -1153,7 +1174,7 @@ To create a new snapshot, use the *Tools > Snapshot CRConfig* menu:
Invalidate Content
Purge
-.. _rl-purge:
+.. _purge:
Invalidate Content
==================
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index c7247e3..25b50a0 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -261,7 +261,7 @@ A table of your delivery services with the following columns:
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Active | When this is set to false, Traffic Router will not serve DNS or HTTP responses for this delivery service. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| Type | The type of content routing this delivery service will use. See :ref:`rl-ds-types`. |
+| Type | The type of content routing this delivery service will use. See :ref:`ds-types`. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Protocol | The protocol to serve this delivery service to the clients with: |
| | |
@@ -277,7 +277,7 @@ A table of your delivery services with the following columns:
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| DSCP | The DSCP value to mark IP packets to the client with. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
-| Signing Algorithm | See :ref:`rl-signed-urls`. |
+| Signing Algorithm | See :ref:`signed-urls`. |
| | - None |
| | - URL Signature Keys |
| | - URI Signing Keys |
@@ -290,9 +290,9 @@ A table of your delivery services with the following columns:
| | - drop at edge (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.) |
| | |
-| | Dropping query strings at the edge will preclude the use of a Regex Remap Expression. See :ref:`rl-regex-remap`. |
+| | Dropping query strings at the edge will preclude the use of a Regex Remap Expression. See :ref:`regex-remap`. |
| | |
-| | To set the qstring without the use of regex remap, or for further options, see :ref:`rl-qstring-handling`. |
+| | To set the qstring without the use of regex remap, or for further options, see :ref:`qstring-handling`. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
| Last Updated | Timestamp when the delivery service was last updated. |
+-------------------------------+-----------------------------------------------------------------------------------------------------------------------+
@@ -453,7 +453,7 @@ Profile management includes the ability to (where applicable):
- view profile delivery services
- view profile servers
-See :ref:`rl-working-with-profiles` for details.
+See :ref:`working-with-profiles` for details.
.. _tp-parameters:
@@ -691,7 +691,7 @@ Invalidate content includes the ability to (where applicable):
Generate ISO
++++++++++++
-See :ref:`rl-generate-iso`
+See :ref:`generate-iso`
User Admin
==========
diff --git a/docs/source/admin/traffic_router.rst b/docs/source/admin/traffic_router.rst
index 7250c78..91974e1 100644
--- a/docs/source/admin/traffic_router.rst
+++ b/docs/source/admin/traffic_router.rst
@@ -41,7 +41,7 @@ The following are requirements to ensure an accurate set up:
.. Note:: As of Traffic Control version 3.0, traffic router depends upon a package called 'tomcat'. This package should have been created when you built Traffic Router. If you get an error while installing the 'traffic_router' package make sure that the 'tomcat' package is in your package repository.
-5. Edit ``/opt/traffic_router/conf/traffic_monitor.properties`` and specify the correct online Traffic Monitor(s) for your CDN. See :ref:`rl-tr-config-files`
+5. Edit ``/opt/traffic_router/conf/traffic_monitor.properties`` and specify the correct online Traffic Monitor(s) for your CDN. See :ref:`tr-config-files`
# traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties
@@ -52,7 +52,7 @@ The following are requirements to ensure an accurate set up:
6. Start Traffic Router: ``sudo systemctl start traffic_router``, and test lookups with dig and curl against that server.
To restart, ``sudo systemctl stop traffic_router``, kill the traffic router process, and ``sudo systemctl restart traffic_router``
Also, crconfig previously recieved will be cached, and needs to be removed manually to actually be reloaded /opt/traffic_router/db/cr-config.json
-7. Snapshot CRConfig; See :ref:`rl-snapshot-crconfig`
+7. Snapshot CRConfig; See :ref:`snapshot-crconfig`
.. Note:: Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to ``ONLINE``.
@@ -66,9 +66,9 @@ Configuring Traffic Router
.. Note:: Pre-existing installations having configuration files in ``/opt/traffic_router/conf`` will still be used and honored for Traffic Router 1.5 and onward.
-For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See :ref:`rl-snapshot-crconfig` for more information. Please see the parameter documentation for Traffic Router in the Usi [...]
+For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See :ref:`snapshot-crconfig` for more information. Please see the parameter documentation for Traffic Router in the Using [...]
-.. _rl-tr-config-files:
+.. _tr-config-files:
Configuration files
-------------------
@@ -118,7 +118,7 @@ Configuration files
| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
| | cache.config.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new CRConfig | 60000 |
+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| startup.properties | various parameters | This configuration is used by systemctl to set environment variables when the traffic_router | |
+| startup.properties | various parameters | This configuration is used by systemctl to set environment variables when the traffic_router | |
| | | service is started. It primarily consists of command line settings for the Java process. | N/A |
+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
| log4j.properties | various parameters | Configuration of log4j is documented on their site; adjust as necessary based on needs | N/A |
@@ -128,7 +128,7 @@ Configuration files
| web.xml | various parameters | Default settings for all Web Applications running in the Traffic Router instance of Tomcat. | N/A |
+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-.. _rl-tr-dnssec:
+.. _tr-dnssec:
DNSSEC
======
@@ -143,7 +143,7 @@ Traffic Router currently supports DNSSEC with NSEC, however, NSEC3 and more conf
Operation
---------
-Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN's top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY rec [...]
+Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN's top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY rec [...]
Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service's zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD's zone. A DS record is generated from each zone's KSK and is placed in the CDN TLD's zone (e.g.: cdn.kabletown.net); the DS record for the CDN [...]
@@ -359,7 +359,7 @@ Sample Message
| | | NXDOMAIN (the domain/name requested does not exist) |
+------+---------------------------------------------------------------------+-----------------------------------------------------+
-.. _rl-tr-ngb:
+.. _tr-ngb:
GeoLimit Failure Redirect feature
=================================
@@ -388,7 +388,7 @@ The URL has 3 kinds of formats, which have different meanings:
3. URL with domain that doesn't match with the delivery service. For this URL, the router will return the configured url directly to the client.
-.. _rl-deep-cache:
+.. _deep-cache:
Deep Caching - Deep Coverage Zone Topology
==========================================
@@ -414,8 +414,8 @@ Getting started
What you need:
#. Edge caches deployed in "deep" locations and registered in Traffic Ops
-#. A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network prefixes (see :ref:`rl-deep-czf` for details)
-#. Deep caching parameters in the Traffic Router Profile (see :ref:`rl-ccr-profile` for details):
+#. A Deep Coverage Zone File (DCZF) mapping these deep cache hostnames to specific network prefixes (see :ref:`deep-czf` for details)
+#. Deep caching parameters in the Traffic Router Profile (see :ref:`ccr-profile` for details):
* ``deepcoveragezone.polling.interval``
* ``deepcoveragezone.polling.url``
@@ -435,7 +435,7 @@ client's request, Traffic Router will "fall back" to the regular CZF and
continue regular CZF routing from there.
-.. _rl-tr-steering:
+.. _tr-steering:
Steering feature
================
@@ -491,7 +491,7 @@ Starting with version 1.7 Traffic Router added the ability to allow https traffi
The summary for setting up https is to:
-#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
+#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
#. Obtain and import signed certificate chain
#. Snapshot CR Config
@@ -524,7 +524,7 @@ Traffic Router fetches certificates into memory:
* Once an hour from whenever the most recent of the last of the above occurred
.. Note::
- To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
+ To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
setting it to the desired time in milliseconds.
.. Note::
@@ -533,7 +533,7 @@ Traffic Router fetches certificates into memory:
.. Warning::
If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
until one of the following occurs:
- * It receives certificates for that delivery service
+ * It receives certificates for that delivery service
* Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
Certificate Chain Ordering
@@ -586,7 +586,7 @@ Tuning Recommendations
The following is an example of the command line parameters set in /opt/traffic_router/conf/startup.properties that has been tested on a multi core server running under HTTPS load test requests.
This is following the general recommendation to use the G1 garbage collector for JVM applications running on multi core machines.
In addition to using the G1 garbage collector the InitiatingHeapOccupancyPercent was lowered to run garbage collection more frequently which
-improved overall throughput for Traffic Router and reduced 'Stop the World' garbage collection. Note that any environment variable settings in this file will override those
+improved overall throughput for Traffic Router and reduced 'Stop the World' garbage collection. Note that any environment variable settings in this file will override those
set in /lib/systemd/system/traffic_router.service.
/opt/traffic_router/conf/startup.properties::
diff --git a/docs/source/admin/traffic_server.rst b/docs/source/admin/traffic_server.rst
index f4d419e..ce9c4e5 100644
--- a/docs/source/admin/traffic_server.rst
+++ b/docs/source/admin/traffic_server.rst
@@ -42,7 +42,7 @@ Installing Traffic Server
#. Complete the form. Be sure to fill out all fields marked 'Required'
* Set 'Interface Name' to the name of the network interface device from which Apache Traffic Server delivers content.
* Set 'Type' to 'MID' or 'EDGE'.
- * If you wish for the server to immediately be polled by the :ref:`rl-health-proto`, set 'Status' to 'REPORTED'.
+ * If you wish for the server to immediately be polled by the :ref:`health-proto`, set 'Status' to 'REPORTED'.
#. Click on the 'Create' button to submit the form.
#. Verify that the server status is now listed as **Reported**
diff --git a/docs/source/api/v11/deliveryservice.rst b/docs/source/api/v11/deliveryservice.rst
index 1d01d61..f3acd0c 100644
--- a/docs/source/api/v11/deliveryservice.rst
+++ b/docs/source/api/v11/deliveryservice.rst
@@ -1,17 +1,17 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _to-api-v11-ds:
@@ -119,9 +119,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -351,9 +351,9 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -897,7 +897,7 @@ SSL Keys
**Response Example** ::
- {
+ {
"response": {
"certificate": {
"crt": "crt",
@@ -966,7 +966,7 @@ SSL Keys
**Response Example** ::
- {
+ {
"response": {
"certificate": {
"crt": "crt",
@@ -1017,12 +1017,12 @@ SSL Keys
**Response Example** ::
- {
+ {
"response": "Successfully deleted ssl keys for <xml_id>"
}
|
-
+
**POST /api/1.1/deliveryservices/sslkeys/generate**
Generates SSL crt, csr, and private key for a delivery service
@@ -1085,12 +1085,12 @@ SSL Keys
**Response Example** ::
- {
+ {
"response": "Successfully created ssl keys for ds-01"
}
|
-
+
**POST /api/1.1/deliveryservices/sslkeys/add**
Allows user to add SSL crt, csr, and private key for a delivery service.
@@ -1141,7 +1141,7 @@ SSL Keys
**Response Example** ::
- {
+ {
"response": "Successfully added ssl keys for ds-01"
}
diff --git a/docs/source/api/v12/deliveryservice.rst b/docs/source/api/v12/deliveryservice.rst
index f977fc9..6d5c042 100644
--- a/docs/source/api/v12/deliveryservice.rst
+++ b/docs/source/api/v12/deliveryservice.rst
@@ -147,7 +147,7 @@ Delivery Service
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | - e.g. -104.9847000 or null |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -401,7 +401,7 @@ Delivery Service
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | - e.g. -104.9847000 or null |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -2360,7 +2360,7 @@ URL Sig Keys
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | - e.g. -104.9847000 or null |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -2792,7 +2792,7 @@ URL Sig Keys
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | - e.g. -104.9847000 or null |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -3072,7 +3072,7 @@ URL Sig Keys
| ``missLong`` | float | The longitude as decimal degrees to use when the client cannot be found in the CZF or the Geo lookup. |
| | | - e.g. -104.9847000 or null |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+------------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
diff --git a/docs/source/api/v12/server.rst b/docs/source/api/v12/server.rst
index accc234..c141097 100644
--- a/docs/source/api/v12/server.rst
+++ b/docs/source/api/v12/server.rst
@@ -453,9 +453,9 @@ Server
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
diff --git a/docs/source/api/v12/user.rst b/docs/source/api/v12/user.rst
index 8d22fc7..d7a0a6e 100644
--- a/docs/source/api/v12/user.rst
+++ b/docs/source/api/v12/user.rst
@@ -1,17 +1,17 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
.. _to-api-v12-users:
@@ -279,8 +279,8 @@ Users
**Request Example** ::
-
- {
+
+ {
"username": "tsimpson"
"tenantId": 1,
"fullName": "Tom Simpson"
@@ -341,7 +341,7 @@ Users
+----------------------+--------+------------------------------------------------+
**Response Example** ::
-
+
{"alerts": [
{
"level":"success",
@@ -529,9 +529,9 @@ Users
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`multi-site-origin` |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
| | | protocol (http:// or https://) for use in retrieving content from the origin server. |
@@ -747,7 +747,7 @@ Users
}
|
-
+
**PUT /api/1.2/user/current**
Updates the date for the authenticated user.
@@ -1003,7 +1003,7 @@ Role(s) Required: None
{
"alerts":
[
- {
+ {
"level": "success",
"text": "Successfully created purge job for: ."
}
@@ -1255,4 +1255,4 @@ Role(s) Required: None
}
|
-
+
diff --git a/docs/source/basics/caching_proxies.rst b/docs/source/basics/caching_proxies.rst
index d407e8e..2874473 100644
--- a/docs/source/basics/caching_proxies.rst
+++ b/docs/source/basics/caching_proxies.rst
@@ -16,7 +16,7 @@
.. |arrow| image:: fwda.png
-.. _rl-caching_proxy:
+.. _caching_proxy:
Caching Proxies
===============
@@ -37,7 +37,7 @@ types of proxies in use on the Internet today:
.. index::
Reverse Proxy
-.. _rl-rev-proxy:
+.. _rev-proxy:
|arrow| Reverse Proxy
---------------------
@@ -51,18 +51,19 @@ this origin. The content owner must inform the clients, by updating the URL, to
from the cache and not from the origin server directly. For this example, the remap rule on the
cache is: ``http://www-origin-cache.cdn.com http://www.origin.com``.
-.. Note:: In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.::
+.. Note:: In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.
+ ::
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
- <!DOCTYPE html><html><body>This is a fun file</body></html>
+ <!DOCTYPE html><html><body>This is a fun file</body></html>
The client is given the URL ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` (note the different hostname) and when attempting to obtain that URL, the following occurs:
@@ -135,7 +136,7 @@ The client is given the URL ``http://www-origin-cache.cdn.com/foo/bar/fun.html``
.. index::
Forward Proxy
-.. _rl-fwd-proxy:
+.. _fwd-proxy:
|arrow| Forward Proxy
---------------------
diff --git a/docs/source/basics/content_delivery_networks.rst b/docs/source/basics/content_delivery_networks.rst
index 6ae6e95..8893610 100644
--- a/docs/source/basics/content_delivery_networks.rst
+++ b/docs/source/basics/content_delivery_networks.rst
@@ -29,7 +29,7 @@ Content Router
The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.
Health Protocol
- The :ref:`rl-health-proto` monitors the usage of the caches and tenants in the CDN.
+ The :ref:`health-proto` monitors the usage of the caches and tenants in the CDN.
Configuration Management System
In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.
diff --git a/docs/source/development/traffic_ops.rst b/docs/source/development/traffic_ops.rst
index 9bab72d..0eae7d8 100644
--- a/docs/source/development/traffic_ops.rst
+++ b/docs/source/development/traffic_ops.rst
@@ -1,24 +1,24 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Traffic Ops
***********
Introduction
============
-Traffic Ops uses a Postgres database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and REST APIs.
+Traffic Ops uses a Postgres database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and REST APIs.
Software Requirements
=====================
@@ -37,7 +37,7 @@ To work on Traffic Ops you need a \*nix (MacOS and Linux are most commonly used)
Addionally, the installation of the following RPMs (or equivalent) is required:
-* All RPMs listed in :ref:`rl-ps`
+* All RPMs listed in :ref:`ps`
Traffic Ops Project Tree Overview
=======================================
@@ -61,27 +61,27 @@ Traffic Ops Project Tree Overview
* /API - Mojo Controllers for the /API area of the application.
* /Common - Common Code between both the API and UI areas.
- * /Extensions
+ * /Extensions
* Fixtures/ - Test Case fixture data for the 'to_test' database.
* /Integration - Integration Tests.
* /MojoPlugins - Mojolicious Plugins for Common Controller Code.
* Schema/ - Database Schema area.
* /Result - DBIx ORM related files.
- * /Test - Common Test.
+ * /Test - Common Test.
* /UI - Mojo Controllers for the Traffic Ops UI itself.
- * Utils/
+ * Utils/
* /Helper - Common utilities for the Traffic Ops application.
* log/ - Log directory where the development and test files are written by the app.
* public/
-
+
* css/ - Stylesheets.
* images/ - Images.
* js/ - Javascripts
* script/ - Mojo Bootstrap scripts.
-
+
* t/ - Unit Tests for the UI.
* api/ - Unit Tests for the API.
@@ -92,7 +92,7 @@ Traffic Ops Project Tree Overview
-Perl Formatting Conventions
+Perl Formatting Conventions
===========================
Perl tidy is for use in code formatting. See the following config file for formatting conventions.
@@ -126,7 +126,7 @@ Database Management
===================
.. Add db naming conventions
-The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.
+The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.
``$ db/admin.pl``
@@ -177,10 +177,10 @@ To install the Traffic Ops Developer environment:
3. Set up a role (user) in Postgres
- See Postgres instructions on initdb https://wiki.postgresql.org/wiki/First_steps
+ See Postgres instructions on initdb https://wiki.postgresql.org/wiki/First_steps
-4. Enter ``db/admin.pl --env=<enviroment name> setup`` to set up the traffic_ops database(s).
+4. Enter ``db/admin.pl --env=<enviroment name> setup`` to set up the traffic_ops database(s).
* Unit test database: ``$ db/admin.pl --env=test setup``
* Development database: ``$ db/admin.pl --env=development setup``
@@ -222,16 +222,16 @@ To install the Traffic Ops Developer environment:
Start up success includes the following:
::
-
+
[2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
-
+
Server available at http://127.0.0.1:3000.
8. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
9. For the initial log in:
-
+
* User name: admin
* Password: password
@@ -248,11 +248,11 @@ The KableTown CDN example
-------------------------
The integration tests will load an example CDN with most of the features of Traffic Control being used. This is mostly for testing purposes, but can also be used as an example of how to configure certain features. To load the KableTown CDN example and access it:
-1. Run the integration tests
+1. Run the integration tests
2. Start morbo against the integration database: ``export MOJO_MODE=integration; ./bin/start.pl``
3. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
4. For the initial log in:
-
+
* User name: admin
* Password: password
@@ -280,7 +280,7 @@ Check Extensions
In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the "Health->Server Checks" view and that usually run periodically out of cron.
-.. |checkmark| image:: ../_static/good.png
+.. |checkmark| image:: ../_static/good.png
.. |X| image:: ../_static/bad.png
@@ -289,7 +289,7 @@ It is the responsibility of the check extension script to iterate over the serve
An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops' ``/api/1.1/servers.json`` REST target. This list is walked, running a command [...]
-A check extension can have a column of |checkmark|'s and |X|'s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below: ::
+A check extension can have a column of |checkmark|'s and |X|'s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below: ::
Script here.
@@ -302,7 +302,7 @@ Currently, the following Check Extensions are available and installed by default
This check shows how much of the available total cache disk is in use. A "warm" cache should show 100.00.
**Cache Hit Ratio Check - CHR**
- The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).
+ The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).
**DiffServe CodePoint Check - DSCP**
Checks if the returning traffic from the cache has the correct DSCP value as assigned in the delivery service. (Some routers will overwrite DSCP)
@@ -311,23 +311,23 @@ Currently, the following Check Extensions are available and installed by default
Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the ``ip_address`` of the server in the server table.
**Operational Readiness Check - ORT**
- See :ref:`reference-traffic-ops-ort` for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.
+ See :ref:`reference-traffic-ops-ort` for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.
**Ping Check - 10G, ILO, 10G6, FQDN**
The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:
-
+
10G
Is the ``ip_address`` (the main IPv4 address) from the server table pingable?
ILO
Is the ``ilo_ip_address`` (the lights-out-mangement IPv4 address) from the server table pingable?
10G6
Is the ``ip6_address`` (the main IPv6 address) from the server table pingable?
- FQDN
+ FQDN
Is the Fully Qualified Domain name (the concatenation of ``host_name`` and ``.`` and ``domain_name`` from the server table) pingable?
**Traffic Router Check - RTR**
Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, "the optimistic approach")
-
+
Configuration Extensions
------------------------
diff --git a/docs/source/faq/administration.rst b/docs/source/faq/administration.rst
index e9060f4..277633f 100644
--- a/docs/source/faq/administration.rst
+++ b/docs/source/faq/administration.rst
@@ -1,48 +1,48 @@
-..
-..
+..
+..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
-..
+..
.. http://www.apache.org/licenses/LICENSE-2.0
-..
+..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
-..
+..
Running a Traffic Control CDN
*****************************
-.. _rl-cachegroup:
+.. _cachegroup:
Cache Group
-------------------
- A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is n [...]
+ A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is n [...]
- There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.
+ There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.
- .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.
+ .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.
- A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
+ A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`asn-czf`.
Consider the example CDN below:
.. image:: cache_groups_1.png
:align: center
- There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.
+ There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.
-All caches (and other servers) are assigned a Profile in Traffic Ops.
+All caches (and other servers) are assigned a Profile in Traffic Ops.
-.. _rl-profile:
+.. _profile:
Profile
---------------
- A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.
+ A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.
@@ -78,7 +78,7 @@ Why is my CRConfig.json rejected?
You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
* Add Edges
- You will need at least one edge cache to make Traffic Router accept the CRConfig.
+ You will need at least one edge cache to make Traffic Router accept the CRConfig.
* Add Mid
Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index a932579..2871cf7 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -21,61 +21,61 @@ Glossary
.. glossary::
302 content routing
- :ref:`rl-http-cr`.
+ :ref:`http-cr`.
astats (stats_over_http)
- An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
+ An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`astats`.
cache
- A caching proxy server. See :ref:`rl-caching_proxy`.
+ A caching proxy server. See :ref:`caching_proxy`.
cachegroup
- A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
+ A group of caches that together create a combined larger cache using consistent hashing. See :ref:`cachegroup`.
consistent hashing
- See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
+ See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`http-cr` for the edge tier and when selecting parents in the mid tier.
content routing
- Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
+ Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`http-cr` and :ref:`dns-cr`.
coverage zone map
- The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
+ The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`localization`.
delivery service
- A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
+ A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`ds`.
edge (tier or cache)
- Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
+ Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rev-proxy`. See also :ref:`cachegroup`.
- (traffic ops) extension
- Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
+ (traffic ops) extension
+ Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`trops-ext`.
forward proxy
- A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
+ A proxy that works that acts like it is the client to the origin. See :ref:`fwd-proxy`.
geo localization or geo routing
- Localizing clients to the nearest caches using a geo database like the one from Maxmind.
+ Localizing clients to the nearest caches using a geo database like the one from Maxmind.
health protocol
- The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
+ The protocol to monitor the health of all the caches. See :ref:`health-proto`.
localization
- Finding location on the network, or on planet earth. See :ref:`rl-localization`.
+ Finding location on the network, or on planet earth. See :ref:`localization`.
mid (tier or cache)
- The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
+ The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`fwd-proxy`. See also :ref:`cachegroup`.
origin
The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
parent (cache or cachegroup)
- The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
+ The (group of) cache(s) in the higher tier. See :ref:`cachegroup`.
profile
- A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
+ A group of settings (parameters) that will be applied to a server. See :ref:`profile`.
reverse proxy
- A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
+ A proxy that acts like it is the origin to the client. See :ref:`rev-proxy`.
diff --git a/docs/source/overview/traffic_monitor.rst b/docs/source/overview/traffic_monitor.rst
index 9f601f0..e816ba3 100644
--- a/docs/source/overview/traffic_monitor.rst
+++ b/docs/source/overview/traffic_monitor.rst
@@ -13,7 +13,7 @@
.. limitations under the License.
..
-.. _reference-label-tc-tm:
+.. _tc-tm:
.. index::
Traffic Monitor - Overview
@@ -29,7 +29,7 @@ Traffic Monitors operate independently, but use the state of other Traffic Monit
Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
-.. _rl-astats:
+.. _astats:
|arrow| Cache Monitoring
-------------------------
@@ -50,7 +50,7 @@ If astats is unavailable due to a network related issue or the system statistics
.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
-.. _rl-health-proto:
+.. _health-proto:
|arrow| Health Protocol
-----------------------
diff --git a/docs/source/overview/traffic_ops.rst b/docs/source/overview/traffic_ops.rst
index ad6d291..f3766b5 100644
--- a/docs/source/overview/traffic_ops.rst
+++ b/docs/source/overview/traffic_ops.rst
@@ -27,7 +27,7 @@ Traffic Ops also runs a collection of periodic checks to determine the operation
Traffic Ops is in the process of migrating from Perl to Go, and currently runs as two applications. The Go application serves all endpoints which have been rewritten in the Go language, and transparently proxies all other requests to the old Perl application. Both applications are installed by the RPM, and both run as a single service. When the project has fully migrated to Go, the Perl application will be removed, and the RPM and service will consist solely of the Go application.
-.. _rl-trops-ext:
+.. _trops-ext:
|arrow| Traffic Ops Extension
-----------------------------
diff --git a/docs/source/overview/traffic_router.rst b/docs/source/overview/traffic_router.rst
index 383abbf..1cdddf3 100644
--- a/docs/source/overview/traffic_router.rst
+++ b/docs/source/overview/traffic_router.rst
@@ -13,7 +13,7 @@
.. limitations under the License.
..
-.. _reference-label-tc-tr:
+.. _tc-tr:
.. |arrow| image:: fwda.png
@@ -22,7 +22,7 @@
Traffic Router
==============
-Traffic Router's function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:
+Traffic Router's function is to send clients to the most optimal cache. 'Optimal' in this case is based on a number of factors:
* Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost.
@@ -32,7 +32,7 @@ Traffic Router's function is to send clients to the most optimal cache. Optimal
Traffic routing options are often configured at the Delivery Service level.
-.. _rl-ds:
+.. _ds:
|arrow| Delivery Service
------------------------
@@ -41,31 +41,31 @@ Traffic routing options are often configured at the Delivery Service level.
* Cache in RAM, cache on disk, or do not cache at all.
* Use DNS or HTTP Content routing (see below).
* Limits on transactions per second and bandwidth.
- * Protocol (http or https).
+ * Protocol (HTTP or HTTPS).
* Token based authentication settings.
* Header rewrite rules.
- Since Traffic Control version 2.1 deliveryservices can optionally be linked to a :ref:`rl-profile`, and have parameters associated with them. The first feature that uses deliveryservice parameters is the :ref:`rl-multi-site-origin` configuration.
+ Since Traffic Control version 2.1 Delivery Services can optionally be linked to a :ref:`profile`, and have parameters associated with them. The first feature that uses Delivery Service parameters is the :ref:`multi-site-origin` configuration.
Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated.
-.. _rl-localization:
+.. _localization:
|arrow| Localization
--------------------
- Traffic Router uses a JSON input file called the *coverage zone map* to determine what *cachegroup* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to *geo*, using the maxmind database to find the client's location, and the geo coordinates from Traffic Ops for the cachegroup.
+ Traffic Router uses a JSON input file called the *coverage zone map* to determine what *Cache Group* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to geographic mapping, using a GeoIP2 database to find the client's location, and the geographic coordinates from Traffic Ops for the Cache Group.
-Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` url. In a Traffic Control CDN, URLs start with a routing name, which is configurable per-Delivery Service, e.g. ``http://foo.mydeliveryservice.cdn.com/fun/example.html`` with the chosen routing name ``foo``.
+Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` URL. In a Traffic Control CDN, URLs start with a routing name, which is configurable per-Delivery Service, e.g. ``http://foo.mydeliveryservice.cdn.com/fun/example.html`` with the chosen routing name ``foo``.
.. index::
Content Routing
-.. _rl-dns-cr:
+.. _dns-cr:
|arrow| DNS Content Routing
---------------------------
- For a DNS delivery service the client might receive a URL such as ``http://foo.dsname.cdn.com/fun/example.html``. When the LDNS server is resolving this ``foo.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual [...]
+ For a DNS delivery service the client might receive a URL such as ``http://foo.dsname.cdn.com/fun/example.html``. When the Local Domain Name Server (LDNS) server is resolving this ``foo.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Rout [...]
-.. _rl-http-cr:
+.. _http-cr:
|arrow| HTTP Content Routing
----------------------------
diff --git a/docs/source/overview/traffic_stats.rst b/docs/source/overview/traffic_stats.rst
index a526504..debf5a0 100644
--- a/docs/source/overview/traffic_stats.rst
+++ b/docs/source/overview/traffic_stats.rst
@@ -13,23 +13,36 @@
.. limitations under the License.
..
-.. _reference-label-tc-ts:
+.. _tc-ts:
.. |arrow| image:: fwda.png
Traffic Stats
=============
-Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as w [...]
+Traffic Stats is a program written in `Go <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDB <http://influxdb.com>`_. Data is typically stored in InfluxDB on a short-term basis (30 days or less). The data from InfluxDB is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well [...]
+
+- Gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDB
+- Summarizes all of the stats once a day (around midnight UTC) and creates a daily report containing the Max Gbps Served and the Total Bytes Served.
Stat data is stored in three different databases:
- - cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (``ats.proxy.process.http.current_client_connections``). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
+ - ``cache_stats``: Stores data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and ``client_connections`` (``ats.proxy.process.http.current_client_connections``). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, Cache Group, and CDN. Data can be queried using tags.
+
+ - ``deliveryservice_stats``: Stores data for Delivery Services. The measurements stored by delivery service are:
+ - ``kbps``
+ - ``status_4xx``
+ - ``status_5xx``
+ - ``tps_2xx``
+ - ``tps_3xx``
+ - ``tps_4xx``
+ - ``tps_5xx``
+ - ``tps_total``
- - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+ Delivery Service statistics are stored with tags for Cache Group, CDN, and Delivery Service ``xml_id``.
- - daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
+ - ``daily_stats``: Stores summary data for daily activities. The statistics that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
------------
-Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Ops and Traffic Portal.
+Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Portal and the legacy Traffic Ops UI.
diff --git a/docs/source/overview/traffic_vault.rst b/docs/source/overview/traffic_vault.rst
index c64b9f2..28ea3ef 100644
--- a/docs/source/overview/traffic_vault.rst
+++ b/docs/source/overview/traffic_vault.rst
@@ -31,6 +31,4 @@ Traffic Vault is a keystore used for storing the following types of information:
- public key
* URL Signing Keys
-As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have administrative privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic ops accesses Riak via HTTPS on port 8088. Traffic ops uses Riak's REST API with username/password aut [...]
-
-
+As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have administrative privileges. Keys can be created via the Traffic Portal UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic Ops accesses Riak via HTTPS on port 8088. Traffic ops uses Riak's REST API with username/password [...]