You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ne...@apache.org on 2017/01/14 22:06:00 UTC
[70/75] incubator-trafficcontrol-website git commit: add master docs
to latest'
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/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
index 6c1a40e..19b8299 100644
--- a/docs/latest/admin/traffic_ops_using.html
+++ b/docs/latest/admin/traffic_ops_using.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Using Traffic Ops — Traffic Control 1.7 documentation </title>
+ <title>Using Traffic Ops — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../index.html"/>
<link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
<link rel="next" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.html"/>
<link rel="prev" title="Configuring Traffic Ops" href="traffic_ops_config.html"/>
@@ -58,7 +58,7 @@
- <img src="../_static/tc_logo.png" class="logo" />
+ <img src="../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -104,7 +104,7 @@
<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="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Using Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_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>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../index.html">Traffic Control master</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
@@ -208,16 +208,16 @@
<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>
+See <a class="reference internal" href="#rl-health-table"><em>The Health Table</em></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>
+See <a class="reference internal" href="#rl-health-graph"><em>Graph View</em></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>
+<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><em>Server Checks</em></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
@@ -259,7 +259,7 @@ per CDN.</td>
</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>
+<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><em>Bulk Upload Server</em></a></td>
</tr>
</tbody>
</table>
@@ -278,7 +278,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Global Profile</td>
-<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.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>
+<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></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 assgined to a cachegroup</em> - this may be slow to pull up, as there can be thousands of parameters.</td>
@@ -309,19 +309,19 @@ per CDN.</td>
</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>
+<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"><em>Generate ISO</em></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>
+<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></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>
+<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></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>
+<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><em>Invalidate Content</em></a></td>
</tr>
<tr class="row-odd"><td>Manage DNSSEC keys</td>
<td>Manage DNSSEC Keys for a chosen CDN.</td>
@@ -349,10 +349,10 @@ per CDN.</td>
<td>Create/Read/Update/Delete users</td>
</tr>
<tr class="row-even"><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>
+<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><em>Parameters and Profiles</em></a></td>
</tr>
<tr class="row-odd"><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>
+<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><em>The Coverage Zone File and ASN Table</em></a></td>
</tr>
<tr class="row-even"><td>Hardware</td>
<td>Get detailed hardware information (note: this should be moved to a Traffic Ops Extension)</td>
@@ -554,7 +554,7 @@ must have an ssh key on the edge servers.</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>
+<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><em>Delivery Service Types</em></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>
@@ -569,7 +569,7 @@ must have an ssh key on the edge servers.</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>
+<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><em>Token Based Authentication</em></a>.</td>
</tr>
<tr class="row-odd"><td>Query String Handling</td>
<td><p class="first">How to treat query strings:</p>
@@ -590,7 +590,7 @@ must have an ssh key on the edge servers.</td>
</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 <span class="xref std std-ref">geolimit-failure-redirect-feature</span></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"><em>GeoLimit Failure Redirect feature</em></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>
@@ -621,7 +621,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<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>
+<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td>Multi Site Origin Algorithm</td>
<td><ul class="first last simple">
@@ -633,7 +633,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
</td>
</tr>
<tr class="row-odd"><td>CCR profile</td>
-<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a>.</td>
+<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a>.</td>
</tr>
<tr class="row-even"><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
@@ -644,16 +644,16 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
(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>Geo Miss Default Latitude</td>
-<td>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.</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-odd"><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-even"><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>
+<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
</tr>
<tr class="row-odd"><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>
+<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
</tr>
<tr class="row-even"><td>Regex Remap Expression</td>
<td>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></td>
@@ -689,16 +689,16 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>(Read Only) The last time this delivery service was updated.</td>
</tr>
<tr class="row-odd"><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>
+<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"><em>Server Assignments</em></a>.</td>
</tr>
<tr class="row-even"><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>
+<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"><em>Static DNS Entries</em></a>.</td>
</tr>
<tr class="row-odd"><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-even"><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>
+<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"><em>Delivery Service Regexp</em></a>.</td>
</tr>
</tbody>
</table>
@@ -742,11 +742,11 @@ on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type
<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, ut where for “standard” DNS content routing the objects are stored on disk, for this delivery service type the objects are stored
+<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_NATIONAL, but the MID tier is bypassed.</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>
@@ -830,7 +830,7 @@ Examples:</p>
<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>
+<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
@@ -1003,10 +1003,10 @@ http.parent_proxy.connect_attempts_timeout</td>
<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 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, or use the ATS rpm supplied on the traffic-control-cdn.net website.</p>
+<p class="last">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, or use the ATS rpm supplied on the trafficcontrol.apache.org website.</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.</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 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 “”</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 “”</p>
<p>Parameters in the Origin profile that influence this feature:</p>
<table border="1" class="docutils">
<colgroup>
@@ -1070,7 +1070,7 @@ http.parent_proxy.connect_attempts_timeout</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>
+<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><em>Configure Multi Site Origin</em></a> for a <em>quick how to</em> on this feature.</p>
</div>
<div class="section" id="ccr-profile-or-traffic-router-profile">
<span id="rl-ccr-profile"></span><h3>CCR Profile or Traffic Router Profile<a class="headerlink" href="#ccr-profile-or-traffic-router-profile" title="Permalink to this headline">�</a></h3>
@@ -1310,30 +1310,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<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>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "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"
+ ]
+ }
+ }
+}
</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>
@@ -1345,7 +1345,7 @@ http.parent_proxy.connect_attempts_timeout</td>
<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="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
+<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a> in the <em>Configuring Traffic Ops</em> section.</p>
</div>
</div>
<div class="section" id="tools">
@@ -1421,30 +1421,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<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>
+<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/packages.txt
-<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
+ python /mnt/stage2/ks_scripts/create_network_line.py
+ bash /mnt/stage2/ks_scripts/drive_config.sh
+%end
</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>
+<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/password.cfg
+...
+%include /tmp/network_line
-<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>
+%include /tmp/drive_config
+...
</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>
+<div class="highlight-python"><div class="highlight"><pre>#!/bin/bash
+source /mnt/stage2/ks_scripts/network.cfg
+echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
+# Note that this is an example and may not work at all.
</pre></div>
</div>
<p>You could also put this in the %pre section. Lots of ways to solve it.</p>
@@ -1486,7 +1486,7 @@ http.parent_proxy.connect_attempts_timeout</td>
</div>
<div class="section" id="snapshot-crconfig">
<span id="rl-snapshot-crconfig"></span><span id="index-12"></span><h4>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">�</a></h4>
-<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for more information on the CRConfig file.</p>
+<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for more information on the CRConfig file.</p>
<p>To create a new snapshot, use the <em>Tools > Snapshot CRConfig</em> menu:</p>
<blockquote>
<div><ol class="arabic">
@@ -1558,7 +1558,7 @@ between the active CRConfig and the CRConfig about to be written.</p>
<p><strong>Activate/Deactivate DNSSEC for a CDN</strong></p>
<p>Fairly straight forward, this button set the <strong>dnssec.enabled</strong> param to either <strong>true</strong> or <strong>false</strong> on the Traffic Router profile for the CDN. The Activate/Deactivate option is only available if DNSSEC keys exist for CDN. In order to active DNSSEC for a CDN a user must first generate keys and then click the <strong>Active DNSSEC</strong> button.</p>
<p><strong>Generate Keys</strong></p>
-<p>Generate Keys will generate dnssec keys for the CDN TLD as well as for each Delivery Service in the CDN. It is important to note that this button will create a new KSK for the TLD and, therefore, a new DS Record. Any time a new DS Record is created, it will need to be added to the parent zone of the TLD in order for DNSSEC to work properly. When a user clicks the <strong>Generate Keys</strong> button, they will be presented with a screen with the following fields:</p>
+<p>Generate Keys will generate DNSSEC keys for the CDN TLD as well as for each Delivery Service in the CDN. It is important to note that this button will create a new KSK for the TLD and, therefore, a new DS Record. Any time a new DS Record is created, it will need to be added to the parent zone of the TLD in order for DNSSEC to work properly. When a user clicks the <strong>Generate Keys</strong> button, they will be presented with a screen with the following fields:</p>
<blockquote>
<div><ul class="simple">
<li><strong>CDN:</strong> This is not editable and displays the CDN for which keys will be generated</li>
@@ -1624,7 +1624,7 @@ between the active CRConfig and the CRConfig about to be written.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/admin/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_portal.html b/docs/latest/admin/traffic_portal.html
index b33145b..03e22be 100644
--- a/docs/latest/admin/traffic_portal.html
+++ b/docs/latest/admin/traffic_portal.html
@@ -1,266 +1,293 @@
+
+
<!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]-->
+<!--[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 Portal Administration — Traffic Control 1.7 documentation </title>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Traffic Portal Administration — Traffic Control master 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 1.7 documentation" href="../index.html"/>
- <link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
- <link rel="next" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
- <link rel="prev" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.html"/>
- <script src="_static/js/modernizr.min.js"></script>
+
+
+
+
+
+
+
+
+
+
+
+
+ <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 master documentation" href="../index.html"/>
+ <link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
+ <link rel="next" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
+ <link rel="prev" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.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.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="traffic_ops_install.html">Installing
- Traffic Ops</a></li>
- <li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring
- Traffic Ops</a></li>
- <li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic
- Ops</a></li>
- <li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing
- Traffic Ops Extensions</a></li>
- <li class="toctree-l2 current"><a class="current reference internal" href="#">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_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/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_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 1.7</a> »</li>
- <li><a href="index.html">Administrator’s Guide</a> »</li>
- <li>Traffic Portal Administration</li>
- <li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_portal.txt" rel="nofollow"> View page source</a>
- </li>
- </ul>
- <hr/>
- </div>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_monitor.html" class="btn btn-neutral float-right"
- title="Traffic Monitor Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_ops_extensions.html" class="btn btn-neutral"
- title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span>
- Previous</a>
- </div>
- <div role="main" class="document">
- <div class="section" id="traffic-portal-administration">
- <h1>Traffic Portal Administration<a class="headerlink" href="#traffic-portal-administration"
- title="Permalink to this headline">�</a></h1>
- <p>The following are requirements to ensure an accurate set up:</p>
- <ul class="simple">
- <li>CentOS 6.7 or 7</li>
- <li>Node.js 6.0.x or above</li>
- </ul>
- <p><strong>Installing Traffic Portal</strong></p>
- <blockquote>
- <div>
- <ul class="simple">
- <li>Download the Traffic Portal RPM from the traffic control <a
- class="reference external"
- href="/downloads/index.html">downloads</a>
- page or build from <a class="reference external"
- href="https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_portal/build">source</a>.
- </li>
- <li>Copy the Traffic Portal RPM to your server</li>
- <li>curl –silent –location <a class="reference external"
- href="https://rpm.nodesource.com/setup_6.x">https://rpm.nodesource.com/setup_6.x</a>
- | sudo bash -
- </li>
- <li>sudo yum install -y nodejs</li>
- <li>sudo yum install -y <traffic_portal rpm></li>
- </ul>
- </div>
- </blockquote>
- <p><strong>Configuring Traffic Portal</strong></p>
- <blockquote>
- <div>
- <ul class="simple">
- <li>cd /etc/traffic_portal/conf</li>
- <li>sudo cp config-template.js config.js</li>
- <li>sudo vi config.js (read the inline comments)</li>
- <li>[OPTIONAL] sudo vi /opt/traffic_portal/public/traffic_portal_properties.json (to
- customize traffic portal content)
- </li>
- <li>[OPTIONAL] sudo vi /opt/traffic_portal/public/resources/assets/css/custom.css
- (to customize traffic portal skin)
- </li>
- </ul>
- </div>
- </blockquote>
- <p><strong>Starting Traffic Portal</strong></p>
- <blockquote>
- <div>
- <ul class="simple">
- <li>sudo service traffic_portal start</li>
- </ul>
- </div>
- </blockquote>
- <p><strong>Stopping Traffic Portal</strong></p>
- <blockquote>
- <div>
- <ul class="simple">
- <li>sudo service traffic_portal stop</li>
- </ul>
- </div>
- </blockquote>
- </div>
- </div>
- <footer>
- <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
- <a href="traffic_monitor.html" class="btn btn-neutral float-right"
- title="Traffic Monitor Administration">Next <span
- class="fa fa-arrow-circle-right"></span></a>
- <a href="traffic_ops_extensions.html" class="btn btn-neutral"
- title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span>
- Previous</a>
- </div>
- <hr/>
- <div role="contentinfo">
- <p>
- </p>
- </div>
- Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a
- href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a
- href="https://readthedocs.org">Read the Docs</a>.
- </footer>
- </div>
- </div>
- </section>
+
+ <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="traffic_ops_install.html">Installing Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">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_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/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_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 master</a> »</li>
+
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
+
+ <li>Traffic Portal Administration</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/admin/traffic_portal.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="traffic-portal-administration">
+<h1>Traffic Portal Administration<a class="headerlink" href="#traffic-portal-administration" title="Permalink to this headline">�</a></h1>
+<p>The following are requirements to ensure an accurate set up:</p>
+<ul class="simple">
+<li>CentOS 6.7 or 7</li>
+<li>Node.js 6.0.x or above</li>
+</ul>
+<p><strong>Installing Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>Download the Traffic Portal RPM from the traffic control <a class="reference external" href="https://trafficcontrol.apache.org/downloads/index.html">downloads</a> page or build from <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/traffic_portal/build">source</a>.</li>
+<li>Copy the Traffic Portal RPM to your server</li>
+<li>curl –silent –location <a class="reference external" href="https://rpm.nodesource.com/setup_6.x">https://rpm.nodesource.com/setup_6.x</a> | sudo bash -</li>
+<li>sudo yum install -y nodejs</li>
+<li>sudo yum install -y <traffic_portal rpm></li>
+</ul>
+</div></blockquote>
+<p><strong>Configuring Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>cd /etc/traffic_portal/conf</li>
+<li>sudo cp config-template.js config.js</li>
+<li>sudo vi config.js (read the inline comments)</li>
+<li>[OPTIONAL] sudo vi /opt/traffic_portal/public/traffic_portal_properties.json (to customize traffic portal content)</li>
+<li>[OPTIONAL] sudo vi /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)</li>
+</ul>
+</div></blockquote>
+<p><strong>Starting Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>sudo service traffic_portal start</li>
+</ul>
+</div></blockquote>
+<p><strong>Stopping Traffic Portal</strong></p>
+<blockquote>
+<div><ul class="simple">
+<li>sudo service traffic_portal stop</li>
+</ul>
+</div></blockquote>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
</div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+
+
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
- URL_ROOT: '../',
- VERSION: '1.7',
- COLLAPSE_INDEX: false,
- FILE_SUFFIX: '.html',
- HAS_SOURCE: true
+ URL_ROOT:'../',
+ VERSION:'master',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true
};
</script>
- <script type="text/javascript" src="../_static/jquery.js"></script>
- <script type="text/javascript" src="../_static/underscore.js"></script>
- <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+
+
+
+
+
<script type="text/javascript" src="../_static/js/theme.js"></script>
- <script type="text/javascript">
- jQuery(function () {
- SphinxRtdTheme.StickyNav.enable();
- });
- </script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
</body>
</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/52a20853/docs/latest/admin/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_router.html b/docs/latest/admin/traffic_router.html
index dad7e42..779b941 100644
--- a/docs/latest/admin/traffic_router.html
+++ b/docs/latest/admin/traffic_router.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router Administration — Traffic Control 1.7 documentation </title>
+ <title>Traffic Router Administration — Traffic Control master documentation </title>
@@ -33,7 +33,7 @@
- <link rel="top" title="Traffic Control 1.7 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control master documentation" href="../index.html"/>
<link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
<link rel="next" title="Traffic Stats Administration" href="traffic_stats.html"/>
<link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
@@ -58,7 +58,7 @@
- <img src="../_static/tc_logo.png" class="logo" />
+ <img src="../_static/tc_logo_c_only.png" class="logo" />
</a>
@@ -108,7 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_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 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">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>
@@ -159,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.7</a> »</li>
+ <li><a href="../index.html">Traffic Control master</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
@@ -198,6 +198,7 @@
<li><a class="reference internal" href="#geolimit-failure-redirect-feature" id="id10">GeoLimit Failure Redirect feature</a></li>
<li><a class="reference internal" href="#steering-feature" id="id11">Steering feature</a></li>
<li><a class="reference internal" href="#https-for-http-type-delivery-services" id="id12">HTTPS for Http Type Delivery Services</a></li>
+<li><a class="reference internal" href="#tuning-recommendations" id="id13">Tuning Recommendations</a></li>
</ul>
</li>
</ul>
@@ -222,12 +223,12 @@
</li>
<li><p class="first">Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to <code class="docutils literal"><span class="pre">ONLINE</span></code>.</p>
</li>
-<li><p class="first">Ensure the FQDN of the Traffic Monitor is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.</p>
+<li><p class="first">Ensure the FQDN of the Traffic Router is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.</p>
</li>
<li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
</li>
<li><dl class="first docutils">
-<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
+<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><em>Configuration files</em></a></dt>
<dd><p class="first"># traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p>
<p class="last"># Frequency for reloading this file
@@ -237,7 +238,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</p>
</li>
-<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a></p>
+<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a></p>
</li>
</ol>
<div class="admonition note">
@@ -258,7 +259,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
<p class="first admonition-title">Note</p>
<p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
</div>
-<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
+<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
<div class="section" id="configuration-files">
<span id="rl-tr-config-files"></span><h3>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">�</a></h3>
<table border="1" class="docutils">
@@ -384,7 +385,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
<div class="section" id="operation">
<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">�</a></h3>
-<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> documentation for more information.</p>
+<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> documentation for more information.</p>
<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
</div>
@@ -409,8 +410,8 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="sample-message">
<h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">�</a></h3>
<p>Items within brackets below are detailed under the HTTP and DNS sections</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields
</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
-<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <sp
an class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span>
+<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
+144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
</pre></div>
</div>
<div class="admonition note">
@@ -549,7 +550,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="http-specifics">
<h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-&
quot;</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
+<div class="highlight-python"><div class="highlight"><pre>1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -609,7 +610,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="dns-specifics">
<h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">�</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERRO
R</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
+<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -844,6 +845,25 @@ During the test it will provide feedback about request latency and transactions
<p>While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.</p>
</div>
</div>
+<div class="section" id="tuning-recommendations">
+<h2><a class="toc-backref" href="#contents">Tuning Recommendations</a><a class="headerlink" href="#tuning-recommendations" title="Permalink to this headline">�</a></h2>
+<p>The following is an example of /opt/tomcat/bin/setenv.sh that has been tested on a multi core server running under HTTPS load test requests.
+This is following the general recommendation to use the G1 garbage collector for JVM applications running on multi core machines.
+In addition to using the G1 garbage collector the InitiatingHeapOccupancyPercent was lowered to run garbage collection more frequently which
+improved overall throughput for Traffic Router and reduced ‘Stop the World’ garbage collection. Note that setting the min and max heap settings
+in setenv.sh will override init scripts in /etc/init.d/tomcat.</p>
+<blockquote>
+<div><p>/opt/tomcat/bin/setenv.sh:</p>
+<div class="highlight-python"><div class="highlight"><pre>#! /bin/sh
+export CATALINA_OPTS="$CATALINA_OPTS -server"
+export CATALINA_OPTS="$CATALINA_OPTS -Xms2g -Xmx2g"
+export CATALINA_OPTS="$CATALINA_OPTS -XX:+UseG1GC"
+export CATALINA_OPTS="$CATALINA_OPTS -XX:+UnlockExperimentalVMOptions"
+export CATALINA_OPTS="$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30"
+</pre></div>
+</div>
+</div></blockquote>
+</div>
</div>
@@ -884,7 +904,7 @@ During the test it will provide feedback about request latency and transactions
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.7',
+ VERSION:'master',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true