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 2017/03/31 18:05:21 UTC
[22/22] incubator-trafficcontrol-website git commit: updates latest
(master) docs
updates latest (master) docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/45597d7d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/45597d7d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/45597d7d
Branch: refs/heads/asf-site
Commit: 45597d7da78b325ed93bf040ebfda10159d5a16b
Parents: 8432a6d
Author: Jeremy Mitchell <je...@cable.comcast.com>
Authored: Fri Mar 31 12:04:15 2017 -0600
Committer: Jeremy Mitchell <je...@cable.comcast.com>
Committed: Fri Mar 31 12:04:15 2017 -0600
----------------------------------------------------------------------
docs/latest/.buildinfo | 2 +-
.../71DA92BB-8E1E-4921-BC95-574E659812FF.png | Bin 95903 -> 0 bytes
.../_images/traffic_control_overview_3.png | Bin 113129 -> 138671 bytes
.../latest/_sources/admin/quick_howto/index.txt | 1 +
.../admin/quick_howto/multi_site_ats5.txt | 95 ++
.../_sources/admin/traffic_ops_config.txt | 21 +-
.../latest/_sources/admin/traffic_ops_using.txt | 87 +-
.../latest/_sources/development/traffic_ops.txt | 4 +-
.../development/traffic_ops_api/v11/redis.txt | 431 -------
.../traffic_ops_api/v12/cachegroup.txt | 4 +-
.../development/traffic_ops_api/v12/cdn.txt | 107 +-
.../traffic_ops_api/v12/deliveryservice.txt | 9 -
.../v12/deliveryservice_regex.txt | 374 ++++++
.../development/traffic_ops_api/v12/profile.txt | 153 ++-
.../development/traffic_ops_api/v12/server.txt | 8 +-
.../development/traffic_ops_api/v12/tenant.txt | 242 ++++
docs/latest/_sources/overview/introduction.txt | 25 +-
.../latest/_sources/overview/traffic_router.txt | 1 +
.../latest/_sources/overview/traffic_server.txt | 2 +-
docs/latest/_static/basic.css | 15 +-
docs/latest/_static/doctools.js | 28 +-
docs/latest/_static/pygments.css | 2 +
docs/latest/_static/searchtools.js | 51 +-
docs/latest/_static/tc_logo.png | Bin 106800 -> 89813 bytes
docs/latest/_static/websupport.js | 4 +-
docs/latest/admin/index.html | 6 +-
docs/latest/admin/quick_howto/dnssec.html | 14 +-
docs/latest/admin/quick_howto/federations.html | 14 +-
docs/latest/admin/quick_howto/index.html | 3 +-
docs/latest/admin/quick_howto/multi_site.html | 22 +-
.../admin/quick_howto/multi_site_ats5.html | 338 ++++++
docs/latest/admin/quick_howto/regionalgeo.html | 50 +-
docs/latest/admin/quick_howto/steering.html | 38 +-
docs/latest/admin/traffic_monitor.html | 18 +-
docs/latest/admin/traffic_ops_config.html | 68 +-
docs/latest/admin/traffic_ops_extensions.html | 68 +-
docs/latest/admin/traffic_ops_install.html | 178 +--
docs/latest/admin/traffic_ops_using.html | 391 +++---
docs/latest/admin/traffic_portal.html | 2 +-
docs/latest/admin/traffic_router.html | 30 +-
docs/latest/admin/traffic_server.html | 8 +-
docs/latest/admin/traffic_stats.html | 2 +-
docs/latest/admin/traffic_vault.html | 2 +-
docs/latest/basics/cache_revalidation.html | 70 +-
docs/latest/basics/caching_proxies.html | 172 +--
.../basics/content_delivery_networks.html | 2 +-
docs/latest/basics/http_11.html | 14 +-
docs/latest/basics/index.html | 2 +-
docs/latest/development/index.html | 2 +-
docs/latest/development/traffic_monitor.html | 4 +-
docs/latest/development/traffic_ops.html | 40 +-
.../development/traffic_ops_api/routes.html | 92 +-
.../development/traffic_ops_api/v11/asn.html | 22 +-
.../traffic_ops_api/v11/cachegroup.html | 150 +--
.../development/traffic_ops_api/v11/cdn.html | 310 ++---
.../traffic_ops_api/v11/changelog.html | 62 +-
.../traffic_ops_api/v11/deliveryservice.html | 566 ++++-----
.../development/traffic_ops_api/v11/hwinfo.html | 20 +-
.../traffic_ops_api/v11/parameter.html | 68 +-
.../traffic_ops_api/v11/phys_location.html | 212 ++--
.../traffic_ops_api/v11/profile.html | 30 +-
.../development/traffic_ops_api/v11/redis.html | 896 --------------
.../development/traffic_ops_api/v11/region.html | 74 +-
.../development/traffic_ops_api/v11/role.html | 12 +-
.../development/traffic_ops_api/v11/server.html | 470 ++++----
.../traffic_ops_api/v11/static_dns.html | 24 +-
.../development/traffic_ops_api/v11/status.html | 88 +-
.../development/traffic_ops_api/v11/system.html | 20 +-
.../traffic_ops_api/v11/to_extension.html | 94 +-
.../development/traffic_ops_api/v11/type.html | 40 +-
.../development/traffic_ops_api/v11/user.html | 280 ++---
.../development/traffic_ops_api/v12/asn.html | 64 +-
.../traffic_ops_api/v12/cache_stats.html | 48 +-
.../traffic_ops_api/v12/cachegroup.html | 326 ++---
.../development/traffic_ops_api/v12/cdn.html | 590 +++++----
.../traffic_ops_api/v12/changelog.html | 62 +-
.../traffic_ops_api/v12/deliveryservice.html | 1123 +++++++++---------
.../v12/deliveryservice_regex.html | 819 +++++++++++++
.../v12/deliveryservice_stats.html | 66 +-
.../traffic_ops_api/v12/division.html | 78 +-
.../traffic_ops_api/v12/federation.html | 54 +-
.../development/traffic_ops_api/v12/hwinfo.html | 20 +-
.../traffic_ops_api/v12/influxdb.html | 36 +-
.../traffic_ops_api/v12/parameter.html | 236 ++--
.../traffic_ops_api/v12/phys_location.html | 212 ++--
.../traffic_ops_api/v12/profile.html | 264 ++--
.../traffic_ops_api/v12/profile_parameter.html | 250 ++--
.../development/traffic_ops_api/v12/region.html | 74 +-
.../development/traffic_ops_api/v12/role.html | 12 +-
.../development/traffic_ops_api/v12/server.html | 828 ++++++-------
.../traffic_ops_api/v12/static_dns.html | 24 +-
.../development/traffic_ops_api/v12/status.html | 88 +-
.../development/traffic_ops_api/v12/system.html | 26 +-
.../development/traffic_ops_api/v12/tenant.html | 594 +++++++++
.../traffic_ops_api/v12/to_extension.html | 100 +-
.../traffic_ops_api/v12/topology.html | 4 +-
.../development/traffic_ops_api/v12/type.html | 40 +-
.../development/traffic_ops_api/v12/user.html | 426 +++----
docs/latest/development/traffic_portal.html | 2 +-
docs/latest/development/traffic_router.html | 4 +-
docs/latest/development/traffic_server.html | 2 +-
docs/latest/development/traffic_stats.html | 2 +-
docs/latest/faq/administration.html | 2 +-
docs/latest/faq/development.html | 2 +-
docs/latest/faq/general.html | 2 +-
docs/latest/faq/index.html | 2 +-
docs/latest/genindex.html | 38 +-
docs/latest/glossary.html | 40 +-
docs/latest/index.html | 1 +
docs/latest/objects.inv | Bin 2636 -> 3846 bytes
docs/latest/overview/index.html | 2 +-
docs/latest/overview/introduction.html | 38 +-
docs/latest/overview/traffic_monitor.html | 2 +-
docs/latest/overview/traffic_ops.html | 2 +-
docs/latest/overview/traffic_portal.html | 2 +-
docs/latest/overview/traffic_router.html | 19 +-
docs/latest/overview/traffic_server.html | 6 +-
docs/latest/overview/traffic_stats.html | 2 +-
docs/latest/overview/traffic_vault.html | 2 +-
docs/latest/searchindex.js | 2 +-
120 files changed, 7522 insertions(+), 5870 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/.buildinfo
----------------------------------------------------------------------
diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
index 4f0798b..68fa0ff 100644
--- a/docs/latest/.buildinfo
+++ b/docs/latest/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6bd05c0cca12986592bae230f40a44a6
+config: 4a1c757ca051e368f370378e8be9bad0
tags: 645f666f9bcd5a90fca523b33c5a78b7
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_images/71DA92BB-8E1E-4921-BC95-574E659812FF.png
----------------------------------------------------------------------
diff --git a/docs/latest/_images/71DA92BB-8E1E-4921-BC95-574E659812FF.png b/docs/latest/_images/71DA92BB-8E1E-4921-BC95-574E659812FF.png
deleted file mode 100644
index 922d6eb..0000000
Binary files a/docs/latest/_images/71DA92BB-8E1E-4921-BC95-574E659812FF.png and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_images/traffic_control_overview_3.png
----------------------------------------------------------------------
diff --git a/docs/latest/_images/traffic_control_overview_3.png b/docs/latest/_images/traffic_control_overview_3.png
index 594983b..58f03d7 100644
Binary files a/docs/latest/_images/traffic_control_overview_3.png and b/docs/latest/_images/traffic_control_overview_3.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/admin/quick_howto/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/index.txt b/docs/latest/_sources/admin/quick_howto/index.txt
index 96f098f..4eab27f 100644
--- a/docs/latest/_sources/admin/quick_howto/index.txt
+++ b/docs/latest/_sources/admin/quick_howto/index.txt
@@ -22,6 +22,7 @@ Traffic Control is a complicated system, and documenting it is not trivial. Some
:maxdepth: 3
multi_site.rst
+ multi_site_ats5.rst
dnssec.rst
federations.rst
regionalgeo.rst
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/admin/quick_howto/multi_site_ats5.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/multi_site_ats5.txt b/docs/latest/_sources/admin/quick_howto/multi_site_ats5.txt
new file mode 100644
index 0000000..9419de0
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/multi_site_ats5.txt
@@ -0,0 +1,95 @@
+..
+..
+.. 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-ats5:
+
+*********************************
+Configure Multi Site Origin (5.x)
+*********************************
+
+1) Create "cachegroups" for the origin locations, and assign the appropriate parent-child relationship between the mid cg's and org cgs (click the image to see full size):
+
+.. image:: C5C4CD22-949A-48FD-8976-C673083E2177.png
+ :scale: 100%
+ :align: center
+
+2) Create a profile to assign to each of the origins:
+
+.. image:: 19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png
+ :scale: 100%
+ :align: center
+
+3) Create server entries for the origination vips:
+
+.. image:: D28614AA-9758-45ED-9EFD-3A284FC4218E.png
+ :scale: 100%
+ :align: center
+
+4) Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:
+
+.. image:: mso-enable.png
+ :scale: 100%
+ :align: center
+
+5) Assign the org servers to the delivery service that will have the multi site feature:
+
+.. image:: 066CEF4F-C1A3-4A89-8B52-4F72B0531367.png
+ :scale: 100%
+ :align: center
+
+.. Note:: \u201cOrigin Server Base URL\u201d uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that \u201cOrigin Server Base URL\u201d (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 exceptions are:
+ 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.
+ 3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.
+
+6) Select an option from the "Multi Site Origin Algorithm" drop-down list. Four MSO algorithms are supported:
+
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Option | Description |
++==================+====================================================================================================================+
+| Consistent hash | Origin server selection is based on the consistent hash of requested URLs. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Primary/back | Round robin selection does not occur. The first origin server is selected unless it fails. |
+| | If the first fails, the second and other following origin servers will be tried by order. |
+| | Order is defined by 2 factors - if the origin server's cachegroup is configured as the |
+| | parent cachegroup for the mid, then this server will be used as the primary. The same rules |
+| | apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort |
+| | order further. If no parents are defined at the mid, then only rank is considered. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, |
+| round-robin | origin server 2 serves the second request, and so on. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| IP based | MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache. |
+| round-robin | |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+
+7) Optionally, there are two configuration options that can set the order of the origins used if "Primary/backup" is selected for "Multi Site Origin Algorithm". By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter \u201crank\u201d should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to \u201c1\u201d. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.
+
+.. image:: mso-rank.png
+ :scale: 60%
+ :align: center
+
+8) Assign the parent.config location parameter to the MID profile:
+
+.. image:: D22DCAA3-18CC-48F4-965B-5312993F9820.png
+ :scale: 100%
+ :align: center
+
+
+9) Configure the mid hdr_rewrite on the delivery service, example: ::
+
+ cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
+
+10) Turn on parent_proxy_routing in the MID profile.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/admin/traffic_ops_config.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_config.txt b/docs/latest/_sources/admin/traffic_ops_config.txt
index 90c0c1c..b17d57e 100644
--- a/docs/latest/_sources/admin/traffic_ops_config.txt
+++ b/docs/latest/_sources/admin/traffic_ops_config.txt
@@ -29,7 +29,7 @@ Content Delivery Networks
Profile Parameters
======================
-Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a "Global profile" - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:
+Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server or a deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a "Global profile" - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:
.. index::
@@ -40,6 +40,8 @@ Many of the settings for the different servers in a Traffic Control CDN are cont
+==========================+===============+=======================================================================================================================================+
| tm.url | global | The URL where this Traffic Ops instance is being served from. |
+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.cache.url | global | Not required. The URL where the Traffic Ops Config file cache instance is being served from. Requires Traffic Ops 2.1 and above. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
| tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated. |
+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
| tm.infourl | global | This is the "for more information go here" URL, which is visible in the About page. |
@@ -90,12 +92,20 @@ Below is a list of cache parameters that are likely to need changes from the def
| allow_ip6 | astats.config | This is a comma separated list of IPv6 CIDR blocks that will have access to the astats statistics on the caches. |
| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv6 to monitor the caches. |
+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| Drive_Prefix | storage.config | JvD/Jeff to supply blurb |
+| Drive_Prefix | storage.config | The device path start of the disks. For example, if you have ``/dev/sda`` through ``/dev/sdf`` set this to ``/dev/sd`` |
+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| Drive_Letters | storage.config | JvD/Jeff to supply blurb |
+| 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`) |
+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v4 | ip_allow.config | The masklen to use when coalescing v4 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_number_v4 | ip_allow.config | The number to use when coalescing v4 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v6 | ip_allow.config | The masklen to use when coalescing v6 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| coalesce_masklen_v6 | ip_allow.config | The masklen to use when coalescing v6 networks into one line using http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
| health.threshold.loadavg | rascal.properties | The Unix load average at which Traffic Router will stop sending traffic to this cache |
+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
| health.threshold.\\ | rascal.properties | The amount of bandwidth that Traffic Router will try to keep available on the cache. |
@@ -143,6 +153,11 @@ Content Purge is controlled by the following parameters in the profile of the ca
| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
| | | For example: --config regex_revalidate.config | |
+----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| use_reval_pending | global | Configures Traffic Ops to use separate | When this flag is in use ORT will check for a new regex_revalidate.config every 60 seconds in syncds mode during the dispersal timer. This will |
+| | | reval_pending flag for each cache. | also allow ORT to be run in revalidate mode, which will check for and clear the reval_pending flag. This can be set to run via cron task. |
+| | | | This value is set to 0 by default. Enable with a value of 1. Use of this feature requires Traffic Ops 2.1 and above. |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+
Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using `proxy-config-http-cache-guaranteed-min-lifetime <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime>`_ to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as `maxRevalDurationDays` (Note that the former is in seconds and the latter is in days, so convert appropriately).
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/admin/traffic_ops_using.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_using.txt b/docs/latest/_sources/admin/traffic_ops_using.txt
index eb3d0ee..c62704c 100644
--- a/docs/latest/_sources/admin/traffic_ops_using.txt
+++ b/docs/latest/_sources/admin/traffic_ops_using.txt
@@ -122,6 +122,8 @@ The following tabs are available in the menu at the top of the Traffic Ops user
+--------------------+-------------------------------------------------------------------------------------------+
| Option | Description |
+====================+===========================================================================================+
+ | CDNs | Create/Read/Update/Delete CDNs |
+ +--------------------+-------------------------------------------------------------------------------------------+
| Cache Groups | Create/Read/Update/Delete cache groups |
+--------------------+-------------------------------------------------------------------------------------------+
| Users | Create/Read/Update/Delete users |
@@ -255,7 +257,7 @@ These are the types of servers that can be managed in Traffic Ops:
+---------------+---------------------------------------------+
| ORG | Origin |
+---------------+---------------------------------------------+
-| CCR | Comcast Content Router |
+| CCR | Traffic Router |
+---------------+---------------------------------------------+
| RASCAL | Rascal health polling & reporting |
+---------------+---------------------------------------------+
@@ -278,7 +280,7 @@ These are the types of servers that can be managed in Traffic Ops:
Bulk Upload Server
++++++++++++++++++
-
+TBD
Delivery Service
@@ -309,6 +311,8 @@ The fields in the Delivery Service view are:
| | - 0 use in cache key and hand up to origin -this means each unique query string Is treated as a unique URL. |
| | - 1 Do not use in cache key, but pass up to origin - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin still sees original query string in the request. |
| | - 2 Drop at edge - this means a 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`. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Geo Limit? | Some services are intended to be limited by geography. The possible settings are are: |
| | |
@@ -339,12 +343,7 @@ The fields in the Delivery Service view are:
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Use Multi Site Origin Feature | Enable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Multi Site Origin Algorithm | - 1 Consistent Hash spreads requests across multiple parents simultaneously based on hash of content URL. |
-| | - 2 Strict Round Robin spreads requests across multiple parents simultaneously based on order of requests. |
-| | - 3 IP Based Round Robin spreads requests across multiple parents simultaneously based on order of requests, but ensures that requests from the same IP always go to the same parent if available. |
-| | - 4 Latched uses only a single parent at any given time and switches to a new parent only if the current parent fails. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CCR profile | The Traffic Router profile for this delivery service. See :ref:`rl-ccr-profile`. |
+| Profile | The profile for this delivery service. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Maximum Bits per Second allowed globally | 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. |
@@ -361,6 +360,8 @@ The fields in the Delivery Service view are:
| Mid Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the MID tier. See :ref:`rl-header-rewrite`. [1]_ |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Regex Remap Expression | Regex Remap rule to apply to this delivery service at the Edge tier. See `ATS documentation on regex_remap <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_. [1]_ |
+| | |
+| | **Note:** you will not be able to save a Regex Remap Expression if you have Query String Handling set to drop query strings at the edge. See :ref:`rl-regex-remap`. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Cache URL expression | Cache URL rule to apply to this delivery service. See `ATS documentation on cacheurl <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html>`_. [1]_ |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -594,14 +595,14 @@ Parameters in the Mid (parent) profile that influence this feature:
Multi Site Origin
+++++++++++++++++
-.. Note:: The Multi Site Origin feature is based upon a feature n ATS that has yet to be submitted to Traffic Server upstream, until it is, set this to 0, or use the ATS rpm supplied on the trafficcontrol.apache.org website.
-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.
+.. 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-ats5` for the ATS version 5.x configuration details.
-With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is ""
+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 deliveryservice `Origin Server Base URL` field. See the `Apache Traffic Server docs <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html>`_ for more information on that cache's implementation.
+With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is "ORG".
-Parameters in the Origin profile that influence this feature:
+Parameters in the mid profile that influence this feature:
+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
| Name | Filename | Default | Description |
@@ -610,27 +611,40 @@ Parameters in the Origin profile that influence this feature:
+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
| CONFIG proxy.config. url_remap.remap_required | records.config | INT 1 | required for parent selection. |
+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_proxy.per_parent_connect_attempts | records.config | INT 5 | maximum of 5 connection attempts per parent (parent.config list) within a transaction. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_proxy.total_connect_attempts | records.config | INT 10 | maximum of 10 total connection attempts within a transaction. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.simple_retry_enabled | records.config | INT 1 | enables simple retry. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.simple_retry_response_codes | records.config | STRING 404 | the response code that invokes simple retry. May be a comman separated list of response codes. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.dead_server_retry_response_codes | records.config | STRING 503 | the response code that invokes dead server retry. May be a comma separated list of response codes |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.dead_server_retry_enabled | records.config | INT 1 | enables dead server retry. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. diags.debug.enabled | records.config | INT 1 | enable debugging for testing only |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+
+
+Parameters in the deliveryservice profile that influence this feature:
+
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++=============================================+================+=================+=================================================================================================================================+
+| mso.parent_retry | parent.config | \- | Either ``simple_retry``, ``dead_server_retry`` or ``both``. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.algorithm | parent.config | consistent_hash | The algorithm to use. ``consisten_hash``, ``strict``, ``true``, ``false``, or ``latched``. |
+| | | | |
+| | | | - ``consisten_hash`` - spreads requests across multiple parents simultaneously based on hash of content URL. |
+| | | | - ``strict`` - strict Round Robin spreads requests across multiple parents simultaneously based on order of requests. |
+| | | | - ``true`` - same as strict, but ensures that requests from the same IP always go to the same parent if available. |
+| | | | - ``false`` - uses only a single parent at any given time and switches to a new parent only if the current parent fails. |
+| | | | - ``latched`` - same as false, but now, a failed parent will not be retried. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.unavailable_server_retry_response_codes | parent.config | "503" | Quoted, comma separated list of HTTP status codes that count as a unavailable_server_retry_response_code. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.max_unavailable_server_retries | parent.config | 1 | How many times an unavailable server will be retried. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.simple_retry_response_codes | parent.config | "404" | Quoted, comma separated list of HTTP status codes that count as a simple retry response code. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+| mso.max_simple_retries | parent.config | 1 | How many times a simple retry will be done. |
++---------------------------------------------+----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------+
+
+
see :ref:`rl-multi-site-origin-qht` for a *quick how to* on this feature.
.. _rl-ccr-profile:
-CCR Profile or Traffic Router Profile
-+++++++++++++++++++++++++++++++++++++
+Traffic Router Profile
+++++++++++++++++++++++
+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Name | Config_file | Description |
@@ -655,8 +669,6 @@ CCR Profile or Traffic Router Profile
+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in XML format from. |
+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| domain_name | CRConfig.json | The top level domain of this Traffic Router instance. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
@@ -719,6 +731,21 @@ CCR Profile or Traffic Router Profile
+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. index::
+ Regex Remap Expression
+
+.. _rl-regex-remap:
+
+Regex Remap Expression
+++++++++++++++++++++++
+The regex remap expression allows to to use a regex and resulting match group(s) in order to modify the request URIs that are sent to origin. For example: ::
+
+ ^/original/(.*) http://origin.example.com/remapped/$1
+
+.. Note:: If **Query String Handling** is set to ``2 Drop at edge``, then you will not be allowed to save a regex remap expression, as dropping query strings actually relies on a regex remap of its own. However, if there is a need to both drop query strings **and** remap request URIs, this can be accomplished by setting **Query String Handling** to ``1 Do not use in cache key, but pass up to origin``, and then using a custom regex remap expression to do the necessary remapping, while simultaneously dropping query strings. The following example will capture the original request URI up to, but not including, the query string and then forward to a remapped URI: ::
+
+ ^/([^?]*).* http://origin.example.com/remapped/$1
+
.. index::
HOST_REGEXP
PATH_REGEXP
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops.txt b/docs/latest/_sources/development/traffic_ops.txt
index 9e30148..41ad9cd 100644
--- a/docs/latest/_sources/development/traffic_ops.txt
+++ b/docs/latest/_sources/development/traffic_ops.txt
@@ -597,7 +597,7 @@ API 1.1 Reference
traffic_ops_api/v11/type
traffic_ops_api/v11/user
-API 1.2 Reference
+API 1.2 Reference
-----------------
.. toctree::
@@ -609,6 +609,7 @@ API 1.2 Reference
traffic_ops_api/v12/cdn
traffic_ops_api/v12/changelog
traffic_ops_api/v12/deliveryservice
+ traffic_ops_api/v12/deliveryservice_regex
traffic_ops_api/v12/deliveryservice_stats
traffic_ops_api/v12/division
traffic_ops_api/v12/federation
@@ -624,6 +625,7 @@ API 1.2 Reference
traffic_ops_api/v12/static_dns
traffic_ops_api/v12/status
traffic_ops_api/v12/system
+ traffic_ops_api/v12/tenant
traffic_ops_api/v12/to_extension
traffic_ops_api/v12/type
traffic_ops_api/v12/user
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v11/redis.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/redis.txt b/docs/latest/_sources/development/traffic_ops_api/v11/redis.txt
deleted file mode 100644
index 795be7f..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/redis.txt
+++ /dev/null
@@ -1,431 +0,0 @@
-..
-.. Copyright 2015 Comcast Cable Communications Management, LLC
-..
-.. 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-redis:
-
-Redis
-=====
-
-.. Note:: The redis documentation needs a thorough review!
-
-.. _to-api-v11-redis-route:
-
-/api/1.1/redis
-++++++++++++++
-
-**GET /api/1.1/traffic_monitor/stats.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+----------------------+--------+------------------------------------------------+
-| Parameter | Type | Description |
-+======================+========+================================================+
-| ``aaData`` | array | |
-+----------------------+--------+------------------------------------------------+
-
-**Response Example**
-::
-
- {
- "aaData": [
- [
- "0",
- "ALL",
- "ALL",
- "ALL",
- "true",
- "ALL",
- "142035",
- "172365661.85"
- ],
- [
- 1,
- "EDGE1_TOP_421_PSPP",
- "odol-atsec-atl-03",
- "us-ga-atlanta",
- "1",
- "REPORTED",
- "596",
- "923510.04",
- "69.241.82.126"
- ]
- ],
- }
-
-|
-
-**GET /api/1.1/redis/stats.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+----------------------+--------+------------------------------------------------+
-| Parameter | Type | Description |
-+======================+========+================================================+
-|``number`` | array | |
-+----------------------+--------+------------------------------------------------+
-|``what`` | string | |
-+----------------------+--------+------------------------------------------------+
-|``which`` | string | |
-+----------------------+--------+------------------------------------------------+
-|``interval`` | string | |
-+----------------------+--------+------------------------------------------------+
-|``elapsed`` | string | |
-+----------------------+--------+------------------------------------------------+
-|``end`` | string | |
-+----------------------+--------+------------------------------------------------+
-|``start`` | string | |
-+----------------------+--------+------------------------------------------------+
-
-**Response Example**
-::
-
- {
- "number": -1,
- "what": null,
- "which": null,
- "interval": " 10 seconds ",
- "elapsed": "0.11271 (0.112065) ",
- "end": "Thu Jan 1 00:00:00 1970",
- "start": "Thu Jan 1 00:00:00 1970"
- }
-
-|
-
-**GET /api/1.1/redis/info/:host_name.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Request Route Parameters**
-
-+--------------------------+--------+--------------------------------------------+
-| Parameter | Type | Description |
-+==========================+========+============================================+
-|``host_name`` | string | |
-+--------------------------+--------+--------------------------------------------+
-
-**Response Properties**
-
-+-------------------------------------+--------+-------------+
-| Parameter | Type | Description |
-+=====================================+========+=============+
-| ``Server`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>redis_build_id`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>config_file`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>uptime_in_seconds`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>hz`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>os`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>redis_git_sha1`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>redis_version`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>tcp_port`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>redis_git_dirty`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>redis_mode`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>run_id`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>uptime_in_days`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>gcc_version`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>arch_bits`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>lru_clock`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>multiplexing_api`` | string | |
-+-------------------------------------+--------+-------------+
-| ``Keyspace`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>db0`` | string | |
-+-------------------------------------+--------+-------------+
-| ``slowlog`` | array | |
-+-------------------------------------+--------+-------------+
-| ``Persistence`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_bgsave_in_progress`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>loading`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_current_bgsave_time_sec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_enabled`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_last_bgsave_time_sec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_last_rewrite_time_sec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_last_write_status`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_last_bgsave_status`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_last_bgrewrite_status`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_current_rewrite_time_sec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_rewrite_scheduled`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>aof_rewrite_in_progress`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_last_save_time`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rdb_changes_since_last_save`` | string | |
-+-------------------------------------+--------+-------------+
-| ``slowlen`` | int | |
-+-------------------------------------+--------+-------------+
-| ``CPU`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>used_cpu_user`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_cpu_sys`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_cpu_user_children`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_cpu_sys_children`` | string | |
-+-------------------------------------+--------+-------------+
-| ``Memory`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory_lua`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>mem_allocator`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory_human`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory_peak_human`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory_peak`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory_rss`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>mem_fragmentation_ratio`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>used_memory`` | string | |
-+-------------------------------------+--------+-------------+
-| ``Replication`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>repl_backlog_first_byte_offset`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>repl_backlog_active`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>repl_backlog_histlen`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>repl_backlog_size`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>role`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>master_repl_offset`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>connected_slaves`` | string | |
-+-------------------------------------+--------+-------------+
-| ``Clients`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>client_biggest_input_buf`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>client_longest_output_list`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>blocked_clients`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>connected_clients`` | string | |
-+-------------------------------------+--------+-------------+
-| ``Stats`` | hash | |
-+-------------------------------------+--------+-------------+
-| ``>latest_fork_usec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>rejected_connections`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>sync_partial_ok`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>pubsub_channels`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>instantaneous_ops_per_sec`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>total_connections_received`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>pubsub_patterns`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>sync_full`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>keyspace_hits`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>keyspace_misses`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>total_commands_processed`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>expired_keys`` | string | |
-+-------------------------------------+--------+-------------+
-| ``>sync_partial_err`` | string | |
-+-------------------------------------+--------+-------------+
-
-**Response Example**
-::
-
- {
- "Server": {
- "redis_build_id": "606641459177bc09",
- "config_file": "\/etc\/redis\/redis.conf",
- "uptime_in_seconds": "1113787",
- "hz": "10",
- "os": "Linux 2.6.32-220.el6.x86_64 x86_64",
- "redis_git_sha1": "00000000",
- "redis_version": "2.8.15",
- "process_id": "14607",
- "tcp_port": "6379",
- "redis_git_dirty": "0",
- "redis_mode": "standalone",
- "run_id": "43c5d003453b96e38ad3eae54026d8e1b078a7fd",
- "uptime_in_days": "12",
- "gcc_version": "4.4.6",
- "arch_bits": "64",
- "lru_clock": "16050046",
- "multiplexing_api": "epoll"
- },
- "Keyspace": {
- "db0": "keys=26319,expires=0,avg_ttl=0"
- },
- "slowlog": [
- [
- "32656",
- "1425336191",
- "18539",
- [
- "keys",
- "*"
- ]
- ]
- ],
- "Persistence": {
- "rdb_bgsave_in_progress": "0",
- "loading": "0",
- "rdb_current_bgsave_time_sec": "-1",
- "aof_enabled": "0",
- "rdb_last_bgsave_time_sec": "-1",
- "aof_last_rewrite_time_sec": "-1",
- "aof_last_write_status": "ok",
- "rdb_last_bgsave_status": "ok",
- "aof_last_bgrewrite_status": "ok",
- "aof_current_rewrite_time_sec": "-1",
- "aof_rewrite_scheduled": "0",
- "aof_rewrite_in_progress": "0",
- "rdb_last_save_time": "1424222403",
- "rdb_changes_since_last_save": "2595831724"
- },
- "slowlen": 128,
- "CPU": {
- "used_cpu_user": "45252.98",
- "used_cpu_sys": "154718.84",
- "used_cpu_user_children": "0.00",
- "used_cpu_sys_children": "0.00"
- },
- "Memory": {
- "used_memory_lua": "33792",
- "mem_allocator": "jemalloc-3.6.0",
- "used_memory_human": "5.25G",
- "used_memory_peak_human": "8.08G",
- "used_memory_peak": "8675798632",
- "used_memory_rss": "8870088704",
- "mem_fragmentation_ratio": "1.57",
- "used_memory": "5633381640"
- },
- "Replication": {
- "repl_backlog_first_byte_offset": "0",
- "repl_backlog_active": "0",
- "repl_backlog_histlen": "0",
- "repl_backlog_size": "1048576",
- "role": "master",
- "master_repl_offset": "0",
- "connected_slaves": "0"
- },
- "Clients": {
- "client_biggest_input_buf": "0",
- "client_longest_output_list": "0",
- "blocked_clients": "0",
- "connected_clients": "16"
- },
- "Stats": {
- "latest_fork_usec": "0",
- "rejected_connections": "0",
- "sync_partial_ok": "0",
- "pubsub_channels": "0",
- "instantaneous_ops_per_sec": "2238",
- "total_connections_received": "2502657",
- "evicted_keys": "0",
- "pubsub_patterns": "0",
- "sync_full": "0",
- "keyspace_hits": "49388626",
- "keyspace_misses": "780",
- "total_commands_processed": "2645272238",
- "expired_keys": "0",
- "sync_partial_err": "0"
- }
- }
-
-|
-
-**GET /api/1.1/redis/match/#match/start_date/:start_date/end_date/:end_date/interval/:interval.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Request Route Parameters**
-
-+--------------------------+--------+--------------------------------------------+
-| Parameter | Type | Description |
-+==========================+========+============================================+
-|``start_date`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``end_date`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``interval`` | string | |
-+--------------------------+--------+--------------------------------------------+
-
-**Response Properties**
-
-+-------------+--------+-------------+
-| Parameter | Type | Description |
-+=============+========+=============+
-| ``alerts`` | array | |
-+-------------+--------+-------------+
-| ``>level`` | string | |
-+-------------+--------+-------------+
-| ``>text`` | string | |
-+-------------+--------+-------------+
-| ``version`` | string | |
-+-------------+--------+-------------+
-
-**Response Example**
-
-TBD
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
index 391c278..bc9f775 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
@@ -636,7 +636,9 @@ Cache Group
+==============+=========+===============================================+
| action | string | queue or dequeue |
+--------------+---------+-----------------------------------------------+
- | cdn | string | cdn name |
+ | cdn | string | cdn name or cdn ID is required |
+ +--------------+---------+-----------------------------------------------+
+ | cdnId | string | cdn ID or cdn name is required |
+--------------+---------+-----------------------------------------------+
**Response Properties**
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/45597d7d/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
index d7e3c3c..650b0a9 100644
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
@@ -38,6 +38,8 @@ CDN
+-------------------+--------+-------------------------------------------------+
| ``name`` | string | CDN name. |
+-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
| ``dnssecEnabled`` | bool | DNSSEC enabled. |
+-------------------+--------+-------------------------------------------------+
| ``lastUpdated`` | string | |
@@ -49,13 +51,15 @@ CDN
"response": [
{
"id": "1"
- "name": "over-the-top",
+ "name": "cdn1",
+ "domainName": "cdn1.foo.com",
"dnssecEnabled": false,
"lastUpdated": "2014-10-02 08:22:43"
},
{
"id": "2"
"name": "cdn2",
+ "domainName": "cdn2.foo.com",
"dnssecEnabled": true,
"lastUpdated": "2014-10-02 08:22:43"
}
@@ -87,6 +91,8 @@ CDN
+-------------------+--------+-------------------------------------------------+
| ``name`` | string | CDN name. |
+-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
| ``dnssecEnabled`` | bool | DNSSEC enabled. |
+-------------------+--------+-------------------------------------------------+
| ``lastUpdated`` | string | |
@@ -99,6 +105,7 @@ CDN
{
"id": "2"
"name": "cdn2",
+ "domainName": "cdn2.foo.com",
"dnssecEnabled": false,
"lastUpdated": "2014-10-02 08:22:43"
}
@@ -130,6 +137,8 @@ CDN
+-------------------+--------+-------------------------------------------------+
| ``name`` | string | CDN name. |
+-------------------+--------+-------------------------------------------------+
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
| ``dnssecEnabled`` | bool | DNSSEC enabled. |
+-------------------+--------+-------------------------------------------------+
| ``lastUpdated`` | string | |
@@ -142,6 +151,7 @@ CDN
{
"id": "2"
"name": "cdn2",
+ "domainName": "cdn2.foo.com",
"dnssecEnabled": false,
"lastUpdated": "2014-10-02 08:22:43"
}
@@ -165,16 +175,19 @@ CDN
+===================+========+=================================================+
| ``name`` | string | CDN name. |
+-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
- | | | - 0: disabled |
- | | | - 1: enabled |
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | Whether dnssec is enabled. |
+ | | | - false: disabled |
+ | | | - true: enabled |
+-------------------+--------+-------------------------------------------------+
**Request Example** ::
{
"name": "cdn_test",
- "dnssecEnabled": 0
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": true
}
**Response Properties**
@@ -184,12 +197,14 @@ CDN
+====================+========+=================================================+
| ``response`` | hash | The details of the creation, if success. |
+--------------------+--------+-------------------------------------------------+
- | ``>name`` | string | CDN name. |
- +--------------------+--------+-------------------------------------------------+
| ``>id`` | int | CDN id. |
+--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
| ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+--------------------+--------+-------------------------------------------------+
+ | ``>domainName`` | string | TLD of the CDN. |
+ +--------------------+--------+-------------------------------------------------+
| ``alerts`` | array | A collection of alert messages. |
+--------------------+--------+-------------------------------------------------+
| ``>level`` | string | Success, info, warning or error. |
@@ -202,9 +217,10 @@ CDN
{
"response":{
- "name": "cdn_test",
"id": 3
- "dnssecEnabled": 0
+ "name": "cdn_test",
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": true
},
"alerts":[
{
@@ -239,9 +255,11 @@ CDN
+===================+========+=================================================+
| ``name`` | string | CDN name. |
+-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
- | | | - 0: disabled |
- | | | - 1: enabled |
+ | ``domainName`` | string | TLD of the CDN. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | Whether dnssec is enabled. |
+ | | | - false: disabled |
+ | | | - true: enabled |
+-------------------+--------+-------------------------------------------------+
@@ -249,7 +267,8 @@ CDN
{
"name": "cdn_test2",
- "dnssecEnabled": 0
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": false
}
**Response Properties**
@@ -263,7 +282,9 @@ CDN
+--------------------+--------+-------------------------------------------------+
| ``>id`` | int | CDN id. |
+--------------------+--------+-------------------------------------------------+
- | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ | ``>domainName`` | string | TLD of the CDN. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | bool | Whether dnssec is enabled. |
+--------------------+--------+-------------------------------------------------+
| ``alerts`` | array | A collection of alert messages. |
+--------------------+--------+-------------------------------------------------+
@@ -276,9 +297,10 @@ CDN
{
"response":{
+ "id": 3,
"name": "cdn_test2",
- "id": 3
- "dnssecEnabled": 0
+ "domainName": "cdn3.foo.com",
+ "dnssecEnabled": false
},
"alerts":[
{
@@ -331,6 +353,59 @@ CDN
|
+**POST /api/1.2/cdns/{:id}/queue_update**
+
+ Queue or dequeue updates for all servers assigned to a specific CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------+
+ | Name | Required | Description |
+ +=================+==========+======================+
+ | id | yes | the cdn id. |
+ +-----------------+----------+----------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "action": "queue"
+ }
+
+
+ **Response Properties**
+
+ +-----------------+---------+----------------------------------------------------+
+ | Name | Type | Description |
+ +=================+=========+====================================================+
+ | action | string | The action processed, queue or dequeue. |
+ +-----------------+---------+----------------------------------------------------+
+ | cdnId | integer | cdn id |
+ +-----------------+---------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "action": "queue",
+ "cdn": 1
+ }
+ }
+
+|
+
+
Health
++++++