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:11:13 UTC
[25/76] [abbrv] [partial] incubator-trafficcontrol-website git
commit: add 1.8.0 docs
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/ee296175/docs/1.8.0/admin/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/admin/traffic_monitor.html b/docs/1.8.0/admin/traffic_monitor.html
new file mode 100644
index 0000000..1ff0ce8
--- /dev/null
+++ b/docs/1.8.0/admin/traffic_monitor.html
@@ -0,0 +1,388 @@
+
+
+<!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.0 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.8.0 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.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.0</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.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-python"><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-python"><div class="highlight"><pre>Using CATALINA_BASE: /opt/tomcat
+Using CATALINA_HOME: /opt/tomcat
+Using CATALINA_TMPDIR: /opt/tomcat/temp
+Using JRE_HOME: /usr
+Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
+Using CATALINA_PID:/var/run/tomcat/tomcat.pid
+Starting tomcat [ OK ]
+</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.0',
+ 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/ee296175/docs/1.8.0/admin/traffic_ops_config.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/admin/traffic_ops_config.html b/docs/1.8.0/admin/traffic_ops_config.html
new file mode 100644
index 0000000..2dc59a8
--- /dev/null
+++ b/docs/1.8.0/admin/traffic_ops_config.html
@@ -0,0 +1,475 @@
+
+
+<!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>Configuring Traffic Ops — Traffic Control 1.8.0 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.8.0 documentation" href="../index.html"/>
+ <link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
+ <link rel="next" title="Using Traffic Ops" href="traffic_ops_using.html"/>
+ <link rel="prev" title="Installing Traffic Ops" href="traffic_ops_install.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 current"><a class="current reference internal" href="">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"><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.0</a> »</li>
+
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
+
+ <li>Configuring Traffic Ops</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/admin/traffic_ops_config.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_ops_using.html" class="btn btn-neutral float-right" title="Using Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_install.html" class="btn btn-neutral" title="Installing Traffic Ops"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="configuring-traffic-ops">
+<h1>Configuring Traffic Ops<a class="headerlink" href="#configuring-traffic-ops" title="Permalink to this headline">�</a></h1>
+<p>Follow the steps below to configure the newly installed Traffic Ops Instance.</p>
+<div class="section" id="installing-the-ssl-cert">
+<h2>Installing the SSL Cert<a class="headerlink" href="#installing-the-ssl-cert" title="Permalink to this headline">�</a></h2>
+<p>By default, Traffic Ops runs as an SSL web server, and a certificate needs to be installed. TBD.</p>
+</div>
+<div class="section" id="content-delivery-networks">
+<h2>Content Delivery Networks<a class="headerlink" href="#content-delivery-networks" title="Permalink to this headline">�</a></h2>
+</div>
+<div class="section" id="profile-parameters">
+<span id="rl-param-prof"></span><h2>Profile Parameters<a class="headerlink" href="#profile-parameters" title="Permalink to this headline">�</a></h2>
+<p>Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a “Global profile” - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:</p>
+<table border="1" class="docutils" id="index-0">
+<colgroup>
+<col width="15%" />
+<col width="9%" />
+<col width="77%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Config file</th>
+<th class="head">Value</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>tm.url</td>
+<td>global</td>
+<td>The URL where this Traffic Ops instance is being served from.</td>
+</tr>
+<tr class="row-odd"><td>tm.toolname</td>
+<td>global</td>
+<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated.</td>
+</tr>
+<tr class="row-even"><td>tm.infourl</td>
+<td>global</td>
+<td>This is the “for more information go here” URL, which is visible in the About page.</td>
+</tr>
+<tr class="row-odd"><td>tm.logourl</td>
+<td>global</td>
+<td>This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public.</td>
+</tr>
+<tr class="row-even"><td>tm.instance_name</td>
+<td>global</td>
+<td>The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page.</td>
+</tr>
+<tr class="row-odd"><td>tm.traffic_mon_fwd_proxy</td>
+<td>global</td>
+<td>When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through.
+This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting
+this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to
+set this parameter on a production system.</td>
+</tr>
+<tr class="row-even"><td>geolocation.polling.url</td>
+<td>CRConfig.json</td>
+<td>The location to get the GeoLiteCity database from.</td>
+</tr>
+<tr class="row-odd"><td>geolocation6.polling.url</td>
+<td>CRConfig.json</td>
+<td>The location to get the IPv6 GeoLiteCity database from.</td>
+</tr>
+</tbody>
+</table>
+<p>These parameters should be set to reflect the local environment.</p>
+<p>After running the postinstall script, Traffic Ops has the following profiles pre-loaded:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="9%" />
+<col width="91%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>EDGE1</td>
+<td>The profile to be applied to the latest supported version of ATS, when running as an EDGE cache</td>
+</tr>
+<tr class="row-odd"><td>TR1</td>
+<td>The profile to be applied to the latest version of Traffic Router</td>
+</tr>
+<tr class="row-even"><td>TM1</td>
+<td>The profile to be applied to the latest version of Traffic Monitor</td>
+</tr>
+<tr class="row-odd"><td>MID1</td>
+<td>The profile to be applied to the latest supported version of ATS, when running as an MID cache</td>
+</tr>
+<tr class="row-even"><td>RIAK_ALL</td>
+<td>Riak profile for all CDNs to be applied to the Traffic Vault servers</td>
+</tr>
+</tbody>
+</table>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to “mix-and-match” different hardware configurations.</p>
+</div>
+<p>Below is a list of cache parameters that are likely to need changes from the default profiles shipped with Traffic Ops:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="11%" />
+<col width="73%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Config file</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>allow_ip</td>
+<td>astats.config</td>
+<td>This is a comma separated list of IPv4 CIDR blocks that will have access to the astats statistics on the caches.
+The Traffic Monitor IP addresses have to be included in this, if they are using IPv4 to monitor the caches.</td>
+</tr>
+<tr class="row-odd"><td>allow_ip6</td>
+<td>astats.config</td>
+<td>This is a comma separated list of IPv6 CIDR blocks that will have access to the astats statistics on the caches.
+The Traffic Monitor IP addresses have to be included in this, if they are using IPv6 to monitor the caches.</td>
+</tr>
+<tr class="row-even"><td>Drive_Prefix</td>
+<td>storage.config</td>
+<td>JvD/Jeff to supply blurb</td>
+</tr>
+<tr class="row-odd"><td>Drive_Letters</td>
+<td>storage.config</td>
+<td>JvD/Jeff to supply blurb</td>
+</tr>
+<tr class="row-even"><td>purge_allow_ip</td>
+<td>ip_allow.config</td>
+<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><em>Invalidate Content</em></a>)</td>
+</tr>
+<tr class="row-odd"><td>health.threshold.loadavg</td>
+<td>rascal.properties</td>
+<td>The Unix load average at which Traffic Router will stop sending traffic to this cache</td>
+</tr>
+<tr class="row-even"><td>health.threshold.\
+availableBandwidthInKbps</td>
+<td>rascal.properties</td>
+<td>The amount of bandwidth that Traffic Router will try to keep available on the cache.
+For example: “”>1500000” means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface.</td>
+</tr>
+</tbody>
+</table>
+<p>Below is a list of Traffic Server plugins that need to be configured in the parameter table:</p>
+</div>
+<div class="section" id="regions-locations-and-cache-groups">
+<h2>Regions, Locations and Cache Groups<a class="headerlink" href="#regions-locations-and-cache-groups" title="Permalink to this headline">�</a></h2>
+<p>All servers have to have a <cite>location</cite>, which is their physical location. Each location is part of a <cite>region</cite>, and each region is part of a <cite>division</cite>. For Example, <code class="docutils literal"><span class="pre">Denver</span></code> could be a location in the <code class="docutils literal"><span class="pre">Mile</span> <span class="pre">High</span></code> region and that region could be part of the <code class="docutils literal"><span class="pre">West</span></code> division. Enter your divisions first in <cite>Misc->Divisions</cite>, then enter the regions in <cite>Misc->Regions</cite>, referencing the divisions entered, and finally, enter the physical locations in <cite>Misc->Locations</cite>, referencing the regions entered.</p>
+<p>All servers also have to be part of a <cite>cache group</cite>. A cache group is a logical grouping of caches, that don’t have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.</p>
+</div>
+<div class="section" id="configuring-content-purge">
+<h2>Configuring Content Purge<a class="headerlink" href="#configuring-content-purge" title="Permalink to this headline">�</a></h2>
+<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
+<p>Content Purge is controlled by the following parameters in the profile of the cache:</p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="9%" />
+<col width="10%" />
+<col width="20%" />
+<col width="61%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Config file</th>
+<th class="head">Description</th>
+<th class="head">Details</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>location</td>
+<td>regex_revalidate.config</td>
+<td>What location the file should be in on the cache</td>
+<td>The presence of this parameter tells ort to distribute this file; delete this parameter from the profile if this file is distributed using other means.</td>
+</tr>
+<tr class="row-odd"><td>maxRevalDurationDays</td>
+<td>regex_revalidate.config</td>
+<td>The maximum time a purge can be active</td>
+<td>To prevent a build up of many checks before each request, this is longest time the system will allow</td>
+</tr>
+<tr class="row-even"><td>regex_revalidate</td>
+<td>plugin.config</td>
+<td>The config to be used for regex_revalidate.
+For example: –config regex_revalidate.config</td>
+<td><a class="reference external" href="https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html">regex_revalidate</a></td>
+</tr>
+</tbody>
+</table>
+<p>Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime">proxy-config-http-cache-guaranteed-min-lifetime</a> to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as <cite>maxRevalDurationDays</cite> (Note that the former is in seconds and the latter is in days, so convert appropriately).</p>
+<div class="section" id="creating-the-centos-kickstart-file">
+<span id="creating-centos-kickstart"></span><h3>Creating the CentOS Kickstart File<a class="headerlink" href="#creating-the-centos-kickstart-file" title="Permalink to this headline">�</a></h3>
+<p>The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file <code class="docutils literal"><span class="pre">/root/anaconda-ks.cfg</span></code>. This file is editable using most text editors that can save files as ASCII text.</p>
+<p>To generate ISO, the CentOS Kickstart is necessary:</p>
+<ol class="arabic simple">
+<li>Create a kickstart file.</li>
+<li>Create a boot media with the kickstart file or make the kickstart file available on the network.</li>
+<li>Make the installation tree available.</li>
+<li>Start the kickstart installation.</li>
+</ol>
+<p>Create a ks.src file in the root of the selection location. See the example below:</p>
+<div class="highlight-python"><div class="highlight"><pre>mkdir newdir
+cd newdir/
+cp -r ../centos65/* .
+vim ks.src
+vim isolinux/isolinux.cfg
+cd vim osversions.cfg
+vim osversions.cfg
+</pre></div>
+</div>
+<p>This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">Streamline your install folder for under 1GB, which assists in creating a CD.</p>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last">For in-depth instructions, please see <a class="reference external" href="https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/s1-kickstart2-howuse.html">Kickstart Installation</a></p>
+</div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_ops_using.html" class="btn btn-neutral float-right" title="Using Traffic Ops">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_install.html" class="btn btn-neutral" title="Installing Traffic Ops"><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.0',
+ 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/ee296175/docs/1.8.0/admin/traffic_ops_extensions.html
----------------------------------------------------------------------
diff --git a/docs/1.8.0/admin/traffic_ops_extensions.html b/docs/1.8.0/admin/traffic_ops_extensions.html
new file mode 100644
index 0000000..1ac61f6
--- /dev/null
+++ b/docs/1.8.0/admin/traffic_ops_extensions.html
@@ -0,0 +1,317 @@
+
+
+<!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>Managing Traffic Ops Extensions — Traffic Control 1.8.0 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.8.0 documentation" href="../index.html"/>
+ <link rel="up" title="Administrator\u2019s Guide" href="index.html"/>
+ <link rel="next" title="Traffic Portal Administration" href="traffic_portal.html"/>
+ <link rel="prev" title="Using Traffic Ops" href="traffic_ops_using.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 current"><a class="current reference internal" href="">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"><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.0</a> »</li>
+
+ <li><a href="index.html">Administrator’s Guide</a> »</li>
+
+ <li>Managing Traffic Ops Extensions</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../_sources/admin/traffic_ops_extensions.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_portal.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_using.html" class="btn btn-neutral" title="Using Traffic Ops"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="managing-traffic-ops-extensions">
+<span id="admin-to-ext-script"></span><h1>Managing Traffic Ops Extensions<a class="headerlink" href="#managing-traffic-ops-extensions" title="Permalink to this headline">�</a></h1>
+<p>Each script is a separate bash script located in <code class="docutils literal"><span class="pre">$TO_HOME/bin/checks/</span></code>.</p>
+<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
+<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
+<p>The scripts are called as follows:</p>
+<div class="highlight-python"><div class="highlight"><pre>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+where:
+
+<name> is the type of check script
+<traffic_ops_ip> is the IP address of the Traffic Ops Server
+<check_name> is the name of the check. For example: CDU, CHR, DSCP, MTU, etc...
+<log_level> is between 1 and 4, with 4 being the most verbose. This field is optional
+</pre></div>
+</div>
+<div class="section" id="example-cron-file">
+<h2>Example Cron File<a class="headerlink" href="#example-cron-file" title="Permalink to this headline">�</a></h2>
+<p>Edit with <code class="docutils literal"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
+<div class="highlight-python"><div class="highlight"><pre>PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
+
+# IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+# IPv6 ping examples
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+# iLO ping
+18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+
+# MTU ping
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+# FQDN
+27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+# DSCP
+36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+# RTR
+10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+# CHR
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+# CDU
+20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+# ORT
+40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+</pre></div>
+</div>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+
+ <a href="traffic_portal.html" class="btn btn-neutral float-right" title="Traffic Portal Administration">Next <span class="fa fa-arrow-circle-right"></span></a>
+
+
+ <a href="traffic_ops_using.html" class="btn btn-neutral" title="Using Traffic Ops"><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.0',
+ 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