You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2018/05/23 01:39:42 UTC
[incubator-trafficcontrol] 01/04: update portal ds fields
This is an automated email from the ASF dual-hosted git repository.
mitchell852 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-trafficcontrol.git
commit b15fc84c5285c6389baa4c4b3a25820ab5a49b2c
Author: Ashish Timilsina <ti...@gmail.com>
AuthorDate: Thu May 17 15:24:47 2018 -0600
update portal ds fields
---
.../app/src/traffic_portal_properties.json | 266 ++++++++++-----------
1 file changed, 133 insertions(+), 133 deletions(-)
diff --git a/traffic_portal/app/src/traffic_portal_properties.json b/traffic_portal/app/src/traffic_portal_properties.json
index fe30dc7..d22a1c7 100644
--- a/traffic_portal/app/src/traffic_portal_properties.json
+++ b/traffic_portal/app/src/traffic_portal_properties.json
@@ -135,7 +135,7 @@
"DNS": {
"routingName": "cdn",
"dscp": 0,
- "ipv6RoutingEnabled": false,
+ "ipv6RoutingEnabled": true,
"rangeRequestHandling": 0,
"qstringIgnore": 0,
"multiSiteOrigin": false,
@@ -153,7 +153,7 @@
"routingName": "cdn",
"deepCachingType": "NEVER",
"dscp": 0,
- "ipv6RoutingEnabled": false,
+ "ipv6RoutingEnabled": true,
"rangeRequestHandling": 0,
"qstringIgnore": 0,
"multiSiteOrigin": false,
@@ -171,7 +171,7 @@
"STEERING": {
"dscp": 0,
"routingName": "cdn",
- "ipv6RoutingEnabled": false,
+ "ipv6RoutingEnabled": true,
"logsEnabled": false,
"geoProvider": 0,
"geoLimit": 0,
@@ -183,75 +183,111 @@
"_comments": "This is the text used to configure delivery service field titles/descriptions",
"active": {
"title": "Active",
- "desc": "When this is set to false Traffic Router will not serve DNS or HTTP responses for this delivery service."
+ "desc": "Whether or not this delivery service is active on the CDN and is capable of traffic."
},
- "anonymousBlockingEnabled": {
- "title": "Anonymous Blocking",
- "desc": "Set to true to enable blocking of anonymous IPs for this delivery service -- requires MaxMind's Anonymous IP database."
+ "typeId": {
+ "title": "Content Routing Type",
+ "desc": "DNS is the standard routing type for most CDN services. HTTP Redirect is a specialty routing service that is primarily used for video and large file downloads where localization and latency are significant concerns. A \"Live\" routing type should be used for all live services.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-ds-types\" target=\"_blank\">See Delivery Service Types.</a>"
},
- "cacheurl": {
- "title": "Cache URL expression",
- "desc": "Cache URL rule to apply to this delivery service.<br><br>See <a href=\"https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html\" target=\"_blank\">ATS documentation on cacheurl...</a>"
+ "xmlId": {
+ "title": "Key (XML ID)",
+ "desc": "This id becomes a part of the CDN service domain in the form http://cdn.service-key.company.com/. Must be all lowercase, no spaces or special characters. May contain dashes."
},
- "ccrDnsTtl": {
- "title": "Delivery Service DNS TTL",
- "desc": "The Time To Live on the DNS record for the Traffic Router A and AAAA records."
+ "displayName": {
+ "title": "Display Name",
+ "desc": "Name of the service that appears in the Traffic portal. No character restrictions."
+ },
+ "tenantId": {
+ "title": "Tenant",
+ "desc": "Name of company or division of company who owns account. Allows you to group your services and control access. Tenants are setup as a simple hierarchy where you may create parent / child accounts."
},
"cdnId": {
"title": "CDN",
"desc": "The CDN in which the delivery service belongs to."
},
- "checkPath": {
- "title": "Check Path",
- "desc": "A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service."
+ "routingName": {
+ "title": "Routing Name",
+ "desc": "The routing name to use for the delivery FQDN, i.e. routing-name.deliveryservice.cdn-domain. It must be a valid hostname without periods."
+ },
+ "protocol": {
+ "title": "Protocol",
+ "desc": "The protocol to serve this delivery service to the clients with:<br><br> <ul><li>HTTP: Deliver only HTTP traffic</li><li>HTTPS: Deliver only HTTPS traffic </li><li>HTTP AND HTTPS: Deliver both types of traffic</li><li>HTTP TO HTTPS: Deliver HTTP traffic as HTTPS traffic. </li></ul><br>"
+ },
+ "dscp": {
+ "title": "DSCP Tag",
+ "desc": "The Differentiated Services Code Point (DSCP) value to mark IP packets to the client with."
+ },
+ "signingAlgorithm": {
+ "title": "Signing Algorithm",
+ "desc": "Type of URL signing method to sign the URLs:<br><ul><li>null: token based auth is not enabled for this delivery service.</li><li>“url_sig”: URL Sign token based auth is enabled for this delivery service.</li><li>“uri_signing”: URI Signing token based auth is enabled for this delivery service.</li></ul><br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-signed-urls\" target=\"_blank\">See Token Based Authentication</a>"
},
"deepCachingType": {
"title": "Deep Caching",
- "desc": "When to do deep caching for this delivery service.<br><br>See <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#rl-deep-cache\" target=\"_blank\">Deep Caching</a> for more details..."
+ "desc": "Enables clients to be routed to the closest possible deep edge caches on a per Delivery Service basis.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#rl-deep-cache\" target=\"_blank\">See Deep Caching</a>"
},
- "displayName": {
- "title": "Display Name",
- "desc": "A human-readable name for the delivery service."
+ "qstringIgnore": {
+ "title": "Query String Handling",
+ "desc": "How to treat query strings:<br><br><ul><li>0 use in cache key and hand up to origin: Each unique query string is treated as a unique URL.</li><li>1 Do not use in cache key, but pass up to origin: 2 URLs that are the same except for the query string will match and cache HIT, while the origin still sees original query string in the request.</li><li>2 Drop at edge: 2 URLs that are the same except for the query string will match and cache HIT, while the origin will not s [...]
},
- "dnsBypassCname": {
- "title": "DNS Bypass CNAME",
- "desc": "Description required"
+ "geoProvider": {
+ "title": "Geolocation Provider",
+ "desc": "Choose which Geolocation database provider, company that collects data on the location of IP addresses, to use."
+ },
+ "anonymousBlockingEnabled": {
+ "title": "Anonymous Blocking",
+ "desc": "Set to true to enable blocking of anonymous IPs for this delivery service. <b>Note:<b> Requires Geolocation provider's Anonymous IP database."
+ },
+ "geoLimit": {
+ "title": "Geo Limit",
+ "desc": "Some services are intended to be limited by geography. The possible settings are:<br><br><ul><li>None: Do not limit by geography.</li><li>CZF only: If the requesting IP is not in the Coverage Zone File, do not serve the request.</li><li>CZF + US: If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request.</li><br>"
+ },
+ "geoLimitCountries": {
+ "title": "Geo Limit Countries",
+ "desc": "How (if at all) is this service to be limited by geography. Example Country Codes: CA, IN, PR."
+ },
+ "geoLimitRedirectURL": {
+ "title": "Geo Limit Redirect URL",
+ "desc": "Traffic Router will redirect to this URL when Geo Limit check fails.<br><br>See <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#rl-tr-ngb\" target=\"_blank\">GeoLimit Failure Redirect</a> feature..."
+ },
+ "regionalGeoBlocking": {
+ "title": "Regional Geoblocking",
+ "desc": "Define regional geo-blocking rules for delivery services in a JSON format and set it to True/False. <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/regionalgeo.html#configure-regional-geo-blocking-rgb\" target=\"_blank\">See Regional Geo-blocking</a>"
+ },
+ "ipv6RoutingEnabled": {
+ "title": "IPv6 Routing Enabled",
+ "desc": "Default is True, entering False allows you to turn off CDN response to IPv6 requests"
+ },
+ "rangeRequestHandling": {
+ "title": "Range Request Handling",
+ "desc": "How to treat range requests.<br><br><ul><li>0: Do not cache (ranges requested from files that are already cached due to a non range request will be a HIT)</li><li>1: Use the <a href=\"https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html\" target=\"_blank\">background_fetch plugin.</a></li><li>2: Use the cache_range_requests plugin.</li></ul>"
},
"dnsBypassIp": {
"title": "DNS Bypass IP",
- "desc": "This is the address to respond to A requests with when the max Bps or Max Tps for this delivery service are exceeded."
+ "desc": "IPv4 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds."
},
"dnsBypassIp6": {
"title": "DNS Bypass IPv6",
- "desc": "This is the address to respond to AAAA requests with when the max Bps or Max Tps for this delivery service are exceeded."
+ "desc": "IPv6 address to overflow requests when the Max Bps or Max Tps for this delivery service exceeds."
+ },
+ "dnsBypassCname": {
+ "title": "DNS Bypass CNAME",
+ "desc": "Domain name to overflow requests when the Max Bps or Max Tps for this delivery service exceeds."
},
"dnsBypassTtl": {
"title": "DNS Bypass TTL",
- "desc": "Description required"
- },
- "dscp": {
- "title": "DSCP",
- "desc": "The DSCP value to mark IP packets to the client with."
- },
- "edgeHeaderRewrite": {
- "title": "Edge Header Rewrite Rules",
- "desc": "Header Rewrite rules to apply for this delivery service at the EDGE tier.<br><br>See <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-header-rewrite\" target=\"_blank\">Header Rewrite Options and DSCP...</a>"
+ "desc": "TTL for the DNS bypass domain or IP when threshold exceeds."
},
- "geoLimitRedirectURL": {
- "title": "Geo Limit Redirect URL",
- "desc": "This is the URL Traffic Router will redirect to when Geo Limit Failure.<br><br>See <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_router.html#rl-tr-ngb\" target=\"_blank\">GeoLimit Failure Redirect</a> feature..."
- },
- "geoLimit": {
- "title": "Geo Limit",
- "desc": "Some services are intended to be limited by geography.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#delivery-service\" target=\"_blank\">See more...</a>"
+ "httpBypassFqdn": {
+ "title": "HTTP Bypass FQDN",
+ "desc": "Traffic Router will redirect to this FQDN (with the same path) when the Max Bps or Max Tps for this delivery service exceeds."
},
- "geoLimitCountries": {
- "title": "Geo Limit Countries",
- "desc": "Description required"
+ "ccrDnsTtl": {
+ "title": "Delivery Service DNS TTL",
+ "desc": "The Time To Live on the DNS record for the Traffic Router A and AAAA records. Setting too high or too low will result in poor caching performance."
},
- "geoProvider": {
- "title": "Geolocation Provider",
- "desc": "Description required"
+ "fqPacingRate": {
+ "title": "Fair Queuing Pacing Rate Bps",
+ "desc": "The maximum bytes per second a cache will delivery on any single TCP connection. This uses the Linux kernel's Fair Queuing setsockopt(SO_MAX_PACING_RATE) to limit the rate of delivery."
},
"globalMaxMbps": {
"title": "Global Max Mbps",
@@ -261,49 +297,25 @@
"title": "Global Max TPS",
"desc": "The maximum transactions 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."
},
- "fqPacingRate": {
- "title": "Fair Queuing Pacing Rate Bps",
- "desc": "The maximum bytes per second a cache will delivery on any single TCP connection. This uses the Linux kernel's Fair Queuing setsockopt(SO_MAX_PACING_RATE) to limit the rate of delivery."
- },
- "httpBypassFqdn": {
- "title": "HTTP Bypass FQDN",
- "desc": "This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this delivery service are exceeded."
- },
- "infoUrl": {
- "title": "Info URL",
- "desc": "Info URL for this delivery service."
+ "maxDnsAnswers": {
+ "title": "Max DNS Answers",
+ "desc": "It is used to restrict the number of cache IP addresses that the CCR will hand back. A numeric value from 1 to 15 which determines how many caches your content will be spread across in a particular site. When a customer requests your content they will get 1 to 15 IP addresses back they can use. These are rotated in each response. Ideally the number will reflect the amount of traffic. 1 = trial account with very little traffic, 2 = small production service. Add 1 more [...]
},
"initialDispersion": {
"title": "Initial Dispersion",
- "desc": "Description required"
- },
- "ipv6RoutingEnabled": {
- "title": "IPv6 Routing Enabled",
- "desc": "When set to true, the Traffic Router will respond to AAAA DNS requests for the routed name of this delivery service. Otherwise, only A records will be served."
- },
- "logsEnabled": {
- "title": "Logs Enabled",
- "desc": "Description required"
+ "desc": "Determines number of machines content will be placed on within a cache group. Setting too high will result in poor caching performance."
},
- "longDesc": {
- "title": "Long Description",
- "desc": "Long description for this delivery service."
- },
- "longDesc1": {
- "title": "Long Description 2",
- "desc": "Long description 2 for this delivery service."
- },
- "longDesc2": {
- "title": "Long Description 3",
- "desc": "Long description 3 for this delivery service."
+ "orgServerFqdn": {
+ "title": "Origin Server Base URL",
+ "desc": "The Origin Server’s base URL which includes the protocol (http or https). Example: http://movies.origin.com. Must be a domain only, no directories or IP addresses"
},
- "maxDnsAnswers": {
- "title": "Max DNS Answers",
- "desc": "Description required"
+ "multiSiteOrigin": {
+ "title": "Use Multi Site Origin Feature",
+ "desc": "Set True/False to enable/disable the Multi Site Origin feature for this delivery service.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-multi-site-origin\" target=\"_blank\">See Multi Site Origin.</a>"
},
- "midHeaderRewrite": {
- "title": "Mid Header Rewrite Rules",
- "desc": "Header Rewrite rules to apply for this delivery service at the EDGE tier.<br><br>See <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-header-rewrite\" target=\"_blank\">Header Rewrite Options and DSCP...</a>"
+ "profileId": {
+ "title": "Delivery Service Profile",
+ "desc": "Only used if a delivery service uses configurations that specifically require a profile. Example: MSO configurations or cachekey plugin would require a ds profile to be used."
},
"missLat": {
"title": "Geo Miss Default Latitude",
@@ -313,73 +325,61 @@
"title": "Geo Miss Default Longitude",
"desc": "Default Longitude for this delivery service. When client localization fails for both Coverage Zone and Geo Lookup, the client will be routed as if it was at this long."
},
- "multiSiteOrigin": {
- "title": "Use Multi Site Origin Feature",
- "desc": "Enable the Multi Site Origin feature for this delivery service.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-multi-site-origin\" target=\"_blank\">See Multi Site Origin...</a>"
- },
- "orgServerFqdn": {
- "title": "Origin Server Base URL",
- "desc": "The Origin Server’s base URL. This includes the protocol (http or https). Example: http://movies.origin.com"
- },
- "originShield": {
- "title": "Origin Shield (Pipe Delimited String)",
- "desc": "Description required"
- },
- "profileId": {
- "title": "Delivery Service Profile",
- "desc": "Description required"
+ "edgeHeaderRewrite": {
+ "title": "Edge Header Rewrite Rules",
+ "desc": "Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Example [...]
},
- "protocol": {
- "title": "Protocol",
- "desc": "The protocol to serve this delivery service to the clients with.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#delivery-service\" target=\"_blank\">See more...</a>"
+ "midHeaderRewrite": {
+ "title": "Mid Header Rewrite Rules",
+ "desc": "Headers can be added or altered at each layer of the CDN. You must tell us four things: the action, the header name, the header value, and the direction to apply. The action will tell us whether we are adding, removing, or replacing headers. The header name and header value will determine the full header text. The direction will determine whether we add it before we respond to a request or before we make a request further up the chain in the server hierarchy. Example [...]
},
- "qstringIgnore": {
- "title": "Query String Handling",
- "desc": "How to treat query strings.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#delivery-service\" target=\"_blank\">See more...</a>"
+ "trResponseHeaders": {
+ "title": "Traffic Router Additional Response Headers",
+ "desc": "List of header name:value pairs separated by __RETURN__. Listed pairs will be included in all TR HTTP responses."
},
- "rangeRequestHandling": {
- "title": "Range Request Handling",
- "desc": "How to treat range requests.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#delivery-service\" target=\"_blank\">See more...</a>"
+ "trRequestHeaders": {
+ "title": "Traffic Router Log Request Headers",
+ "desc": "List of header keys separated by __RETURN__. Listed headers will be included in TR access log entries under the “rh=” token."
},
"regexRemap": {
"title": "Regex remap expression",
- "desc": "Regex Remap rule to apply to this delivery service at the Edge tier.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#delivery-service\" target=\"_blank\">See more...</a>"
+ "desc": "Allows remapping of incoming requests URL using regex pattern matching to search/replace text.<br><br><a href=\"https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html\" target=\"_blank\">See ATS documentation on regex remap</a><br><b>Note:</b> 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. <a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin [...]
},
- "regionalGeoBlocking": {
- "title": "Regional Geoblocking",
- "desc": "Description required"
+ "cacheurl": {
+ "title": "Cache URL expression",
+ "desc": "Allows you to manipulate the cache key of the incoming requests. Normally, the cache key is the origin domain. This can be changed so that multiple services can share a cache key, can also be used to preserve cached content if service origin is changed.<br><b>Note:</b> Only valid in ATS 6. X and earlier. Must be empty if using ATS 7. X and / or the <a href = \"https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cachekey.en.html\" target=\"_blank\">cac [...]
},
"remapText": {
"title": "Raw remap text",
"desc": "For HTTP and DNS delivery services, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP delivery services this is the remap line."
},
- "routingName": {
- "title": "Routing Name",
- "desc": "The routing name to use for the delivery FQDN, i.e. routing-name.deliveryservice.cdn-domain. It must be a valid hostname without periods."
+ "longDesc": {
+ "title": "Long Description",
+ "desc": "Free text field that describes the purpose of the delivery service and will be displayed in the portal as a description field."
},
- "signingAlgorithm": {
- "title": "Signing Algorithm",
- "desc": "Description required"
+ "longDesc1": {
+ "title": "Long Description 2",
+ "desc": "Free text field not currently used in configuration. For example, you can use this field to describe your customer type."
},
- "tenantId": {
- "title": "Tenant",
- "desc": "By selecting a tenant for the delivery service, you restrict access of that delivery service to only those users that belong to the same tenant or a parent tenant."
+ "longDesc2": {
+ "title": "Long Description 3",
+ "desc": "Free text field not currently used in configuration."
},
- "trRequestHeaders": {
- "title": "Traffic Router Log Request Headers",
- "desc": "Description required"
+ "infoUrl": {
+ "title": "Info URL",
+ "desc": "Free text field used to enter a URL which provides information about the service."
},
- "trResponseHeaders": {
- "title": "Traffic Router Additional Response Headers",
- "desc": "Description required"
+ "checkPath": {
+ "title": "Check Path",
+ "desc": "A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service."
},
- "typeId": {
- "title": "Content Routing Type",
- "desc": "The type of content routing this delivery service will use.<br><br><a href=\"http://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_ops/using.html#rl-ds-types\" target=\"_blank\">See Delivery Service Types....</a>"
+ "originShield": {
+ "title": "Origin Shield (Pipe Delimited String)",
+ "desc": "Add another forward proxy upstream of the mid caches. Example: go_direct=true will allow the Mid to hit the origin directly instead of failing if the origin shield is down. Experimental Feature."
},
- "xmlId": {
- "title": "Key (XML ID)",
- "desc": "A unique string that identifies this delivery service."
+ "logsEnabled": {
+ "title": "Logs Enabled",
+ "desc": "Allows you to turn on/off logging for the service"
}
}
}
--
To stop receiving notification emails like this one, please contact
mitchell852@apache.org.