You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/03/31 19:15:05 UTC
[1/2] incubator-trafficcontrol git commit: updates docs for ds apis
Repository: incubator-trafficcontrol
Updated Branches:
refs/heads/master bbbe70c52 -> 70dc1b032
updates docs for ds apis
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/cb1e5d94
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/cb1e5d94
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/cb1e5d94
Branch: refs/heads/master
Commit: cb1e5d9461fe4c3de1ce144b4e526b9e59997213
Parents: bbbe70c
Author: Jeremy Mitchell <mi...@gmail.com>
Authored: Fri Mar 31 12:49:14 2017 -0600
Committer: Dan Kirkwood <da...@gmail.com>
Committed: Fri Mar 31 13:14:36 2017 -0600
----------------------------------------------------------------------
.../traffic_ops_api/v12/deliveryservice.rst | 151 +++++++++----------
1 file changed, 71 insertions(+), 80 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/blob/cb1e5d94/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
----------------------------------------------------------------------
diff --git a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
index 6ceb1d7..4d0a575 100644
--- a/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
+++ b/docs/source/development/traffic_ops_api/v12/deliveryservice.rst
@@ -41,6 +41,8 @@ Delivery Service
+-----------------+----------+---------------------------------------------------+
| ``type`` | no | Filter delivery services by Type ID. |
+-----------------+----------+---------------------------------------------------+
+ | ``logsEnabled`` | no | Filter by logs enabled (true|false). |
+ +-----------------+----------+---------------------------------------------------+
**Response Properties**
@@ -74,6 +76,8 @@ Delivery Service
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimitRedirectUrl`` | string | |
+--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``geoLimit`` | string | - 0: None - no limitations |
@@ -197,6 +201,9 @@ Delivery Service
"dnsBypassTtl": "30",
"dscp": "40",
"edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
"geoLimit": "0",
"geoLimitCountries": null,
"geoLimitRedirectURL": null,
@@ -1374,20 +1381,20 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| Parameter | Required | Description |
+========================+==========+=========================================================================================================+
- | xmlId | yes | Unique string that describes this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| active | yes | true if active, false if inactive. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| cacheurl | no | Cache URL rule to apply to this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | protocol | yes | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -1400,6 +1407,8 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimit | no | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from geo limit countries |
@@ -1409,8 +1418,6 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimitCountries | no | The geo limit countries. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoProvider | no | - 0: Maxmind(default) |
| | | - 1: Neustar |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -1426,49 +1433,45 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | no | Initial dispersion |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ipv6RoutingEnabled | no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | - false: No |
+ | | | - true: Yes |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc | no | Description field. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc1 | no | Description field 1. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc2 | no | Description field 2. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | matchList | yes | Array of matchList hashes. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >type | yes | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >setNumber | yes | The set Number of the matchList. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >pattern | yes | The regexp for the matchList. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLat | no | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLong | no | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | midHeaderRewrite | no | The MID header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| multiSiteOrigin | yes | 1 if enabled, 0 if disabled. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| orgServerFqdn | yes | 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. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | profileName | yes | Traffic router profile name, for example "CCR_CDN" |
+ | originShield | no | Origin shield |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| qstringIgnore | no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | remapText | no | Additional raw remap line text. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| rangeRequestHandling | no | How to treat range requests: |
| | | |
| | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
@@ -1476,28 +1479,24 @@ SSL Keys
| | | - 1 Use the background_fetch plugin. |
| | | - 2 Use the cache_range_requests plugin. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | type | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | displayName | yes | Display name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cdnName | yes | cdn name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassCname | no | Bypass CNAME |
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | Traffic router additional response headers |
+ | regionalGeoBlocking | no | Is the Regional Geo Blocking feature enabled for this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | initialDispersion | no | Initial dispersion |
+ | remapText | no | Additional raw remap line text. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regionalGeoBlocking | no | Is the Regional Geo Blocking feature enabled for this delivery service. |
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| sslKeyVersion | no | SSL key version |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | originShield | no | Origin shield |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| trRequestHeaders | no | Traffic router log request headers |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | - false: No |
- | | | - true: Yes |
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | type | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -1622,20 +1621,20 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| Parameter | Required | Description |
+========================+==========+=========================================================================================================+
- | xmlId | yes | Unique string that describes this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| active | yes | true if active, false if inactive. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| cacheurl | no | Cache URL rule to apply to this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | protocol | yes | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ccrDnsTtl | no | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr.host. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | cdnId | yes | cdn id |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| checkPath | no | The path portion of the URL to check this deliveryservice for health. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | displayName | yes | Display name |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | dnsBypassCname | no | Bypass CNAME |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| dnsBypassIp | no | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| | | globalMaxMbps traffic on this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -1648,6 +1647,8 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| edgeHeaderRewrite | no | The EDGE header rewrite actions to perform. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimit | no | - 0: None - no limitations |
| | | - 1: Only route on CZF file hit |
| | | - 2: Only route on CZF hit or when from geo limit countries |
@@ -1657,8 +1658,6 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoLimitCountries | no | The geo limit countries. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | geoLimitRedirectURL | no | This is the URL Traffic Router will redirect to when Geo Limit Failure. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| geoProvider | no | - 0: Maxmind(default) |
| | | - 1: Neustar |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
@@ -1674,49 +1673,45 @@ SSL Keys
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| infoUrl | no | Use this to add a URL that points to more information about that deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | initialDispersion | no | Initial dispersion |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| ipv6RoutingEnabled | no | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | - false: No |
+ | | | - true: Yes |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc | no | Description field. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc1 | no | Description field 1. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| longDesc2 | no | Description field 2. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | matchList | yes | Array of matchList hashes. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >type | yes | The type of MatchList (one of :ref:to-api-v12-types use_in_table='regex'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >setNumber | yes | The set Number of the matchList. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | >pattern | yes | The regexp for the matchList. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| maxDnsAnswers | no | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| | | available). |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | midHeaderRewrite | no | The MID header rewrite actions to perform. |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLat | no | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| missLong | no | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | midHeaderRewrite | no | The MID header rewrite actions to perform. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| multiSiteOrigin | yes | 1 if enabled, 0 if disabled. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| orgServerFqdn | yes | 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. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | profileName | yes | Traffic router profile name, for example "CCR_CDN" |
+ | originShield | no | Origin shield |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | profileId | no | DS profile ID |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | protocol | yes | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| qstringIgnore | no | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
| | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
| | | - 2: drop query string at edge, and do not use it in the cache-key. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | remapText | no | Additional raw remap line text. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| rangeRequestHandling | no | How to treat range requests: |
| | | |
| | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will |
@@ -1724,28 +1719,24 @@ SSL Keys
| | | - 1 Use the background_fetch plugin. |
| | | - 2 Use the cache_range_requests plugin. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | type | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | displayName | yes | Display name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | cdnName | yes | cdn name |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | dnsBypassCname | no | Bypass CNAME |
+ | regexRemap | no | Regex Remap rule to apply to this delivery service at the Edge tier. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | trResponseHeaders | no | Traffic router additional response headers |
+ | regionalGeoBlocking | no | Is the Regional Geo Blocking feature enabled for this delivery service. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | initialDispersion | no | Initial dispersion |
+ | remapText | no | Additional raw remap line text. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | regionalGeoBlocking | no | Is the Regional Geo Blocking feature enabled for this delivery service. |
+ | signed | no | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
| sslKeyVersion | no | SSL key version |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | originShield | no | Origin shield |
- +------------------------+----------+---------------------------------------------------------------------------------------------------------+
| trRequestHeaders | no | Traffic router log request headers |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | - false: No |
- | | | - true: Yes |
+ | trResponseHeaders | no | Traffic router additional response headers |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | type | yes | The type of this deliveryservice (one of :ref:to-api-v12-types use_in_table='deliveryservice'). |
+ +------------------------+----------+---------------------------------------------------------------------------------------------------------+
+ | xmlId | yes | Unique string that describes this deliveryservice. |
+------------------------+----------+---------------------------------------------------------------------------------------------------------+
[2/2] incubator-trafficcontrol git commit: This closes #419
Posted by da...@apache.org.
This closes #419
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/commit/70dc1b03
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/tree/70dc1b03
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol/diff/70dc1b03
Branch: refs/heads/master
Commit: 70dc1b032e7ea19e695251613a74bb2c461b9fc7
Parents: cb1e5d9
Author: Dan Kirkwood <da...@gmail.com>
Authored: Fri Mar 31 13:14:52 2017 -0600
Committer: Dan Kirkwood <da...@gmail.com>
Committed: Fri Mar 31 13:14:52 2017 -0600
----------------------------------------------------------------------
----------------------------------------------------------------------