You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by gi...@apache.org on 2017/04/05 15:01:11 UTC
[24/51] [partial] incubator-trafficcontrol-website git commit: Update
docs from commit 5735b8d2e79b50f9bdd0302578dac0d76bab252e
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0672d6e1/docs/2.0.x/html/admin/quick_howto/regionalgeo.html
----------------------------------------------------------------------
diff --git a/docs/2.0.x/html/admin/quick_howto/regionalgeo.html b/docs/2.0.x/html/admin/quick_howto/regionalgeo.html
new file mode 100644
index 0000000..82150ca
--- /dev/null
+++ b/docs/2.0.x/html/admin/quick_howto/regionalgeo.html
@@ -0,0 +1,338 @@
+
+
+<!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>Configure Regional Geo-blocking (RGB) — Traffic Control 1.8-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="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Quick How To Guides" href="index.html"/>
+ <link rel="next" title="Configure Delivery Service Steering" href="steering.html"/>
+ <link rel="prev" title="Configure Federations" href="federations.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="../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"><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_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 current"><a class="reference internal" href="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.8-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li><a href="index.html">Quick How To Guides</a> »</li>
+
+ <li>Configure Regional Geo-blocking (RGB)</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/quick_howto/regionalgeo.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federations.html" class="btn btn-neutral" title="Configure Federations"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="configure-regional-geo-blocking-rgb">
+<span id="rl-regionalgeo-qht"></span><h1>Configure Regional Geo-blocking (RGB)<a class="headerlink" href="#configure-regional-geo-blocking-rgb" title="Permalink to this headline">�</a></h1>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">RGB is only supported for HTTP delivery services.</p>
+</div>
+<ol class="arabic simple">
+<li>Prepare RGB configuration file</li>
+</ol>
+<p>RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+<span class="s2">"deliveryServices"</span><span class="p">:</span>
+ <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live4</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"includePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">,</span> <span class="s2">"L9W"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"http://third-party.com/blacked_out.html"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
+ <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live5</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
+ <span class="s2">"ipWhiteList"</span><span class="p">:</span> <span class="p">[</span><span class="mf">185.68</span><span class="o">.</span><span class="mf">71.9</span><span class="o">/</span><span class="mi">22</span><span class="s2">","</span><span class="mf">142.232</span><span class="o">.</span><span class="mf">0.79</span><span class="o">/</span><span class="mi">24</span><span class="s2">"],</span>
+ <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"excludePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">]},</span>
+ <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"/live5_low_bitrate.m3u8"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li>The value of “deliveryServiceId” shall be equal to the \u201cXML ID\u201d field of the intended delivery service defined on Traffic Ops.</li>
+<li>\u201curlRegex\u201d is to match request URLs. The URLs matching the regex are applicable to the rule.</li>
+<li>\u201cgeoLocation\u201d currently supports \u201cincludePostalCode\u201d and \u201cexcludePostalCode\u201d attribute. When \u201cincludePostalCode\u201d attribute is used, only the clients whose FSAs are in the \u201cincludePostalCode\u201d list are able to view the content represented by \u201curlRegex\u201d. When \u201cexcludePostalCode\u201d is used, any client whose FSA are not in the \u201cexcludePostalCode\u201d list are allowed to view the content. \u201cincludePostalCode\u201d and \u201cexcludePostalCode\u201d are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)</li>
+<li>\u201credirectUrl\u201d is the URL that will be responded to the blocked clients. Without a domain name in the URL, the URL will still be served in the same delivery service. Thus Traffic Router will redirect the client to a chosen cache server assigned to the delivery service. If the URL includes a domain name, Traffic Router simply redirects the client to the defined URL. In the later case, the redirect URL must not match the \u201curlRegex\u201d part to avoid HTTP 302 loop on Traffic Router.</li>
+<li>\u201cipWhiteList\u201d is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed and no postal code matching logic is needed. If there is no match in the white list, postal code matching logic will be processed further.</li>
+</ul>
+<ol class="arabic simple" start="2">
+<li>Add RGB parameters on Traffic Ops</li>
+</ol>
+<p>The two new parameters in following table are required to be added into CRConfig.json:</p>
+<ul class="simple">
+<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
+<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
+</ul>
+<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" style="width: 1234.0px; height: 430.0px;" /></a>
+<ol class="arabic simple" start="3">
+<li>Enable RGB for a delivery service</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" style="width: 1046.0px; height: 1054.0px;" /></a>
+<ol class="arabic simple" start="4">
+<li>Make configuration effective</li>
+</ol>
+<p>Go to Tools->Snapshot CRConfig, perform \u201cDiff CRConfig\u201d and click “Write CRConfig”.</p>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.8px; height: 128.8px;" /></a>
+<ol class="arabic simple" start="5">
+<li>Traffic Router access log with RGB</li>
+</ol>
+<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
+<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
+<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
+</pre></div>
+</div>
+<ul class="simple">
+<li>{FSA}: It is the client\u2019s FSA part of its postal code, which is retrieved from geo-location database. If FSA is empty, dash (\u201c-\u201c) is filled in.</li>
+<li>{allowed/disallowed}: This flag shows if a request is allowed or disallowed by RGB (1 for yes, and 0 for no).</li>
+<li>{include/exclude postal}: It shows that when a rule in JSON is matched for a request, it is an include or exclude list of postal codes (i.e. FSAs). \u201cI\u201d for include, and \u201cX\u201d for exclude. If no rule matches, dash (\u201c-\u201c) is filled in.</li>
+<li>{fallback config/current config}: when TR fails to parse an RGB JSON, TR will handle requests with latest valid JSON configuration, but will set {fallback config} flag to 1. If the new JSON is valid, then the flag is set to 0.</li>
+<li>{allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.</li>
+</ul>
+<p>Example:</p>
+<div class="highlight-default"><div class="highlight"><pre><span class="mf">1446442214.685</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">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.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">"-"</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">rgb</span><span class="o">=<
/span><span class="s2">"N6G:1:X:0:0"</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">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+
+<span class="mf">1446442219.181</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">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.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">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</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">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span cl
ass="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+
+<span class="mf">1446445521.677</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">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live51.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">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</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">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <sp
an class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+</pre></div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="steering.html" class="btn btn-neutral float-right" title="Configure Delivery Service Steering">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="federations.html" class="btn btn-neutral" title="Configure Federations"><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.8-dev',
+ 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/js/theme.js"></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/0672d6e1/docs/2.0.x/html/admin/quick_howto/steering.html
----------------------------------------------------------------------
diff --git a/docs/2.0.x/html/admin/quick_howto/steering.html b/docs/2.0.x/html/admin/quick_howto/steering.html
new file mode 100644
index 0000000..640f534
--- /dev/null
+++ b/docs/2.0.x/html/admin/quick_howto/steering.html
@@ -0,0 +1,330 @@
+
+
+<!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>Configure Delivery Service Steering — Traffic Control 1.8-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="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 1.8-dev documentation" href="../../index.html"/>
+ <link rel="up" title="Quick How To Guides" href="index.html"/>
+ <link rel="next" title="Developer\u2019s Guide" href="../../development/index.html"/>
+ <link rel="prev" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.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="../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"><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_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 current"><a class="reference internal" href="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.8-dev</a> »</li>
+
+ <li><a href="../index.html">Administrator’s Guide</a> »</li>
+
+ <li><a href="index.html">Quick How To Guides</a> »</li>
+
+ <li>Configure Delivery Service Steering</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/admin/quick_howto/steering.rst.txt" rel="nofollow"> View page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer\u2019s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="configure-delivery-service-steering">
+<span id="rl-steering-qht"></span><h1>Configure Delivery Service Steering<a class="headerlink" href="#configure-delivery-service-steering" title="Permalink to this headline">�</a></h1>
+<ol class="arabic simple">
+<li>Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" style="width: 1172.0px; height: 232.0px;" /></a>
+<ol class="arabic simple" start="2">
+<li>Create a delivery service with type STEERING in Traffic Ops.</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" style="width: 811.0px; height: 617.0px;" /></a>
+<ol class="arabic simple" start="3">
+<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" style="width: 757.0px; height: 598.0px;" /></a>
+<ol class="arabic simple" start="4">
+<li>Create a user with the role of Steering.</li>
+</ol>
+<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" style="width: 650.0px; height: 487.0px;" /></a>
+<ol class="arabic" start="5">
+<li><p class="first">As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via <code class="docutils literal"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
+<blockquote>
+<div><p>Sample cURL: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
+<p>Sample JSON body:</p>
+</div></blockquote>
+</li>
+</ol>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<ol class="arabic" start="6">
+<li><p class="first">If desired, the steering user can create filters for the target delivery services.</p>
+<blockquote>
+<div><p>Sample cURL: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-H</span> <span class="pre">"Cookie:</span> <span class="pre">mojolicious=xxxyyy"</span> <span class="pre">-XPUT</span> <span class="pre">"https://to.kabletown.net/internal/api/1.2/steering/steering-ds"</span> <span class="pre">-d</span> <span class="pre">@/tmp/steering.json</span></code></p>
+<p>Sample JSON body:</p>
+</div></blockquote>
+</li>
+</ol>
+<div class="highlight-default"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s2">"filters"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">gototarget1</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+ <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="p">{</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="p">},</span>
+ <span class="p">{</span>
+ <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
+ <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
+ <span class="p">}</span>
+ <span class="p">]</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<ol class="arabic simple" start="7">
+<li>Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight. Example: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-Lvs</span> <span class="pre">http://tr.steering-ds.cdn.kabletown.net/foo</span></code></li>
+</ol>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developer\u2019s Guide">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><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.8-dev',
+ 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/js/theme.js"></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/0672d6e1/docs/2.0.x/html/admin/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/2.0.x/html/admin/traffic_monitor.html b/docs/2.0.x/html/admin/traffic_monitor.html
new file mode 100644
index 0000000..67e271d
--- /dev/null
+++ b/docs/2.0.x/html/admin/traffic_monitor.html
@@ -0,0 +1,391 @@
+
+
+<!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 Monitor Administration — Traffic Control 1.8-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="index" title="Index"
+ href="../genindex.html"/>
+ <link rel="search" title="Search" href="../search.html"/>
+ <link rel="top" title="Traffic Control 1.8-dev documentation" href="../index.html"/>
+ <link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
+ <link rel="next" title="Traffic Router Administration" href="traffic_router.html"/>
+ <link rel="prev" title="Traffic Portal Administration" href="traffic_portal.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="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"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">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.8-dev</a> »</li>
+
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
+
+ <li>Traffic Monitor Administration</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/admin/traffic_monitor.rst.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_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_portal.html" class="btn btn-neutral" title="Traffic Portal Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="traffic-monitor-administration">
+<h1>Traffic Monitor Administration<a class="headerlink" href="#traffic-monitor-administration" title="Permalink to this headline">�</a></h1>
+<div class="section" id="installing-traffic-monitor">
+<h2>Installing Traffic Monitor<a class="headerlink" href="#installing-traffic-monitor" title="Permalink to this headline">�</a></h2>
+<p>The following are requirements to ensure an accurate set up:</p>
+<ul class="simple">
+<li>CentOS 6</li>
+<li>4 vCPUs</li>
+<li>8GB RAM</li>
+<li>Successful install of Traffic Ops</li>
+<li>Tomcat</li>
+<li>Administrative access to the Traffic Ops</li>
+<li>Physical address of the site</li>
+<li>perl-JSON</li>
+<li>perl-WWW-Curl</li>
+</ul>
+<ol class="arabic">
+<li><p class="first">Enter the Traffic Monitor server into Traffic Ops</p>
+</li>
+<li><p class="first">Make sure the FQDN of the Traffic Monitor is resolvable in DNS.</p>
+</li>
+<li><p class="first">Install Traffic Monitor and Perl mods: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">-y</span> <span class="pre">install</span> <span class="pre">traffic_monitor</span> <span class="pre">perl-JSON</span> <span class="pre">perl-WWW-Curl</span></code></p>
+</li>
+<li><p class="first">Take the config from Traffic Ops - run : <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">/opt/traffic_monitor/bin/traffic_monitor_config.pl</span></code></p>
+<blockquote>
+<div><p>Sample output:</p>
+<div class="highlight-default"><div class="highlight"><pre>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
+DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
+DEBUG: traffic_ops login: admin:kl0tevax
+DEBUG: Config write mode: prompt
+DEBUG: Found profile from traffic_ops: RASCAL_CDN
+DEBUG: Found CDN name from traffic_ops: kabletown_cdn
+DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
+WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
+WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
+WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
+WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
+WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
+WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
+WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
+WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
+WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
+WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
+WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
+WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
+WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
+WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
+WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
+WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
+WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
+WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
+WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
+DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
+DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
+DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
+DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
+DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
+DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
+DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
+DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
+DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
+DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
+DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
+DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
+DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
+DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
+DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
+DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
+DEBUG: Proposed traffic_monitor_config:
+{
+ "traffic_monitor_config":{
+ "default.accessControlAllowOrigin":"*",
+ "health.startupMinCycles":"2",
+ "tm.auth.password":"kl0tevax",
+ "tm.auth.url":"https://${tmHostname}/login",
+ "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
+ "allow.config.edit":"false",
+ "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
+ "tm.auth.username":"admin",
+ "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
+ "health.timepad":"10",
+ "hack.publishDsStates":"true",
+ "default.connection.timeout":"2000",
+ "health.ds.interval":"1000",
+ "peers.polling.interval":"5000",
+ "hack.forceSystemExit":"false",
+ "health.ds.leniency":"30000",
+ "cdnName":"kabletown_cdn",
+ "peers.threadPool":"1",
+ "tm.polling.interval":"10000",
+ "health.polling.interval":"5000",
+ "health.event-count":"200",
+ "hack.peerOptimistic":"true",
+ "tm.hostname":"traffic-ops.cdn.kabletown.net"
+ }
+}
+----------------------------------------------
+----OK to write this config to disk? (Y/n) [n]y
+----------------------------------------------
+----------------------------------------------
+----OK to write this config to disk? (Y/n) [n]Y
+----------------------------------------------
+DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
+traffic_mon #
+</pre></div>
+</div>
+</div></blockquote>
+</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></p>
+<div class="highlight-default"><div class="highlight"><pre><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
+<span class="n">Using</span> <span class="n">CATALINA_TMPDIR</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">temp</span>
+<span class="n">Using</span> <span class="n">JRE_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">usr</span>
+<span class="n">Using</span> <span class="n">CLASSPATH</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bootstrap</span><span class="o">.</span><span class="n">jar</span>
+<span class="n">Using</span> <span class="n">CATALINA_PID</span><span class="p">:</span><span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">tomcat</span><span class="o">.</span><span class="n">pid</span>
+<span class="n">Starting</span> <span class="n">tomcat</span> <span class="p">[</span> <span class="n">OK</span> <span class="p">]</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.</p>
+</li>
+</ol>
+</div>
+<div class="section" id="configuring-traffic-monitor">
+<h2>Configuring Traffic Monitor<a class="headerlink" href="#configuring-traffic-monitor" title="Permalink to this headline">�</a></h2>
+<div class="section" id="configuration-overview">
+<h3>Configuration Overview<a class="headerlink" href="#configuration-overview" title="Permalink to this headline">�</a></h3>
+<p>Traffic Monitor is configured using its JSON configuration file, <code class="docutils literal"><span class="pre">traffic_monitor_config.js</span></code>. Specify the URL, username, password, and CDN name for the instance of Traffic Ops for which this Traffic Monitor is a member, and start the software. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.</p>
+</div>
+</div>
+<div class="section" id="troubleshooting-and-log-files">
+<h2>Troubleshooting and log files<a class="headerlink" href="#troubleshooting-and-log-files" title="Permalink to this headline">�</a></h2>
+<p>Traffic Monitor log files are in <code class="docutils literal"><span class="pre">/opt/traffic_monitor/var/log/</span></code>, and tomcat log files are in <code class="docutils literal"><span class="pre">/opt/tomcat/logs/</span></code>.</p>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_router.html" class="btn btn-neutral float-right" title="Traffic Router Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_portal.html" class="btn btn-neutral" title="Traffic Portal Administration"><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.8-dev',
+ 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/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file