http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/admin/traffic_ops/using.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_ops/using.html b/docs/latest/admin/traffic_ops/using.html new file mode 100644 index 0000000..d4690b7 --- /dev/null +++ b/docs/latest/admin/traffic_ops/using.html @@ -0,0 +1,1726 @@ + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Traffic Ops - Using — Traffic Control 2.1-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/> + <link rel="up" title="Administratorâs Guide" href="../index.html"/> + <link rel="next" title="Managing Traffic Ops Extensions" href="extensions.html"/> + <link rel="prev" title="Traffic Ops - Configuring" href="configuration.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_portal.html">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_router.html">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/building.html">Building Traffic Control</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../development/traffic_server.html">Traffic Server</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li> + + <li><a href="../index.html">Administrator’s Guide</a> »</li> + + <li>Traffic Ops - Using</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/admin/traffic_ops/using.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="extensions.html" class="btn btn-neutral float-right" title="Managing Traffic Ops Extensions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="configuration.html" class="btn btn-neutral" title="Traffic Ops - Configuring"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="traffic-ops-using"> +<h1>Traffic Ops - Using<a class="headerlink" href="#traffic-ops-using" title="Permalink to this headline">¶</a></h1> +<div class="section" id="the-traffic-ops-menu"> +<h2>The Traffic Ops Menu<a class="headerlink" href="#the-traffic-ops-menu" title="Permalink to this headline">¶</a></h2> +<img alt="../../_images/12m.png" src="../../_images/12m.png" /> +<p>The following tabs are available in the menu at the top of the Traffic Ops user interface.</p> +<ul id="index-0"> +<li><p class="first"><strong>Health</strong></p> +<p>Information on the health of the system. Hover over this tab to get to the following options:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="10%" /> +<col width="90%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Table View</td> +<td>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 <a class="reference internal" href="#rl-health-table"><span class="std std-ref">The Health Table</span></a> for details.</td> +</tr> +<tr class="row-odd"><td>Graph View</td> +<td>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 <a class="reference internal" href="#rl-health-graph"><span class="std std-ref">Graph View</span></a> for details.</td> +</tr> +<tr class="row-even"><td>Server Checks</td> +<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><span class="std std-ref">Server Checks</span></a></td> +</tr> +<tr class="row-odd"><td>Daily Summary</td> +<td>A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation +per CDN.</td> +</tr> +</tbody> +</table> +</li> +<li><p class="first"><strong>Delivery Services</strong></p> +<p>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:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="75%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Federations</td> +<td>Add/Edit/Delete Federation Mappings.</td> +</tr> +</tbody> +</table> +</li> +<li><p class="first"><strong>Servers</strong></p> +<p>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:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="17%" /> +<col width="83%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Upload Server CSV</td> +<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><span class="std std-ref">Bulk Upload Server</span></a></td> +</tr> +</tbody> +</table> +</li> +<li><p class="first"><strong>Parameters</strong></p> +<p>Parameters and Profiles can be edited here. Hover over the tab to get the following options:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="11%" /> +<col width="89%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Global Profile</td> +<td>The table of global parameters. See <a class="reference internal" href="configuration.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td> +</tr> +<tr class="row-odd"><td>All Cache Groups</td> +<td>The table of all parameters <em>that are assigned to a cachegroup</em> - this may be slow to pull up, as there can be thousands of parameters.</td> +</tr> +<tr class="row-even"><td>All Profiles</td> +<td>The table of all parameters <em>that are assigned to a profile</em> - this may be slow to pull up, as there can be thousands of parameters.</td> +</tr> +<tr class="row-odd"><td>Select Profile</td> +<td>Select the parameter list by profile first, then get a table of just the parameters for that profile.</td> +</tr> +<tr class="row-even"><td>Export Profile</td> +<td>Profiles can be exported from one Traffic Ops instance to another using ‘Select Profile’ and under the “Profile Details” dialog for the desired profile</td> +</tr> +<tr class="row-odd"><td>Import Profile</td> +<td>Profiles can be imported from one Traffic Ops instance to another using the button “Import Profile” after using the “Export Profile” feature</td> +</tr> +<tr class="row-even"><td>Orphaned Parameters</td> +<td>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.</td> +</tr> +</tbody> +</table> +</li> +<li><p class="first"><strong>Tools</strong></p> +<p>Tools for working with Traffic Ops and it’s servers. Hover over this tab to get the following options:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="87%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Generate ISO</td> +<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><span class="std std-ref">Generate ISO</span></a></td> +</tr> +<tr class="row-odd"><td>Queue Updates</td> +<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td> +</tr> +<tr class="row-even"><td>DB Dump</td> +<td>Backup the Database to a .sql file.</td> +</tr> +<tr class="row-odd"><td>Snapshot CRConfig</td> +<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td> +</tr> +<tr class="row-even"><td>Invalidate Content</td> +<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><span class="std std-ref">Invalidate Content</span></a></td> +</tr> +<tr class="row-odd"><td>Manage DNSSEC keys</td> +<td>Manage DNSSEC Keys for a chosen CDN.</td> +</tr> +</tbody> +</table> +</li> +<li><p class="first"><strong>Misc</strong></p> +<p>Miscellaneous editing options. Hover over this tab to get the following options:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="82%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>CDNs</td> +<td>Create/Read/Update/Delete CDNs</td> +</tr> +<tr class="row-odd"><td>Cache Groups</td> +<td>Create/Read/Update/Delete cache groups</td> +</tr> +<tr class="row-even"><td>Users</td> +<td>Create/Read/Update/Delete users</td> +</tr> +<tr class="row-odd"><td>Profiles</td> +<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><span class="std std-ref">Parameters and Profiles</span></a></td> +</tr> +<tr class="row-even"><td>Networks(ASNs)</td> +<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a></td> +</tr> +<tr class="row-odd"><td>Hardware</td> +<td>Get detailed hardware information (note: this should be moved to a Traffic Ops Extension)</td> +</tr> +<tr class="row-even"><td>Data Types</td> +<td>Create/Read/Update/Delete data types</td> +</tr> +<tr class="row-odd"><td>Divisions</td> +<td>Create/Read/Update/Delete divisions</td> +</tr> +<tr class="row-even"><td>Regions</td> +<td>Create/Read/Update/Delete regions</td> +</tr> +<tr class="row-odd"><td>Physical Locations</td> +<td>Create/Read/Update/Delete locations</td> +</tr> +</tbody> +</table> +</li> +</ul> +<ul id="index-1"> +<li><p class="first"><strong>ChangeLog</strong></p> +<p>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.</p> +</li> +<li><p class="first"><strong>Help</strong></p> +<p>Help for Traffic Ops and Traffic Control. Hover over this tab to get the following options:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="18%" /> +<col width="82%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>About</td> +<td>Traffic Ops information, such as version, database information, etc</td> +</tr> +<tr class="row-odd"><td>Release Notes</td> +<td>Release notes for the most recent releases of Traffic Ops</td> +</tr> +<tr class="row-even"><td>Logout</td> +<td>Logout from Traffic Ops</td> +</tr> +</tbody> +</table> +</li> +</ul> +</div> +<div class="section" id="health"> +<span id="index-2"></span><h2>Health<a class="headerlink" href="#health" title="Permalink to this headline">¶</a></h2> +<div class="section" id="the-health-table"> +<span id="rl-health-table"></span><h3>The Health Table<a class="headerlink" href="#the-health-table" title="Permalink to this headline">¶</a></h3> +<p>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:</p> +<ul class="simple"> +<li><strong>Profile</strong>: the Profile of this server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.</li> +<li><strong>Host Name</strong>: 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.</li> +<li><strong>Edge Cache Group</strong>: 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.</li> +<li><strong>Healthy</strong>: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a <img alt="checkmark" src="../../_images/good.png" />, this column is valid only for individual EDGE caches.</li> +<li><strong>Admin</strong>: shows the administrative status of the server.</li> +<li><strong>Connections</strong>: the number of connections this cache (or group of caches) has open (<code class="docutils literal"><span class="pre">ats.proxy.process.http.current_client_connections</span></code> from ATS).</li> +<li><strong>Mbps Out</strong>: the bandwidth being served out if this cache (or group of caches)</li> +</ul> +<p>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.</p> +</div> +<div class="section" id="graph-view"> +<span id="rl-health-graph"></span><h3>Graph View<a class="headerlink" href="#graph-view" title="Permalink to this headline">¶</a></h3> +<p>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.</p> +</div> +<div class="section" id="server-checks"> +<span id="rl-server-checks"></span><h3>Server Checks<a class="headerlink" href="#server-checks" title="Permalink to this headline">¶</a></h3> +<p>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 <a class="reference external" href="traffic_ops_extensions.html">Traffic Ops extensions</a>.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="8%" /> +<col width="92%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>ILO</td> +<td>Ping the iLO interface for EDGE or MID servers</td> +</tr> +<tr class="row-odd"><td>10G</td> +<td>Ping the IPv4 address of the EDGE or MID servers</td> +</tr> +<tr class="row-even"><td>10G6</td> +<td>Ping the IPv6 address of the EDGE or MID servers</td> +</tr> +<tr class="row-odd"><td>MTU</td> +<td>Ping the EDGE or MID using the configured MTU from Traffic Ops</td> +</tr> +<tr class="row-even"><td>FQDN</td> +<td>DNS check that matches what the DNS servers responds with compared to +what Traffic Ops has.</td> +</tr> +<tr class="row-odd"><td>DSCP</td> +<td>Checks the DSCP value of packets from the edge server to the Traffic +Ops server.</td> +</tr> +<tr class="row-even"><td>RTR</td> +<td>Content Router checks. Checks the health of the Content Routers. +Checks the health of the caches using the Content Routers.</td> +</tr> +<tr class="row-odd"><td>CHR</td> +<td>Cache Hit Ratio in percent.</td> +</tr> +<tr class="row-even"><td>CDU</td> +<td>Total Cache Disk Usage in percent.</td> +</tr> +<tr class="row-odd"><td>ORT</td> +<td>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.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="daily-summary"> +<h3>Daily Summary<a class="headerlink" href="#daily-summary" title="Permalink to this headline">¶</a></h3> +<p>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 <a class="reference external" href="traffic_stats.html">Traffic Stats</a> section.</p> +</div> +</div> +<div class="section" id="server"> +<span id="rl-server"></span><h2>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h2> +<p>This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The <strong>IPAddrr</strong> column is clickable to launch an <code class="docutils literal"><span class="pre">ssh://</span></code> link to this server. The <img alt="graph" src="../../_images/graph.png" /> icon will link to a Traffic Stats graph of this server for caches, and the <img alt="info" src="../../_images/info.png" /> will link to the server status pages for other server types.</p> +<div class="section" id="server-types"> +<h3>Server Types<a class="headerlink" href="#server-types" title="Permalink to this headline">¶</a></h3> +<p>These are the types of servers that can be managed in Traffic Ops:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="25%" /> +<col width="75%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>EDGE</td> +<td>Edge Cache</td> +</tr> +<tr class="row-odd"><td>MID</td> +<td>Mid Tier Cache</td> +</tr> +<tr class="row-even"><td>ORG</td> +<td>Origin</td> +</tr> +<tr class="row-odd"><td>CCR</td> +<td>Traffic Router</td> +</tr> +<tr class="row-even"><td>RASCAL</td> +<td>Rascal health polling & reporting</td> +</tr> +<tr class="row-odd"><td>TOOLS_SERVER</td> +<td>Ops hosts for managment</td> +</tr> +<tr class="row-even"><td>RIAK</td> +<td>Riak keystore</td> +</tr> +<tr class="row-odd"><td>SPLUNK</td> +<td>SPLUNK indexer search head etc</td> +</tr> +<tr class="row-even"><td>TRAFFIC_STATS</td> +<td>traffic_stats server</td> +</tr> +<tr class="row-odd"><td>INFLUXDB</td> +<td>influxDb server</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="bulk-upload-server"> +<span id="rl-bulkserver"></span><span id="index-3"></span><h3>Bulk Upload Server<a class="headerlink" href="#bulk-upload-server" title="Permalink to this headline">¶</a></h3> +<p>TBD</p> +</div> +</div> +<div class="section" id="delivery-service"> +<h2>Delivery Service<a class="headerlink" href="#delivery-service" title="Permalink to this headline">¶</a></h2> +<p>The fields in the Delivery Service view are:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="19%" /> +<col width="81%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>XML ID</td> +<td>A unique string that identifies this delivery service.</td> +</tr> +<tr class="row-odd"><td>Content Routing Type</td> +<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td> +</tr> +<tr class="row-even"><td>Protocol</td> +<td><p class="first">The protocol to serve this delivery service to the clients with:</p> +<ul class="last simple"> +<li>0 http</li> +<li>1 https</li> +<li>2 both http and https</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>DSCP Tag</td> +<td>The DSCP value to mark IP packets to the client with.</td> +</tr> +<tr class="row-even"><td>Signed URLs</td> +<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</td> +</tr> +<tr class="row-odd"><td>Query String Handling</td> +<td><p class="first">How to treat query strings:</p> +<ul class="simple"> +<li>0 use in cache key and hand up to origin -this means each unique query string Is treated as a unique URL.</li> +<li>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.</li> +<li>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.</li> +</ul> +<p class="last"><strong>Note:</strong> Choosing to drop query strings at the edge will preclude the use of a Regex Remap Expression. See <a class="reference internal" href="#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>. +To set the qstring without the use of regex remap, or for further options, see <a class="reference internal" href="#rl-qstring-handling"><span class="std std-ref">Qstring Handling</span></a>.</p> +</td> +</tr> +<tr class="row-even"><td>Geo Limit?</td> +<td><p class="first">Some services are intended to be limited by geography. The possible settings are are:</p> +<ul class="last simple"> +<li>None - Do not limit by geography.</li> +<li>CZF only - If the requesting IP is not in the Coverage Zone File, do not serve the request.</li> +<li>CZF + US - If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>Geo Limit Redirect URL</td> +<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <a class="reference internal" href="../traffic_router.html#rl-tr-ngb"><span class="std std-ref">GeoLimit Failure Redirect feature</span></a></td> +</tr> +<tr class="row-even"><td>Bypass FQDN</td> +<td>(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.</td> +</tr> +<tr class="row-odd"><td>Bypass Ipv4</td> +<td>(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.</td> +</tr> +<tr class="row-even"><td>Bypass IPv6</td> +<td>(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.</td> +</tr> +<tr class="row-odd"><td>IPv6 Routing Enabled?</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>Range Request Handling</td> +<td><p class="first">(experimental) How to treat range requests:</p> +<ul class="last simple"> +<li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> +<li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html";>background_fetch</a> plugin.</li> +<li>2 Use the cache_range_requests plugin.</li> +</ul> +</td> +</tr> +<tr class="row-odd"><td>Delivery Service DNS TTL</td> +<td>The Time To Live on the DNS record for the Traffic Router A and AAAA records (<code class="docutils literal"><span class="pre">tr.<deliveryservice>.<cdn-domain></span></code>) for a HTTP delivery service <em>or</em> for the A and +AAAA records of the edge name (<code class="docutils literal"><span class="pre">edge.<deliveryservice>.<cdn-domain></span></code>).</td> +</tr> +<tr class="row-even"><td>Origin Server Base URL</td> +<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal"><span class="pre">http://movies.origin.com</span></code></td> +</tr> +<tr class="row-odd"><td>Use Multi Site Origin Feature</td> +<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> +</tr> +<tr class="row-even"><td>Profile</td> +<td>The profile for this delivery service.</td> +</tr> +<tr class="row-odd"><td>Maximum Bits per Second allowed globally</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>Maximum Transactions per Second allowed globally</td> +<td>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.</td> +</tr> +<tr class="row-odd"><td>Geo Miss Default Latitude</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>Geo Miss Default Longitude</td> +<td>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.</td> +</tr> +<tr class="row-odd"><td>Edge Header Rewrite Rules</td> +<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td> +</tr> +<tr class="row-even"><td>Mid Header Rewrite Rules</td> +<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td> +</tr> +<tr class="row-odd"><td>Regex Remap Expression</td> +<td><p class="first">Regex Remap rule to apply to this delivery service at the Edge tier. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html";>ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id6" id="id3">[1]</a></p> +<p class="last"><strong>Note:</strong> 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 <a class="reference internal" href="#rl-regex-remap"><span class="std std-ref">Regex Remap Expression</span></a>.</p> +</td> +</tr> +<tr class="row-even"><td>Cache URL expression</td> +<td>Cache URL rule to apply to this delivery service. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html";>ATS documentation on cacheurl</a>. <a class="footnote-reference" href="#id6" id="id4">[1]</a></td> +</tr> +<tr class="row-odd"><td>Raw remap text</td> +<td>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. <a class="footnote-reference" href="#id6" id="id5">[1]</a></td> +</tr> +<tr class="row-even"><td>Long Description</td> +<td>Long description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td> +</tr> +<tr class="row-odd"><td>Customer</td> +<td>Customer description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td> +</tr> +<tr class="row-even"><td>Service</td> +<td>Service description for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td> +</tr> +<tr class="row-odd"><td>Info URL</td> +<td>Info URL for this delivery service. To be consumed from the APIs by downstream tools (Portal).</td> +</tr> +<tr class="row-even"><td>Check Path</td> +<td>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.</td> +</tr> +<tr class="row-odd"><td>Origin Shield (Pipe Delimited String)</td> +<td>Experimental. Origin Shield string.</td> +</tr> +<tr class="row-even"><td>Active</td> +<td>When this is set to no Traffic Router will not serve DNS or HTTP responses for this delivery service.</td> +</tr> +<tr class="row-odd"><td>Last Updated</td> +<td>(Read Only) The last time this delivery service was updated.</td> +</tr> +<tr class="row-even"><td>Number of edges assigned</td> +<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><span class="std std-ref">Server Assignments</span></a>.</td> +</tr> +<tr class="row-odd"><td>Number of static DNS entries</td> +<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><span class="std std-ref">Static DNS Entries</span></a>.</td> +</tr> +<tr class="row-even"><td>Example delivery URL</td> +<td>(Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.</td> +</tr> +<tr class="row-odd"><td>Regular expressions for this delivery service</td> +<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><span class="std std-ref">Delivery Service Regexp</span></a>.</td> +</tr> +</tbody> +</table> +<table class="docutils footnote" frame="void" id="id6" rules="none"> +<colgroup><col class="label" /><col /></colgroup> +<tbody valign="top"> +<tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id1">1</a>, <a class="fn-backref" href="#id2">2</a>, <a class="fn-backref" href="#id3">3</a>, <a class="fn-backref" href="#id4">4</a>, <a class="fn-backref" href="#id5">5</a>)</em> 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.</td></tr> +</tbody> +</table> +<div class="section" id="delivery-service-types"> +<span id="rl-ds-types"></span><span id="index-4"></span><h3>Delivery Service Types<a class="headerlink" href="#delivery-service-types" title="Permalink to this headline">¶</a></h3> +<p>One of the most important settings when creating the delivery service is the selection of the delivery service <em>type</em>. This type determines the routing method and the primary storage for the delivery service.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="5%" /> +<col width="95%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>HTTP</td> +<td>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.</td> +</tr> +<tr class="row-odd"><td>DNS</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>HTTP_NO_CACHE</td> +<td>HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed.</td> +</tr> +<tr class="row-odd"><td>HTTP_LIVE</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>HTTP_LIVE_NATNL</td> +<td>HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed.</td> +</tr> +<tr class="row-odd"><td>DNS_LIVE_NATNL</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>DNS_LIVE</td> +<td>DNS Content routing, same as DNS_LIVE_NATNL, but the MID tier is bypassed.</td> +</tr> +<tr class="row-odd"><td>ANY_MAP</td> +<td>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.</td> +</tr> +<tr class="row-even"><td>STEERING</td> +<td>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 <a class="reference external" href="traffic_router.html#steering-feature">steering feature</a> documentation</td> +</tr> +</tbody> +</table> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">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.</p> +</div> +</div> +<div class="section" id="federations"> +<h3>Federations<a class="headerlink" href="#federations" title="Permalink to this headline">¶</a></h3> +<blockquote> +<div><p>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.</p> +<p>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 <a class="reference external" href="../development/traffic_ops_api/v12/federation.html">Federation API</a>.</p> +</div></blockquote> +</div> +<div class="section" id="header-rewrite-options-and-dscp"> +<span id="rl-header-rewrite"></span><span id="index-5"></span><h3>Header Rewrite Options and DSCP<a class="headerlink" href="#header-rewrite-options-and-dscp" title="Permalink to this headline">¶</a></h3> +<p>Most header manipulation and per-delivery service configuration overrides are done using the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/header_rewrite.en.html";>ATS Header Rewrite Plugin</a>. 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:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="42%" /> +<col width="58%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Traffic Ops Entry</th> +<th class="head">Gets Replaced with</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>__RETURN__</td> +<td>A newline</td> +</tr> +<tr class="row-odd"><td>__CACHE_IPV4__</td> +<td>The cache’s IPv4 address</td> +</tr> +</tbody> +</table> +<p>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.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">The DSCP setting in the UI is <em>only</em> for setting traffic towards the client, and gets applied <em>after</em> 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.</p> +</div> +</div> +<div class="section" id="token-based-authentication"> +<span id="rl-signed-urls"></span><span id="index-6"></span><h3>Token Based Authentication<a class="headerlink" href="#token-based-authentication" title="Permalink to this headline">¶</a></h3> +<p>Token based authentication or <em>signed URLs</em> is implemented using the Traffic Server <code class="docutils literal"><span class="pre">url_sig</span></code> 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:</p> +<dl class="docutils"> +<dt>Client IP address</dt> +<dd><p class="first">The client IP address that this signature is valid for.</p> +<p class="last"><code class="docutils literal"><span class="pre">C=<client</span> <span class="pre">IP</span> <span class="pre">address></span></code></p> +</dd> +<dt>Expiration</dt> +<dd><p class="first">The Expiration time (seconds since epoch) of this signature.</p> +<p class="last"><code class="docutils literal"><span class="pre">E=<expiration</span> <span class="pre">time</span> <span class="pre">in</span> <span class="pre">secs</span> <span class="pre">since</span> <span class="pre">unix</span> <span class="pre">epoch></span></code></p> +</dd> +<dt>Algorithm</dt> +<dd><p class="first">The Algorithm used to create the signature. Only 1 (HMAC_SHA1) +and 2 (HMAC_MD5) are supported at this time</p> +<p class="last"><code class="docutils literal"><span class="pre">A=<algorithm</span> <span class="pre">number></span></code></p> +</dd> +<dt>Key index</dt> +<dd><p class="first">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).</p> +<p class="last"><code class="docutils literal"><span class="pre">K=<key</span> <span class="pre">index</span> <span class="pre">used></span></code></p> +</dd> +<dt>Parts</dt> +<dd><p class="first">Parts to use for the signature, always excluding the scheme +(<a class="reference external" href="http://";>http://</a>). 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:</p> +<blockquote> +<div>1: use fqdn and all of URl path +0110: use part1 and part 2 of path only +01: use everything except the fqdn</div></blockquote> +<p class="last"><code class="docutils literal"><span class="pre">P=<parts</span> <span class="pre">string</span> <span class="pre">(0's</span> <span class="pre">and</span> <span class="pre">1's)></span></code></p> +</dd> +<dt>Signature</dt> +<dd><p class="first">The signature over the parts + the query string up to and +including “S=”.</p> +<p class="last"><code class="docutils literal"><span class="pre">S=<signature></span></code></p> +</dd> +</dl> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last">The url_sig <a class="reference external" href="https://github.com/apache/trafficserver/blob/master/plugins/experimental/url_sig/README";>README</a>.</p> +</div> +<div class="section" id="generate-url-sig-keys"> +<h4>Generate URL Sig Keys<a class="headerlink" href="#generate-url-sig-keys" title="Permalink to this headline">¶</a></h4> +<p>To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the <strong>Generate URL Sig Keys</strong> button at the bottom of the delivery service details screen.</p> +</div> +</div> +<div class="section" id="parent-selection"> +<h3>Parent Selection<a class="headerlink" href="#parent-selection" title="Permalink to this headline">¶</a></h3> +<p>Parameters in the Edge (child) profile that influence this feature:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="35%" /> +<col width="12%" /> +<col width="11%" /> +<col width="41%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Filename</th> +<th class="head">Default</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>CONFIG proxy.config. +http.parent_proxy_routing_enable</td> +<td>records.config</td> +<td>INT 1</td> +<td>enable parent selection. This is a required setting.</td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +url_remap.remap_required</td> +<td>records.config</td> +<td>INT 1</td> +<td>required for parent selection.</td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.no_dns_just_forward_to_parent</td> +<td>records.config</td> +<td>INT 0</td> +<td>See</td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.uncacheable_requests_bypass_parent</td> +<td>records.config</td> +<td>INT 1</td> +<td> </td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.parent_proxy_routing_enable</td> +<td>records.config</td> +<td>INT 1</td> +<td> </td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.parent_proxy.retry_time</td> +<td>records.config</td> +<td>INT 300</td> +<td> </td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.parent_proxy.fail_threshold</td> +<td>records.config</td> +<td>INT 10</td> +<td> </td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.parent_proxy.total_connect_attempts</td> +<td>records.config</td> +<td>INT 4</td> +<td> </td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.parent_proxy.per_parent_connect_attempts</td> +<td>records.config</td> +<td>INT 2</td> +<td> </td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.parent_proxy.connect_attempts_timeout</td> +<td>records.config</td> +<td>INT 30</td> +<td> </td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.forward.proxy_auth_to_parent</td> +<td>records.config</td> +<td>INT 0</td> +<td> </td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.parent_proxy_routing_enable</td> +<td>records.config</td> +<td>INT 0</td> +<td> </td> +</tr> +<tr class="row-even"><td>CONFIG proxy.config. +http.parent_proxy.file</td> +<td>records.config</td> +<td>STRING +parent.config</td> +<td> </td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. +http.parent_proxy.connect_attempts_timeout</td> +<td>records.config</td> +<td>INT 3</td> +<td> </td> +</tr> +<tr class="row-even"><td>algorithm</td> +<td>parent.config</td> +<td>urlhash</td> +<td>The algorithm to use.</td> +</tr> +</tbody> +</table> +<p>Parameters in the Mid (parent) profile that influence this feature:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="7%" /> +<col width="7%" /> +<col width="4%" /> +<col width="82%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Filename</th> +<th class="head">Default</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>domain_name</td> +<td>CRConfig.json</td> +<td><ul class="first last simple"> +<li></li> +</ul> +</td> +<td>Only parents with the same value as the edge are going to be used as parents (to keep separation between CDNs)</td> +</tr> +<tr class="row-odd"><td>weight</td> +<td>parent.config</td> +<td>1.0</td> +<td>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”</td> +</tr> +<tr class="row-even"><td>port</td> +<td>parent.config</td> +<td>80</td> +<td>The port this parent is listening on as a forward proxy.</td> +</tr> +<tr class="row-odd"><td>use_ip_address</td> +<td>parent.config</td> +<td>0</td> +<td>1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="qstring-handling"> +<span id="rl-qstring-handling"></span><h3>Qstring Handling<a class="headerlink" href="#qstring-handling" title="Permalink to this headline">¶</a></h3> +<p>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.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="10%" /> +<col width="7%" /> +<col width="4%" /> +<col width="79%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Filename</th> +<th class="head">Default</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>psel.qstring_handling</td> +<td>parent.config</td> +<td><ul class="first last simple"> +<li></li> +</ul> +</td> +<td>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”.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="multi-site-origin"> +<span id="rl-multi-site-origin"></span><h3>Multi Site Origin<a class="headerlink" href="#multi-site-origin" title="Permalink to this headline">¶</a></h3> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">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 <a class="reference internal" href="../quick_howto/multi_site_ats5.html#rl-multi-site-origin-qht-ats5"><span class="std std-ref">Configure Multi Site Origin (5.x)</span></a> for the ATS version 5.x configuration details.</p> +</div> +<p>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 <cite>Origin Server Base URL</cite> field. See the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/parent.config.en.html";>Apache Traffic Server docs</a> for more information on that cache’s implementation.</p> +<p>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”.</p> +<p>Parameters in the mid profile that influence this feature:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="37%" /> +<col width="8%" /> +<col width="6%" /> +<col width="50%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Filename</th> +<th class="head">Default</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>CONFIG proxy.config. http.parent_proxy_routing_enable</td> +<td>records.config</td> +<td>INT 1</td> +<td>enable parent selection. This is a required setting.</td> +</tr> +<tr class="row-odd"><td>CONFIG proxy.config. url_remap.remap_required</td> +<td>records.config</td> +<td>INT 1</td> +<td>required for parent selection.</td> +</tr> +</tbody> +</table> +<p>Parameters in the deliveryservice profile that influence this feature:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="22%" /> +<col width="8%" /> +<col width="8%" /> +<col width="62%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Filename</th> +<th class="head">Default</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>mso.parent_retry</td> +<td>parent.config</td> +<td>-</td> +<td>Either <code class="docutils literal"><span class="pre">simple_retry</span></code>, <code class="docutils literal"><span class="pre">dead_server_retry</span></code> or <code class="docutils literal"><span class="pre">both</span></code>.</td> +</tr> +<tr class="row-odd"><td>mso.algorithm</td> +<td>parent.config</td> +<td>consistent_hash</td> +<td><p class="first">The algorithm to use. <code class="docutils literal"><span class="pre">consisten_hash</span></code>, <code class="docutils literal"><span class="pre">strict</span></code>, <code class="docutils literal"><span class="pre">true</span></code>, <code class="docutils literal"><span class="pre">false</span></code>, or <code class="docutils literal"><span class="pre">latched</span></code>.</p> +<ul class="last simple"> +<li><code class="docutils literal"><span class="pre">consisten_hash</span></code> - spreads requests across multiple parents simultaneously based on hash of content URL.</li> +<li><code class="docutils literal"><span class="pre">strict</span></code> - strict Round Robin spreads requests across multiple parents simultaneously based on order of requests.</li> +<li><code class="docutils literal"><span class="pre">true</span></code> - same as strict, but ensures that requests from the same IP always go to the same parent if available.</li> +<li><code class="docutils literal"><span class="pre">false</span></code> - uses only a single parent at any given time and switches to a new parent only if the current parent fails.</li> +<li><code class="docutils literal"><span class="pre">latched</span></code> - same as false, but now, a failed parent will not be retried.</li> +</ul> +</td> +</tr> +<tr class="row-even"><td>mso.unavailable_server_retry_response_codes</td> +<td>parent.config</td> +<td>“503”</td> +<td>Quoted, comma separated list of HTTP status codes that count as a unavailable_server_retry_response_code.</td> +</tr> +<tr class="row-odd"><td>mso.max_unavailable_server_retries</td> +<td>parent.config</td> +<td>1</td> +<td>How many times an unavailable server will be retried.</td> +</tr> +<tr class="row-even"><td>mso.simple_retry_response_codes</td> +<td>parent.config</td> +<td>“404”</td> +<td>Quoted, comma separated list of HTTP status codes that count as a simple retry response code.</td> +</tr> +<tr class="row-odd"><td>mso.max_simple_retries</td> +<td>parent.config</td> +<td>1</td> +<td>How many times a simple retry will be done.</td> +</tr> +</tbody> +</table> +<p>see <a class="reference internal" href="../quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for a <em>quick how to</em> on this feature.</p> +</div> +<div class="section" id="traffic-router-profile"> +<span id="rl-ccr-profile"></span><h3>Traffic Router Profile<a class="headerlink" href="#traffic-router-profile" title="Permalink to this headline">¶</a></h3> +<table border="1" class="docutils"> +<colgroup> +<col width="15%" /> +<col width="9%" /> +<col width="76%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Config_file</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>location</td> +<td>dns.zone</td> +<td>Location to store the DNS zone files in the local file system of Traffic Router.</td> +</tr> +<tr class="row-odd"><td>location</td> +<td>http-log4j.properties</td> +<td>Location to find the log4j.properties file for Traffic Router.</td> +</tr> +<tr class="row-even"><td>location</td> +<td>dns-log4j.properties</td> +<td>Location to find the dns-log4j.properties file for Traffic Router.</td> +</tr> +<tr class="row-odd"><td>location</td> +<td>geolocation.properties</td> +<td>Location to find the log4j.properties file for Traffic Router.</td> +</tr> +<tr class="row-even"><td>CDN_name</td> +<td>rascal-config.txt</td> +<td>The human readable name of the CDN for this profile.</td> +</tr> +<tr class="row-odd"><td>CoverageZoneJsonURL</td> +<td>CRConfig.xml</td> +<td>The location (URL) to retrieve the coverage zone map file in JSON format from.</td> +</tr> +<tr class="row-even"><td>geolocation.polling.url</td> +<td>CRConfig.json</td> +<td>The location (URL) to retrieve the geo database file from.</td> +</tr> +<tr class="row-odd"><td>geolocation.polling.interval</td> +<td>CRConfig.json</td> +<td>How often to refresh the coverage geo location database in ms</td> +</tr> +<tr class="row-even"><td>coveragezone.polling.interval</td> +<td>CRConfig.json</td> +<td>How often to refresh the coverage zone map in ms</td> +</tr> +<tr class="row-odd"><td>coveragezone.polling.url</td> +<td>CRConfig.json</td> +<td>The location (URL) to retrieve the coverage zone map file in XML format from.</td> +</tr> +<tr class="row-even"><td>tld.soa.expire</td> +<td>CRConfig.json</td> +<td>The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records.</td> +</tr> +<tr class="row-odd"><td>tld.soa.minimum</td> +<td>CRConfig.json</td> +<td>The value for the minimum field the Traffic Router DNS Server will respond with on SOA records.</td> +</tr> +<tr class="row-even"><td>tld.soa.admin</td> +<td>CRConfig.json</td> +<td>The DNS Start of Authority admin. Should be a valid support email address for support if DNS is not working correctly.</td> +</tr> +<tr class="row-odd"><td>tld.soa.retry</td> +<td>CRConfig.json</td> +<td>The value for the retry field the Traffic Router DNS Server will respond with on SOA records.</td> +</tr> +<tr class="row-even"><td>tld.soa.refresh</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on A records.</td> +</tr> +<tr class="row-odd"><td>tld.ttls.NS</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on NS records.</td> +</tr> +<tr class="row-even"><td>tld.ttls.SOA</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on SOA records.</td> +</tr> +<tr class="row-odd"><td>tld.ttls.AAAA</td> +<td>CRConfig.json</td> +<td>The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records.</td> +</tr> +<tr class="row-even"><td>tld.ttls.A</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on A records.</td> +</tr> +<tr class="row-odd"><td>tld.ttls.DNSKEY</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on DNSKEY records.</td> +</tr> +<tr class="row-even"><td>tld.ttls.DS</td> +<td>CRConfig.json</td> +<td>The TTL the Traffic Router DNS Server will respond with on DS records.</td> +</tr> +<tr class="row-odd"><td>api.port</td> +<td>server.xml</td> +<td>The TCP port Traffic Router listens on for API (REST) access.</td> +</tr> +<tr class="row-even"><td>api.cache-control.max-age</td> +<td>CRConfig.json</td> +<td>The value of the <code class="docutils literal"><span class="pre">Cache-Control:</span> <span class="pre">max-age=</span></code> header in the API responses of Traffic Router.</td> +</tr> +<tr class="row-odd"><td>api.auth.url</td> +<td>CRConfig.json</td> +<td>The API authentication URL (<a class="reference external" href="https:/">https:/</a>/${tmHostname}/api/1.1/user/login); ${tmHostname} is a search and replace token used by Traffic Router to construct the correct URL)</td> +</tr> +<tr class="row-even"><td>consistent.dns.routing</td> +<td>CRConfig.json</td> +<td>Control whether DNS Delivery Services use consistent hashing on the edge FQDN to select caches for answers. May improve performance if set to true; defaults to false</td> +</tr> +<tr class="row-odd"><td>dnssec.enabled</td> +<td>CRConfig.json</td> +<td>Whether DNSSEC is enabled; this parameter is updated via the DNSSEC administration user interface.</td> +</tr> +<tr class="row-even"><td>dnssec.allow.expired.keys</td> +<td>CRConfig.json</td> +<td>Allow Traffic Router to use expired DNSSEC keys to sign zones; default is true. This helps prevent DNSSEC related outages due to failed Traffic Control components or connectivity issues.</td> +</tr> +<tr class="row-odd"><td>dynamic.cache.primer.enabled</td> +<td>CRConfig.json</td> +<td>Allow Traffic Router to attempt to prime the dynamic zone cache; defaults to true</td> +</tr> +<tr class="row-even"><td>dynamic.cache.primer.limit</td> +<td>CRConfig.json</td> +<td>Limit the number of permutations to prime when dynamic zone cache priming is enabled; defaults to 500</td> +</tr> +<tr class="row-odd"><td>keystore.maintenance.interval</td> +<td>CRConfig.json</td> +<td>The interval in seconds which Traffic Router will check the keystore API for new DNSSEC keys</td> +</tr> +<tr class="row-even"><td>keystore.api.url</td> +<td>CRConfig.json</td> +<td>The keystore API URL (<a class="reference external" href="https:/">https:/</a>/${tmHostname}/api/1.1/cdns/name/${cdnName}/dnsseckeys.json; ${tmHostname} and ${cdnName} are search and replace tokens used by Traffic Router to construct the correct URL)</td> +</tr> +<tr class="row-odd"><td>keystore.fetch.timeout</td> +<td>CRConfig.json</td> +<td>The timeout in milliseconds for requests to the keystore API</td> +</tr> +<tr class="row-even"><td>keystore.fetch.retries</td> +<td>CRConfig.json</td> +<td>The number of times Traffic Router will attempt to load keys before giving up; defaults to 5</td> +</tr> +<tr class="row-odd"><td>keystore.fetch.wait</td> +<td>CRConfig.json</td> +<td>The number of milliseconds Traffic Router will wait before a retry</td> +</tr> +<tr class="row-even"><td>signaturemanager.expiration.multiplier</td> +<td>CRConfig.json</td> +<td>Multiplier used in conjunction with a zone’s maximum TTL to calculate DNSSEC signature durations; defaults to 5</td> +</tr> +<tr class="row-odd"><td>zonemanager.threadpool.scale</td> +<td>CRConfig.json</td> +<td>Multiplier used to determine the number of cores to use for zone signing operations; defaults to 0.75</td> +</tr> +<tr class="row-even"><td>zonemanager.cache.maintenance.interval</td> +<td>CRConfig.json</td> +<td>The interval in seconds which Traffic Router will check for zones that need to be resigned or if dynamic zones need to be expired from cache</td> +</tr> +<tr class="row-odd"><td>zonemanager.dynamic.response.expiration</td> +<td>CRConfig.json</td> +<td>A string (e.g.: 300s) that defines how long a dynamic zone</td> +</tr> +<tr class="row-even"><td>DNSKEY.generation.multiplier</td> +<td>CRConfig.json</td> +<td>Used to deteremine when new keys need to be regenerated. Keys are regenerated if expiration is less than the generation multiplier * the TTL. If the parameter does not exist, the default is 10.</td> +</tr> +<tr class="row-odd"><td>DNSKEY.effective.multiplier</td> +<td>CRConfig.json</td> +<td>Used when creating an effective date for a new key set. New keys are generated with an effective date of old key expiration - (effective multiplier * TTL). Default is 2.</td> +</tr> +</tbody> +</table> +</div> +<div class="section" id="regex-remap-expression"> +<span id="rl-regex-remap"></span><span id="index-7"></span><h3>Regex Remap Expression<a class="headerlink" href="#regex-remap-expression" title="Permalink to this headline">¶</a></h3> +<p>The regex remap expression allows to to use a regex and resulting match group(s) in order to modify the request URIs that are sent to origin. For example:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>^/original/(.*) http://origin.example.com/remapped/$1 +</pre></div> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>If <strong>Query String Handling</strong> is set to <code class="docutils literal"><span class="pre">2</span> <span class="pre">Drop</span> <span class="pre">at</span> <span class="pre">edge</span></code>, then you will not be allowed to save a regex remap expression, as dropping query strings actually relies on a regex remap of its own. However, if there is a need to both drop query strings <strong>and</strong> remap request URIs, this can be accomplished by setting <strong>Query String Handling</strong> to <code class="docutils literal"><span class="pre">1</span> <span class="pre">Do</span> <span class="pre">not</span> <span class="pre">use</span> <span class="pre">in</span> <span class="pre">cache</span> <span class="pre">key,</span> <span class="pre">but</span> <span class="pre">pass</span> <span class="pre">up</span> <span class="pre">to</span> <span class="pre">origin</span></code>, and then using a custom regex remap expression to do the necessary remapping, while simultan eously dropping query strings. The following example will capture the original request URI up to, but not including, the query string and then forward to a remapped URI:</p> +<div class="last highlight-default"><div class="highlight"><pre><span></span>^/([^?]*).* http://origin.example.com/remapped/$1 +</pre></div> +</div> +</div> +</div> +<div class="section" id="delivery-service-regexp"> +<span id="rl-ds-regexp"></span><span id="index-8"></span><h3>Delivery Service Regexp<a class="headerlink" href="#delivery-service-regexp" title="Permalink to this headline">¶</a></h3> +<p>This table defines how requests are matched to the delivery service. There are 3 type of entries possible here:</p> +<table border="1" class="docutils"> +<colgroup> +<col width="14%" /> +<col width="64%" /> +<col width="13%" /> +<col width="10%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Name</th> +<th class="head">Description</th> +<th class="head">DS Type</th> +<th class="head">Status</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>HOST_REGEXP</td> +<td>This is the regular expresion to match the host part of the URL.</td> +<td>DNS and HTTP</td> +<td>Supported</td> +</tr> +<tr class="row-odd"><td>PATH_REGEXP</td> +<td>This is the regular expresion to match the path part of the URL.</td> +<td>HTTP</td> +<td>Beta</td> +</tr> +<tr class="row-even"><td>HEADER_REGEXP</td> +<td>This is the regular expresion to match on any header in the request.</td> +<td>HTTP</td> +<td>Beta</td> +</tr> +</tbody> +</table> +<p>The <strong>Order</strong> entry defines the order in which the regular expressions get evaluated. To support <code class="docutils literal"><span class="pre">CNAMES</span></code> from domains outside of the Traffic Control top level DNS domain, enter multiple <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> lines.</p> +<dl class="docutils"> +<dt>Example:</dt> +<dd>Example foo.</dd> +</dl> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">In most cases is is sufficient to have just one entry in this table that has a <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> Type, and Order <code class="docutils literal"><span class="pre">0</span></code>. For the <em>movies</em> delivery service in the Kabletown CDN, the entry is simply single <code class="docutils literal"><span class="pre">HOST_REGEXP</span></code> set to <code class="docutils literal"><span class="pre">.*\.movies\..*</span></code>. This will match every url that has a hostname that ends with <code class="docutils literal"><span class="pre">movies.cdn1.kabletown.net</span></code>, since <code class="docutils literal"><span class="pre">cdn1.kabletown.net</span></code> is the Kabletown CDN’s DNS domain.</p> +</div> +</div> +<div class="section" id="static-dns-entries"> +<span id="rl-static-dns"></span><span id="index-9"></span><h3>Static DNS Entries<a class="headerlink" href="#static-dns-entries" title="Permalink to this headline">¶</a></h3> +<p>Static DNS entries allow you to create other names <em>under</em> the delivery service domain. You can enter any valid hostname, and create a CNAME, A or AAAA record for it by clicking the <strong>Static DNS</strong> button at the bottom of the delivery service details screen.</p> +</div> +<div class="section" id="server-assignments"> +<span id="rl-assign-edges"></span><span id="index-10"></span><h3>Server Assignments<a class="headerlink" href="#server-assignments" title="Permalink to this headline">¶</a></h3> +<p>Click the <strong>Server Assignments</strong> 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.</p> +</div> +<div class="section" id="the-coverage-zone-file-and-asn-table"> +<span id="rl-asn-czf"></span><h3>The Coverage Zone File and ASN Table<a class="headerlink" href="#the-coverage-zone-file-and-asn-table" title="Permalink to this headline">¶</a></h3> +<p>The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> + <span class="s2">"coverageZones"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"cache-group-01"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"1234:5678::\/64"</span><span class="p">,</span> + <span class="s2">"1234:5679::\/64"</span> + <span class="p">],</span> + <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"192.168.8.0\/24"</span><span class="p">,</span> + <span class="s2">"192.168.9.0\/24"</span> + <span class="p">]</span> + <span class="p">}</span> + <span class="s2">"cache-group-02"</span><span class="p">:</span> <span class="p">{</span> + <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"1234:567a::\/64"</span><span class="p">,</span> + <span class="s2">"1234:567b::\/64"</span> + <span class="p">],</span> + <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span> + <span class="s2">"192.168.4.0\/24"</span><span class="p">,</span> + <span class="s2">"192.168.5.0\/24"</span> + <span class="p">]</span> + <span class="p">}</span> + <span class="p">}</span> +<span class="p">}</span> +</pre></div> +</div> +<p>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.</p> +<p>The script that generates the CZF file is not part of Traffic Control, since it is different for each situation.</p> +</div> +</div> +<div class="section" id="parameters-and-profiles"> +<span id="rl-working-with-profiles"></span><h2>Parameters and Profiles<a class="headerlink" href="#parameters-and-profiles" title="Permalink to this headline">¶</a></h2> +<p>Parameters are shared between profiles if the set of <code class="docutils literal"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> 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 (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> 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 <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p> +<div class="admonition seealso"> +<p class="first admonition-title">See also</p> +<p class="last"><a class="reference internal" href="configuration.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p> +</div> +</div> +<div class="section" id="tools"> +<h2>Tools<a class="headerlink" href="#tools" title="Permalink to this headline">¶</a></h2> +<div class="section" id="generate-iso"> +<span id="rl-generate-iso"></span><span id="index-11"></span><h3>Generate ISO<a class="headerlink" href="#generate-iso" title="Permalink to this headline">¶</a></h3> +<p>Generate ISO is a tool for building custom ISOs for building caches on remote hosts. Currently it only supports Centos 6, but if you’re brave and pure of heart you MIGHT be able to get it to work with other unix-like OS’s.</p> +<p>The interface is <em>mostly</em> self explainatory as it’s got hints.</p> +<table border="1" class="docutils"> +<colgroup> +<col width="19%" /> +<col width="81%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Field</th> +<th class="head">Explaination</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Choose a server from list:</td> +<td>This option gets all the server names currently in the Traffic Ops database and will autofill known values.</td> +</tr> +<tr class="row-odd"><td>OS Version:</td> +<td>There needs to be an _osversions.cfg_ file in the ISO directory that maps the name of a directory to a name that shows up here.</td> +</tr> +<tr class="row-even"><td>Hostname:</td> +<td>This is the FQDN of the server to be installed. It is required.</td> +</tr> +<tr class="row-odd"><td>Root password:</td> +<td>If you don’t put anything here it will default to the salted MD5 of “Fred”. Whatever put is MD5 hashed and writte to disk.</td> +</tr> +<tr class="row-even"><td>DHCP:</td> +<td>if yes, other IP settings will be ignored</td> +</tr> +<tr class="row-odd"><td>IP Address:</td> +<td>Required if DHCP=no</td> +</tr> +<tr class="row-even"><td>Netmask:</td> +<td>Required if DHCP=no</td> +</tr> +<tr class="row-odd"><td>Gateway:</td> +<td>Required if DHCP=no</td> +</tr> +<tr class="row-even"><td>IPV6 Address:</td> +<td>Optional. /64 is assumed if prefix is omitted</td> +</tr> +<tr class="row-odd"><td>IPV6 Gateway:</td> +<td>Ignored if an IPV4 gateway is specified</td> +</tr> +<tr class="row-even"><td>Network Device:</td> +<td>Optional. Typical values are bond0, eth4, etc. Note: if you enter bond0, a LACP bonding config will be written</td> +</tr> +<tr class="row-odd"><td>MTU:</td> +<td>If unsure, set to 1500</td> +</tr> +<tr class="row-even"><td>Specify disk for OS install:</td> +<td>Optional. Typical values are “sda”.</td> +</tr> +</tbody> +</table> +<p>When you click the <strong>Download ISO</strong> button the folling occurs (all paths relative to the top level of the directory specified in _osversions.cfg_):</p> +<ol class="arabic simple"> +<li>Reads /etc/resolv.conf to get a list of nameservers. This is a rather ugly hack that is in place until we get a way of configuring it in the interface.</li> +<li>Writes a file in the ks_scripts/state.out that contains directory from _osversions.cfg_ and the mkisofs string that we’ll call later.</li> +<li>Writes a file in the ks_scripts/network.cfg that is a bunch of key=value pairs that set up networking.</li> +<li>Creates an MD5 hash of the password you specify and writes it to ks_scripts/password.cfg. Note that if you do not specify a password “Fred” is used. Also note that we have experienced some issues with webbrowsers autofilling that field.</li> +<li>Writes out a disk configuration file to ks_scripts/disk.cfg.</li> +<li>mkisofs is called against the directory configured in _osversions.cfg_ and an ISO is generated in memory and delivered to your webbrowser.</li> +</ol> +<p>You now have a customized ISO that can be used to install Red Hat and derivative Linux installations with some modifications to your ks.cfg file.</p> +<p>Kickstart/Anaconda will mount the ISO at /mnt/stage2 during the install process (at least with 6).</p> +<p>You can directly include the password file anywhere in your ks.cfg file (usually in the top) by doing %include /mnt/stage2/ks_scripts/password.cfg</p> +<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p> +<p>We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.</p> +<p>For example this is a section of our ks.cfg file:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span> + +<span class="o">%</span><span class="n">pre</span> + <span class="n">python</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">create_network_line</span><span class="o">.</span><span class="n">py</span> + <span class="n">bash</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">drive_config</span><span class="o">.</span><span class="n">sh</span> +<span class="o">%</span><span class="n">end</span> +</pre></div> +</div> +<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span> +<span class="o">...</span> +<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network_line</span> + +<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">drive_config</span> +<span class="o">...</span> +</pre></div> +</div> +<p>This snarfs up the contents and inlines them.</p> +<p>If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.</p> +<p>If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span> +<span class="n">source</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span> +<span class="n">echo</span> <span class="s2">"network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME"</span> <span class="o">>></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span> +<span class="c1"># Note that this is an example and may not work at all.</span> +</pre></div> +</div> +<p>You could also put this in the %pre section. Lots of ways to solve it.</p> +<p>We have included the two scripts we use in the “misc” directory of the git repo:</p> +<ul class="simple"> +<li>kickstart_create_network_line.py</li> +<li>kickstart_drive_config.sh</li> +</ul> +<p>These scripts were written to support a very narrow set of expectations and environment and are almost certainly not suitable to just drop in, but they might provide a good starting point.</p> +</div> +<div class="section" id="queue-updates-and-snapshot-crconfig"> +<span id="rl-queue-updates"></span><h3>Queue Updates and Snapshot CRConfig<a class="headerlink" href="#queue-updates-and-snapshot-crconfig" title="Permalink to this headline">¶</a></h3> +<p>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 <em>Queue Updates</em> menu, and updating Traffic Monitor and Traffic Router config is done through the <em>Snapshot CRConfig</em> menu.</p> +<div class="section" id="queue-updates"> +<span id="index-12"></span><h4>Queue Updates<a class="headerlink" href="#queue-updates" title="Permalink to this headline">¶</a></h4> +<p>Every 15 minutes the caches should run a <em>syncds</em> to get all changes needed from Traffic Ops. The files that will be updated by the syncds job are:</p> +<ul class="simple"> +<li>records.config</li> +<li>remap.config</li> +<li>parent.config</li> +<li>cache.config</li> +<li>hosting.config</li> +<li>url_sig_(.*).config</li> +<li>hdr_rw_(.*).config</li> +<li>regex_revalidate.config</li> +<li>ip_allow.config</li> +</ul> +<p>A cache will only get updated when the update flag is set for it. To set the update flag, use the <em>Queue Updates</em> menu - here you can schedule updates for
<TRUNCATED>
