Google Git
Sign in
apache / trafficcontrol-website / 8582b168d85ce6c219f4008aab22ce481f24bcd9 / . / docs / 1.1.3 / _sources / admin / traffic_ops_using.txt
blob: 5ec168b30391ee06e276465c4606632704d95135 [file] [log] [blame]
..
.. Copyright 2015 Comcast Cable Communications Management, LLC
..
.. Licensed under the Apache License, Version 2.0 (the "License");
.. you may not use this file except in compliance with the License.
.. You may obtain a copy of the License at
..
.. http://www.apache.org/licenses/LICENSE-2.0
..
.. Unless required by applicable law or agreed to in writing, software
.. distributed under the License is distributed on an "AS IS" BASIS,
.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
.. See the License for the specific language governing permissions and
.. limitations under the License.
..
.. |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
Using Traffic Ops
%%%%%%%%%%%%%%%%%
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. There are currently no sub menus for this tab.
* **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 assgined 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 assgined 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. |
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 the CDN. See :ref:`rl-purge` |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
| Generate DNSSEC keys | Neuman? |
+----------------------+-----------------------------------------------------------------------------------------------------------------------------------+
* **Misc**
Miscellaneous editing options. Hover over this tab to get the following options:
+--------------------+-------------------------------------------------------------------------------------------+
| Option | Description |
+====================+===========================================================================================+
| 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
+++++++++++++
Server Checks are ..
Daily Summary
+++++++++++++
.. _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 | Comcast Content Router |
+---------------+---------------------------------------------+
| RASCAL | Rascal health polling & reporting |
+---------------+---------------------------------------------+
| REDIS | Redis stats gateway (will be obsolete soon) |
+---------------+---------------------------------------------+
| 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
++++++++++++++++++
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. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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/reference/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 |
| | AAAAA 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` |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| CCR profile | The Traffic Router profile for this delivery service. See :ref:`rl-ccr-profile`. |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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 bot 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/reference/plugins/regex_remap.en.html>`_. [1]_ |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Cache URL expression | Cache URL rule to apply to this delivery service. See `ATS documentation on cacheurl <https://docs.trafficserver.apache.org/en/latest/reference/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. See :ref:`rl-org-shield` |
+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| 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, ut 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_NATIONAL, 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. |
+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. 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.
.. 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/reference/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.
.. index::
CCR Profile
Traffic Router Profile
.. _rl-multi-site-origin:
Multi Site Origin
+++++++++++++++++
.. Note:: The Multi Site Origin feature is based upon a feature n ATS that has yet to be submitted to Traffic Server upstream, until it is, set this to 0.
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.
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 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 ""
Parameters in the Origin profile that influence this feature:
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| Name | Default | Description |
+=========================================================================+============+===================================================================================================+
| CONFIG proxy.config.http.parent_proxy_routing_enable | INT 1 | enable parent selection. This is a required setting. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.url_remap.remap_required | INT 1 | required for parent selection. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_proxy.per_parent_connect_attempts | INT 5 | maximum of 5 connection attempts per parent (parent.config list) within a transaction. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_proxy.total_connect_attempts | INT 10 | maximum of 10 total connection attempts within a transaction. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_origin.simple_retry_enabled | INT 1 | enables simple retry. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_origin.simple_retry_response_codes | STRING 404 | the response code that invokes simple retry. May be a comman separated list of response codes. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_origin.dead_server_retry_response_codes | STRING 503 | the response code that invokes dead server retry. May be a comma separated list of response codes|
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.http.parent_origin.dead_server_retry_enabled | INT 1 | enables dead server retry. |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
| CONFIG proxy.config.diags.debug.enabled | INT 1 | enable debugging for testing only |
+-------------------------------------------------------------------------+------------+---------------------------------------------------------------------------------------------------+
.. _rl-ccr-profile:
CCR Profile or 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 |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in XML format from. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| domain_name | CRConfig.json | The top level domain of this Traffic Router instance. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.ttls.AAAA | CRConfig.json | The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.ttls.A | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.soa.admin | CRConfig.json | The DNS Start of Authority admin. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.soa.retry | CRConfig.json | The value for the retry field the Traffic Router DNS Server will respond with on SOA records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.soa.refresh | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.ttls.NS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on NS records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| tld.ttls.SOA | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on SOA records. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| api.port | server.xml | The TCP port Traffic Router listens on for API (REST) access. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
| api.cache-control.max-age | CRConfig.json | The value of the ``Cache-Control: max-age=`` header in the API responses of Traffic Router. |
+---------------------------------------+------------------------+---------------------------------------------------------------------------------------------------------------------+
.. index::
HOST_REGEXP
PATH_REGEXP
HEADER_REGEXP
Delivery Service regexp
.. _rl-ds-regexp:
Delivery Service Regexp
+++++++++++++++++++++++
This table defines how requests are matched to the delivery service. There are 3 type of entries possible here:
+---------------+----------------------------------------------------------------------+--------------+-----------+
| Name | Description | DS Type | Status |
+===============+======================================================================+==============+===========+
| HOST_REGEXP | This is the regular expresion to match the host part of the URL. | DNS and HTTP | Supported |
+---------------+----------------------------------------------------------------------+--------------+-----------+
| PATH_REGEXP | This is the regular expresion to match the path part of the URL. | HTTP | Beta |
+---------------+----------------------------------------------------------------------+--------------+-----------+
| HEADER_REGEXP | This is the regular expresion to match on any header in the request. | HTTP | Beta |
+---------------+----------------------------------------------------------------------+--------------+-----------+
The **Order** entry defines the order in which the regular expressions get evaluated. To support ``CNAMES`` from domains outside of the Traffic Control top level DNS domain, enter multiple ``HOST_REGEXP`` lines.
Example:
Example foo.
.. Note:: In most cases is is sufficient to have just one entry in this table that has a ``HOST_REGEXP`` Type, and Order ``0``. For the *movies* delivery service in the Kabletown CDN, the entry is simply single ``HOST_REGEXP`` set to ``.*\.movies\..*``. This will match every url that has a hostname that ends with ``movies.cdn1.kabletown.net``, since ``cdn1.kabletown.net`` is the Kabletown CDN's DNS domain.
.. index::
Static DNS Entries
.. _rl-static-dns:
Static DNS Entries
++++++++++++++++++
Static DNS entries allow you to create other names *under* the delivery service domain. You can enter any valid hostname, and create a CNAME, A or AAAA record for it by clicking the **Static DNS** button at the bottom of the delivery service details screen.
.. index::
Server Assignments
.. _rl-assign-edges:
Server Assignments
++++++++++++++++++
Click the **Server Assignments** button at the bottom of the screen to assign servers to this delivery service. Servers can be selected by drilling down in a tree, starting at the profile, then the cache group, and then the individual servers. Traffic Router will only route traffic for this delivery service to servers that are assigned to it.
.. _rl-asn-czf:
The Coverage Zone File and ASN Table
++++++++++++++++++++++++++++++++++++
The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form: ::
{
"coverageZones": {
"cache-group-01": {
"network6": [
"1234:5678::\/64",
"1234:5679::\/64"
],
"network": [
"192.168.8.0\/24",
"192.168.9.0\/24"
]
}
"cache-group-02": {
"network6": [
"1234:567a::\/64",
"1234:567b::\/64"
],
"network": [
"192.168.4.0\/24",
"192.168.5.0\/24"
]
}
}
}
The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the "Networks (ASNs)" view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.
The script that generates the CZF file is not part of Traffic Control, since it is different for each situation.
.. _rl-working-with-profiles:
Parameters and Profiles
=======================
Parameters are shared between profiles if the set of ``{ name, config_file, value }`` is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (**Add Parameter** button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the **Misc > Profiles** view - just use the **Add/Copy Profile** button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that use the **Parameters > Orphaned Parameters** view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.
.. seealso:: :ref:`rl-param-prof` in the *Configuring Traffic Ops* section.
Tools
=====
.. index::
ISO
Generate ISO
.. _rl-generate-iso:
Generate ISO
++++++++++++
.. _rl-queue-updates:
Queue Updates and Snapshot CRConfig
+++++++++++++++++++++++++++++++++++
When changing delivery services special care has to be taken so that Traffic Router will not send traffic to caches for delivery services that the cache doesn't know about yet. In general, when adding delivery services, or adding servers to a delivery service, it is best to update the caches before updating Traffic Router and Traffic Monitor. When deleting delivery services, or deleting server assignments to delivery services, it is best to update Traffic Router and Traffic Monitor first and then the caches. Updating the cache configuration is done through the *Queue Updates* menu, and updating Traffic Monitor and Traffic Router config is done through the *Snapshot CRConfig* menu.
.. index::
Cache Updates
Queue Updates
Queue Updates
^^^^^^^^^^^^^
Every 15 minutes the caches will run a *syncds* to get all changes needed from Traffic Ops. The files that will be updated by the syncds job are:
- records.config
- remap.config
- parent.config
- cache.config
- hosting.config
- url\_sig\_(.*)\.config
- hdr\_rw\_(.*)\.config
- regex_revalidate.config
- ip_allow.config
A cache will only get updated when the update flag is set for it. To set the update flag, use the *Queue Updates* menu - here you can schedule updates for a whole CDN or a cache group:
#. Click **Tools > Queue Updates**.
#. Select the CDN to queueu uodates for, or All.
#. Select the cache group to queue updates for, or All
#. Click the **Queue Updates** button.
#. When the Queue Updates for this Server? (all) window opens, click **OK**.
To schedule updates for just one cache, use the "Server Checks" page, and click the |checkmark| in the *UPD* column. The UPD column of Server Checks page will change show a |clock| when updates are pending for that cache.
.. index::
Snapshot CRConfig
Snapshot CRConfig
^^^^^^^^^^^^^^^^^
Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot was made. If there is a new CRCOnfig, it will apply it to both Traffic Monitor and Traffic Router. See :ref:`rl-crconfig` for more information on the CRConfig file. To create a new snapshot, use the *Tools > Snapshot CRConfig* menu:
#. Click **Tools > Snapshot CRConfig**.
#. Verify the selection of the correct CDN from the Choose CDN drop down and click **Diff CRConfig**.
On initial selection of this, the CRConfig Diff window says the following:
There is no existing CRConfig for [cdn] to diff against... Is this the first snapshot???
If you are not sure why you are getting this message, please do not proceed!
To proceed writing the snapshot anyway click the 'Write CRConfig' button below.
If there is an older version of the CRConfig, a window will pop up showing the differences
between the active CRConfig and the CRConfig about to be written.
#. Click **Write CRConfig**.
#. When the This will push out a new CRConfig.json. Are you sure? window opens, click **OK**.
#. The Successfully wrote CRConfig.json! window opens, click **OK**.
.. index::
Invalidate Content
Purge
.. _rl-purge:
Invalidate Content
==================
Invalidating content on the CDN is sometimes necessary when the origin was mis configured and something is cached in the CDN caches that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content in accessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
To invalidate content:
1. Click **Tools > Invalidate Content**
2. Fill out the form fields:
- Select the **Delivery Service**
- Enter the **Path Regex** - this should be a `PCRE <http://www.pcre.org/>`_ compatible regular expression for the path to match for forcing the revalidation. Be careful to only match on the content you need to remove - revalidation is an expensive operation for many origins, and a simple ``/.*`` can cause an overload condition of the origin.
- Enter the **Time To Live** - this is how long the revalidation force will be active for. It usually makes sense to make this the same as the ``Cache-Control`` header from the origin sets the object time to live in cache (by ``max-age`` or ``Expires``). Entering a longer TTL here will make the caches do unnecessary work.
- Enter the **Start Time** - this is the start time when the force revalidation will be made active. Is pre populated with the current time, leave as is to schedule ASAP.
3. Click the **Submit** button.
Generate DNSSEC Keys
====================
TBD