http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/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 new file mode 100644 index 0000000..0744760 --- /dev/null +++ b/docs/latest/_sources/admin/traffic_ops/using.txt @@ -0,0 +1,1106 @@ +.. +.. +.. 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. +.. + +.. |graph| image:: ../../../../traffic_ops/app/public/images/graph.png +.. |info| image:: ../../../../traffic_ops/app/public/images/info.png +.. |checkmark| image:: ../../../../traffic_ops/app/public/images/good.png +.. |X| image:: ../../../../traffic_ops/app/public/images/bad.png +.. |clock| image:: ../../../../traffic_ops/app/public/images/clock-black.png + +Traffic Ops - Using +%%%%%%%%%%%%%%%%%%% + + +The Traffic Ops Menu +==================== + +.. image:: ../12m.png + +The following tabs are available in the menu at the top of the Traffic Ops user interface. + +.. index:: + Health Tab + +* **Health** + + Information on the health of the system. Hover over this tab to get to the following options: + + +---------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Option | Description | + +===============+====================================================================================================================================+ + | Table View | A real time view into the main performance indicators of the CDNs managed by Traffic Control. | + | | This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds. | + | | This is the default screen of Traffic Ops. | + | | See :ref:`rl-health-table` for details. | + +---------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Graph View | A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control. | + | | This view is sourced by the Traffic Monitor data and is updated every 10 seconds. | + | | On loading, this screen will show a history of 24 hours of data from Traffic Stats | + | | See :ref:`rl-health-graph` for details. | + +---------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`rl-server-checks` | + +---------------+------------------------------------------------------------------------------------------------------------------------------------+ + | Daily Summary | A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation | + | | per CDN. | + +---------------+------------------------------------------------------------------------------------------------------------------------------------+ + +* **Delivery Services** + + The main Delivery Service table. This is where you Create/Read/Update/Delete Delivery Services of all types. Hover over to get the following sub option: + + +-------------+--------------------------------------+ + | Option | Description | + +=============+======================================+ + | Federations | Add/Edit/Delete Federation Mappings. | + +-------------+--------------------------------------+ + +* **Servers** + + The main Servers table. This is where you Create/Read/Update/Delete servers of all types. Click the main tab to get to the main table, and hover over to get these sub options: + + +-------------------+------------------------------------------------------------------------------------------+ + | Option | Description | + +===================+==========================================================================================+ + | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`rl-bulkserver` | + +-------------------+------------------------------------------------------------------------------------------+ + +* **Parameters** + + Parameters and Profiles can be edited here. Hover over the tab to get the following options: + + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Option | Description | + +=====================+=====================================================================================================================================================================+ + | Global Profile | The table of global parameters. See :ref:`rl-param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | All Cache Groups | The table of all parameters *that are assigned to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | All Profiles | The table of all parameters *that are assigned to a profile* - this may be slow to pull up, as there can be thousands of parameters. | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Select Profile | Select the parameter list by profile first, then get a table of just the parameters for that profile. | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Export Profile | Profiles can be exported from one Traffic Ops instance to another using 'Select Profile' and under the "Profile Details" dialog for the desired profile | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Import Profile | Profiles can be imported from one Traffic Ops instance to another using the button "Import Profile" after using the "Export Profile" feature | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Orphaned Parameters | A table of parameters that are not associated to any profile of cache group. These parameters either should be deleted or associated with a profile of cache group. | + +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +* **Tools** + + Tools for working with Traffic Ops and it's servers. Hover over this tab to get the following options: + + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Option | Description | + +====================+===================================================================================================================================+ + | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`rl-generate-iso` | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Queue Updates | Send Updates to the caches. See :ref:`rl-queue-updates` | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | DB Dump | Backup the Database to a .sql file. | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`rl-queue-updates` | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`rl-purge` | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + | Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN. | + +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ + + +* **Misc** + + Miscellaneous editing options. Hover over this tab to get the following options: + + +--------------------+-------------------------------------------------------------------------------------------+ + | Option | Description | + +====================+===========================================================================================+ + | CDNs | Create/Read/Update/Delete CDNs | + +--------------------+-------------------------------------------------------------------------------------------+ + | Cache Groups | Create/Read/Update/Delete cache groups | + +--------------------+-------------------------------------------------------------------------------------------+ + | Users | Create/Read/Update/Delete users | + +--------------------+-------------------------------------------------------------------------------------------+ + | Profiles | Create/Read/Update/Delete profiles. See :ref:`rl-working-with-profiles` | + +--------------------+-------------------------------------------------------------------------------------------+ + | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`rl-asn-czf` | + +--------------------+-------------------------------------------------------------------------------------------+ + | Hardware | Get detailed hardware information (note: this should be moved to a Traffic Ops Extension) | + +--------------------+-------------------------------------------------------------------------------------------+ + | Data Types | Create/Read/Update/Delete data types | + +--------------------+-------------------------------------------------------------------------------------------+ + | Divisions | Create/Read/Update/Delete divisions | + +--------------------+-------------------------------------------------------------------------------------------+ + | Regions | Create/Read/Update/Delete regions | + +--------------------+-------------------------------------------------------------------------------------------+ + | Physical Locations | Create/Read/Update/Delete locations | + +--------------------+-------------------------------------------------------------------------------------------+ + +.. index:: + Change Log + +* **ChangeLog** + + The Changelog table displays the changes that are being made to the Traffic Ops database through the Traffic Ops user interface. This tab will show the number of changes since you last visited this tab in (brackets) since the last time you visited this tab. There are currently no sub menus for this tab. + + +* **Help** + + Help for Traffic Ops and Traffic Control. Hover over this tab to get the following options: + + +---------------+---------------------------------------------------------------------+ + | Option | Description | + +===============+=====================================================================+ + | About | Traffic Ops information, such as version, database information, etc | + +---------------+---------------------------------------------------------------------+ + | Release Notes | Release notes for the most recent releases of Traffic Ops | + +---------------+---------------------------------------------------------------------+ + | Logout | Logout from Traffic Ops | + +---------------+---------------------------------------------------------------------+ + + +.. index:: + Edge Health + Health + +Health +====== + +.. _rl-health-table: + +The Health Table +++++++++++++++++ +The Health table is the default landing screen for Traffic Ops, it displays the status of the EDGE caches in a table form directly from Traffic Monitor (bypassing Traffic Stats), sorted by Mbps Out. The columns in this table are: + + +* **Profile**: the Profile of this server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values. +* **Host Name**: the host name of the server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values. +* **Edge Cache Group**: the edge cache group short name or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values. +* **Healthy**: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a |checkmark|, this column is valid only for individual EDGE caches. +* **Admin**: shows the administrative status of the server. +* **Connections**: the number of connections this cache (or group of caches) has open (``ats.proxy.process.http.current_client_connections`` from ATS). +* **Mbps Out**: the bandwidth being served out if this cache (or group of caches) + +Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops. + +.. _rl-health-graph: + +Graph View +++++++++++ +The Graph View shows a live view of the last 24 hours of bits per seconds served and open connections at the edge in a graph. This data is sourced from Traffic Stats. If there are 2 CDNs configured, this view will show the statistis for both, and the graphs are stacked. On the left-hand side, the totals and immediate values as well as the percentage of total possible capacity are displayed. This view is update every 10 seconds. + + +.. _rl-server-checks: + +Server Checks ++++++++++++++ +The server checks page is inteded to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from `Traffic Ops extensions <traffic_ops_extensions.html>`_. + ++------+-----------------------------------------------------------------------+ +| Name | Description | ++======+=======================================================================+ +| ILO | Ping the iLO interface for EDGE or MID servers | ++------+-----------------------------------------------------------------------+ +| 10G | Ping the IPv4 address of the EDGE or MID servers | ++------+-----------------------------------------------------------------------+ +| 10G6 | Ping the IPv6 address of the EDGE or MID servers | ++------+-----------------------------------------------------------------------+ +| MTU | Ping the EDGE or MID using the configured MTU from Traffic Ops | ++------+-----------------------------------------------------------------------+ +| FQDN | DNS check that matches what the DNS servers responds with compared to | +| | what Traffic Ops has. | ++------+-----------------------------------------------------------------------+ +| DSCP | Checks the DSCP value of packets from the edge server to the Traffic | +| | Ops server. | ++------+-----------------------------------------------------------------------+ +| RTR | Content Router checks. Checks the health of the Content Routers. | +| | Checks the health of the caches using the Content Routers. | ++------+-----------------------------------------------------------------------+ +| CHR | Cache Hit Ratio in percent. | ++------+-----------------------------------------------------------------------+ +| CDU | Total Cache Disk Usage in percent. | ++------+-----------------------------------------------------------------------+ +| ORT | Operational Readiness Test. Uses the ORT script on the edge and mid | +| | servers to determine if the configuration in Traffic Ops matches the | +| | configuration on the edge or mid. The user that this script runs as | +| | must have an ssh key on the edge servers. | ++------+-----------------------------------------------------------------------+ + +Daily Summary ++++++++++++++ +Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the `Traffic Stats <traffic_stats.html>`_ section. + +.. _rl-server: + +Server +====== +This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The **IPAddrr** column is clickable to launch an ``ssh://`` link to this server. The |graph| icon will link to a Traffic Stats graph of this server for caches, and the |info| will link to the server status pages for other server types. + + +Server Types +++++++++++++ +These are the types of servers that can be managed in Traffic Ops: + ++---------------+---------------------------------------------+ +| Name | Description | ++===============+=============================================+ +| EDGE | Edge Cache | ++---------------+---------------------------------------------+ +| MID | Mid Tier Cache | ++---------------+---------------------------------------------+ +| ORG | Origin | ++---------------+---------------------------------------------+ +| CCR | Traffic Router | ++---------------+---------------------------------------------+ +| RASCAL | Rascal health polling & reporting | ++---------------+---------------------------------------------+ +| TOOLS_SERVER | Ops hosts for managment | ++---------------+---------------------------------------------+ +| RIAK | Riak keystore | ++---------------+---------------------------------------------+ +| SPLUNK | SPLUNK indexer search head etc | ++---------------+---------------------------------------------+ +| TRAFFIC_STATS | traffic_stats server | ++---------------+---------------------------------------------+ +| INFLUXDB | influxDb server | ++---------------+---------------------------------------------+ + + +.. index:: + Bulk Upload Server + +.. _rl-bulkserver: + +Bulk Upload Server +++++++++++++++++++ +TBD + + +Delivery Service +================ +The fields in the Delivery Service view are: + +.. Sorry for the width of this table, don't know how to make the bullet lists work otherwise. Just set your monitor to 2560*1600, and put on your glasses. + ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Name | Description | ++==================================================+=====================================================================================================================================================================================================================+ +| XML ID | A unique string that identifies this delivery service. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Content Routing Type | The type of content routing this delivery service will use. See :ref:`rl-ds-types`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Protocol | The protocol to serve this delivery service to the clients with: | +| | | +| | - 0 http | +| | - 1 https | +| | - 2 both http and https | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DSCP Tag | The DSCP value to mark IP packets to the client with. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Signed URLs | Use Signed URLs? See :ref:`rl-signed-urls`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Query String Handling | How to treat query strings: | +| | | +| | - 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`. | +| | To set the qstring without the use of regex remap, or for further options, see :ref:`rl-qstring-handling`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Geo Limit? | Some services are intended to be limited by geography. The possible settings are are: | +| | | +| | - None - Do not limit by geography. | +| | - CZF only - If the requesting IP is not in the Coverage Zone File, do not serve the request. | +| | - CZF + US - If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Geo Limit Redirect URL | (for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See :ref:`rl-tr-ngb` | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bypass FQDN | (for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bypass Ipv4 | (For DNS routed delivery services only) This is the address to respond to A requests with when the the max Bps or Max Tps for this delivery service are exceeded. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bypass IPv6 | (For DNS routed delivery services only) This is the address to respond to AAAA requests with when the the max Bps or Max Tps for this delivery service are exceeded. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| IPv6 Routing Enabled? | When set to yes, the Traffic Router will respond to AAAA DNS requests for the tr. and edge. names of this delivery service. Otherwise, only A records will be served. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Range Request Handling | (experimental) How to treat range requests: | +| | | +| | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) | +| | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_ plugin. | +| | - 2 Use the cache_range_requests plugin. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records (``tr.<deliveryservice>.<cdn-domain>``) for a HTTP delivery service *or* for the A and | +| | AAAA records of the edge name (``edge.<deliveryservice>.<cdn-domain>``). | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Origin Server Base URL | The Origin Server's base URL. This includes the protocol (http or https). Example: ``http://movies.origin.com`` | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Use Multi Site Origin Feature | Enable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Maximum Transactions per Second allowed globally | The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used | +| | (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Geo Miss Default Latitude | Default Latitude for this delivery service. When client localization fails for both Coverage Zone and Geo Lookup, this the client will be routed as if it was at this lat. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Edge Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the EDGE tier. See :ref:`rl-header-rewrite`. [1]_ | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| 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]_ | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Raw remap text | For HTTP and DNS deliveryservices, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP deliveryservices this is the remap line. [1]_ | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Long Description | Long description for this delivery service. To be consumed from the APIs by downstream tools (Portal). | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Customer | Customer description for this delivery service. To be consumed from the APIs by downstream tools (Portal). | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Service | Service description for this delivery service. To be consumed from the APIs by downstream tools (Portal). | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Info URL | Info URL for this delivery service. To be consumed from the APIs by downstream tools (Portal). | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Check Path | A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Origin Shield (Pipe Delimited String) | Experimental. Origin Shield string. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Active | When this is set to no Traffic Router will not serve DNS or HTTP responses for this delivery service. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Last Updated | (Read Only) The last time this delivery service was updated. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Number of edges assigned | (Read Only - change by clicking the **Server Assignments** button at the bottom) The number of EDGE caches assigned to this delivery service. See :ref:`rl-assign-edges`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Number of static DNS entries | (Read Only - change by clicking the **Static DNS** button at the bottom) The number of static DNS entries for this delivery service. See :ref:`rl-static-dns`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Example delivery URL | (Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Regular expressions for this delivery service | A subtable of the regular expressions to use when routing traffic for this delivery service. See :ref:`rl-ds-regexp`. | ++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. [1] These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution. + + +.. index:: + Delivery Service Type + +.. _rl-ds-types: + +Delivery Service Types +++++++++++++++++++++++ +One of the most important settings when creating the delivery service is the selection of the delivery service *type*. This type determines the routing method and the primary storage for the delivery service. + ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Name | Description | ++=================+==============================================================================================================================================================================================================================================================================================================================+ +| HTTP | HTTP Content Routing - The Traffic Router DNS auth server returns its own IP address on DNS queries, and the client gets redirected to a specific cache | +| | in the nearest cache group using HTTP 302. Use this for long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is not a. | +| | problem. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DNS | DNS Content Routing - The Traffic Router DNS auth server returns an edge cache IP address to the client right away. The client will find the cache quickly | +| | but the Traffic Router can not route to a cache that already has this content in the cache group. Use this for smaller objects like web page images / objects. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HTTP_NO_CACHE | HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HTTP_LIVE | HTTP Content routing, but where for "standard" HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored | +| | on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DNS_LIVE_NATNL | DNS Content routing, but where for "standard" DNS content routing the objects are stored on disk, for this delivery service type the objects are stored | +| | on the RAM disks. Use this for linear TV. The MID tier is NOT bypassed for this type. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| DNS_LIVE | DNS Content routing, same as DNS_LIVE_NATNL, but the MID tier is bypassed. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| ANY_MAP | ANY_MAP is not known to Traffic Router. For this deliveryservice, the "Raw remap text" field in the input form will be used as the remap line on the cache. | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| STEERING | The Delivery Service will be used to route to other delivery services. The target delivery services Traffic Router and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the `steering feature <traffic_router.html#steering-feature>`_ documentation | ++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + + +.. Note:: Once created, the Traffic Ops user interface does not allow you to change the delivery service type; the drop down is greyed out. There are many things that can go wrong when changing the type, and it is safer to delete the delivery service, and recreate it. + +Federations ++++++++++++ + Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN's clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs. + + Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops `Federation API <../development/traffic_ops_api/v12/federation.html>`_. + +.. index:: + Header Rewrite + +.. _rl-header-rewrite: + +Header Rewrite Options and DSCP ++++++++++++++++++++++++++++++++ +Most header manipulation and per-delivery service configuration overrides are done using the `ATS Header Rewrite Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/header_rewrite.en.html>`_. Traffic Control allows you to enter header rewrite rules to be applied at the edge and at the mid level. The syntax used in Traffic Ops is the same as the one described in the ATS documentation, except for some special strings that will get replaced: + ++-------------------+--------------------------+ +| Traffic Ops Entry | Gets Replaced with | ++===================+==========================+ +| __RETURN__ | A newline | ++-------------------+--------------------------+ +| __CACHE_IPV4__ | The cache's IPv4 address | ++-------------------+--------------------------+ + +The deliveryservice screen also allows you to set the DSCP value of traffic sent to the client. This setting also results in a header_rewrite rule to be generated and applied to at the edge. + +.. Note:: The DSCP setting in the UI is *only* for setting traffic towards the client, and gets applied *after* the initial TCP handshake is complete, and the HTTP request is received (before that the cache can't determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked. + + +.. index:: + Token Based Authentication + Signed URLs + +.. _rl-signed-urls: + +Token Based Authentication +++++++++++++++++++++++++++ +Token based authentication or *signed URLs* is implemented using the Traffic Server ``url_sig`` plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters: + +Client IP address + The client IP address that this signature is valid for. + + ``C=<client IP address>`` + +Expiration + The Expiration time (seconds since epoch) of this signature. + + ``E=<expiration time in secs since unix epoch>`` + +Algorithm + The Algorithm used to create the signature. Only 1 (HMAC_SHA1) + and 2 (HMAC_MD5) are supported at this time + + ``A=<algorithm number>`` + +Key index + Index of the key used. This is the index of the key in the + configuration file on the cache. The set of keys is a shared + secret between the signing portal and the edge caches. There + is one set of keys per reverse proxy domain (fqdn). + + ``K=<key index used>`` +Parts + Parts to use for the signature, always excluding the scheme + (http://). parts0 = fqdn, parts1..x is the directory parts + of the path, if there are more parts to the path than letters + in the parts param, the last one is repeated for those. + Examples: + + 1: use fqdn and all of URl path + 0110: use part1 and part 2 of path only + 01: use everything except the fqdn + + ``P=<parts string (0's and 1's)>`` + +Signature + The signature over the parts + the query string up to and + including "S=". + + ``S=<signature>`` + +.. seealso:: The url_sig `README <https://github.com/apache/trafficserver/blob/master/plugins/experimental/url_sig/README>`_. + +Generate URL Sig Keys +^^^^^^^^^^^^^^^^^^^^^ +To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the **Generate URL Sig Keys** button at the bottom of the delivery service details screen. + + +.. rl-parent-selection: + +Parent Selection +++++++++++++++++ + +Parameters in the Edge (child) profile that influence this feature: + ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| Name | Filename | Default | Description | ++===============================================+================+===============+=======================================================+ +| CONFIG proxy.config. | records.config | INT 1 | enable parent selection. This is a required setting. | +| http.parent_proxy_routing_enable | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 1 | required for parent selection. | +| url_remap.remap_required | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 0 | See | +| http.no_dns_just_forward_to_parent | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 1 | | +| http.uncacheable_requests_bypass_parent | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 1 | | +| http.parent_proxy_routing_enable | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 300 | | +| http.parent_proxy.retry_time | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 10 | | +| http.parent_proxy.fail_threshold | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 4 | | +| http.parent_proxy.total_connect_attempts | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 2 | | +| http.parent_proxy.per_parent_connect_attempts | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 30 | | +| http.parent_proxy.connect_attempts_timeout | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 0 | | +| http.forward.proxy_auth_to_parent | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 0 | | +| http.parent_proxy_routing_enable | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | STRING | | +| http.parent_proxy.file | | parent.config | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| CONFIG proxy.config. | records.config | INT 3 | | +| http.parent_proxy.connect_attempts_timeout | | | | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ +| algorithm | parent.config | urlhash | The algorithm to use. | ++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+ + + +Parameters in the Mid (parent) profile that influence this feature: + ++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Name | Filename | Default | Description | ++================+===============+=========+===================================================================================================================================================================================+ +| domain_name | CRConfig.json | - | Only parents with the same value as the edge are going to be used as parents (to keep separation between CDNs) | ++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| weight | parent.config | 1.0 | The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to "consistent_hash" | ++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| port | parent.config | 80 | The port this parent is listening on as a forward proxy. | ++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| use_ip_address | parent.config | 0 | 1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation. | ++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _rl-qstring-handling: + +Qstring Handling +++++++++++++++++ + +Delivery services have a Query String Handling option that, when set to ignore, will automatically add a regex remap to that delivery service's config. There may be times this is not preferred, or there may be requirements for one delivery service or server(s) to behave differently. When this is required, the psel.qstring_handling parameter can be set in either the delivery service profile or the server profile, but it is important to note that the server profile will override ALL delivery services assigned to servers with this profile parameter. If the parameter is not set for the server profile but is present for the Delivery Service profile, this will override the setting in the delivery service. A value of "ignore" will not result in the addition of regex remap configuration. + ++-----------------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Name | Filename | Default | Description | ++=======================+===============+=========+===================================================================================================================================================================================+ +| psel.qstring_handling | parent.config | - | Sets qstring handling without the use of regex remap for a delivery service when assigned to a delivery service profile, and overrides qstring handling for all delivery services | +| | | | for associated servers when assigned to a server profile. Value must be "consider" or "ignore". | ++-----------------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _rl-multi-site-origin: + +Multi Site Origin ++++++++++++++++++ + +.. Note:: The configuration of this feature changed significantly between ATS version 5 and >= 6. Some configuration in Traffic Control is different as well. This documentation assumes ATS 6 or higher. See :ref:`rl-multi-site-origin-qht-ats5` for the ATS version 5.x configuration details. + +Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions. A prerequisite for MSO to work is that the multiple origin sites serve identical content with identical paths, and both are configured to serve the same origin hostname as is configured in the 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 mid profile that influence this feature: + ++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+ +| Name | Filename | Default | Description | ++==========================================================================+================+============+====================================================================================================+ +| CONFIG proxy.config. http.parent_proxy_routing_enable | records.config | INT 1 | enable parent selection. This is a required setting. | ++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+ +| CONFIG proxy.config. url_remap.remap_required | records.config | INT 1 | required for parent selection. | ++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+ + + +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: + +Traffic Router Profile +++++++++++++++++++++++ + ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Name | Config_file | Description | ++=========================================+========================+===========================================================================================================================================================================================================+ +| location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CDN_name | rascal-config.txt | The human readable name of the CDN for this profile. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| CoverageZoneJsonURL | CRConfig.xml | The location (URL) to retrieve the coverage zone map file in JSON format from. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| geolocation.polling.url | CRConfig.json | The location (URL) to retrieve the geo database file from. | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| geolocation.polling.interval | CRConfig.json | How often to refresh the coverage geo location database in ms | ++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| coveragezone.polling.interval | CRConfig.json | How often to refresh the coverage zone map in ms | ++-----------------------------------------+------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------
<TRUNCATED>
