http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/_static/pygments.css ---------------------------------------------------------------------- diff --git a/docs/latest/_static/pygments.css b/docs/latest/_static/pygments.css index 20c4814..8213e90 100644 --- a/docs/latest/_static/pygments.css +++ b/docs/latest/_static/pygments.css @@ -47,10 +47,8 @@ .highlight .mh { color: #208050 } /* Literal.Number.Hex */ .highlight .mi { color: #208050 } /* Literal.Number.Integer */ .highlight .mo { color: #208050 } /* Literal.Number.Oct */ -.highlight .sa { color: #4070a0 } /* Literal.String.Affix */ .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ .highlight .sc { color: #4070a0 } /* Literal.String.Char */ -.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ @@ -61,9 +59,7 @@ .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ .highlight .ss { color: #517918 } /* Literal.String.Symbol */ .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ -.highlight .fm { color: #06287e } /* Name.Function.Magic */ .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ -.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/_static/tc_logo.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/tc_logo.png b/docs/latest/_static/tc_logo.png index 9ea6966..e30944c 100644 Binary files a/docs/latest/_static/tc_logo.png and b/docs/latest/_static/tc_logo.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/_static/tc_logo_c_only.png ---------------------------------------------------------------------- diff --git a/docs/latest/_static/tc_logo_c_only.png b/docs/latest/_static/tc_logo_c_only.png new file mode 100644 index 0000000..749fd7f Binary files /dev/null and b/docs/latest/_static/tc_logo_c_only.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/_static/theme_overrides.css ---------------------------------------------------------------------- diff --git a/docs/latest/_static/theme_overrides.css b/docs/latest/_static/theme_overrides.css index 4fed1af..a00e0b8 100644 --- a/docs/latest/_static/theme_overrides.css +++ b/docs/latest/_static/theme_overrides.css @@ -29,8 +29,33 @@ overflow: visible !important; } +.wy-side-nav-search { + background-color: #000000; +} + +.adminition-title { + background-color: #404040; +} +.wy-alert.wy-alert-info, .rst-content .note, .rst-content .wy-alert-info.attention, .rst-content .wy-alert-info.caution, .rst-content +.wy-alert-info.danger, .rst-content .wy-alert-info.error, .rst-content .wy-alert-info.hint, .rst-content .wy-alert-info.important, +.rst-content .wy-alert-info.tip, .rst-content .wy-alert-info.warning, .rst-content .seealso, .rst-content .wy-alert-info.admonition-todo { + background: #edf0f2; +} + +.wy-alert.wy-alert-info .wy-alert-title, .rst-content .note .wy-alert-title, .rst-content .wy-alert-info.attention .wy-alert-title, +.rst-content .wy-alert-info.caution .wy-alert-title, .rst-content .wy-alert-info.danger .wy-alert-title, .rst-content .wy-alert-info.error +.wy-alert-title, .rst-content .wy-alert-info.hint .wy-alert-title, .rst-content .wy-alert-info.important .wy-alert-title, .rst-content +.wy-alert-info.tip .wy-alert-title, .rst-content .wy-alert-info.warning .wy-alert-title, .rst-content .seealso .wy-alert-title, .rst-content +.wy-alert-info.admonition-todo .wy-alert-title, .wy-alert.wy-alert-info .rst-content .admonition-title, .rst-content .wy-alert.wy-alert-info +.admonition-title, .rst-content .note .admonition-title, .rst-content .wy-alert-info.attention .admonition-title, .rst-content .wy-alert-info.caution +.admonition-title, .rst-content .wy-alert-info.danger .admonition-title, .rst-content .wy-alert-info.error .admonition-title, .rst-content +.wy-alert-info.hint .admonition-title, .rst-content .wy-alert-info.important .admonition-title, .rst-content .wy-alert-info.tip .admonition-title, +.rst-content .wy-alert-info.warning .admonition-title, .rst-content .seealso .admonition-title, .rst-content .wy-alert-info.admonition-todo .admonition-title { + background: #404040; +} + .wy-side-nav-search img { - width: 63% !important; + width: 33% !important; } .section { http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html index 78fb527..740e696 100644 --- a/docs/latest/admin/index.html +++ b/docs/latest/admin/index.html @@ -60,7 +60,7 @@ - <img src="../_static/tc_logo.png" class="logo" /> + <img src="../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -103,7 +103,7 @@ </li> </ul> <ul class="current"> -<li class="toctree-l1 current"><a class="current reference internal" href="#">Administratorâs Guide</a><ul> +<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul> <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> @@ -119,7 +119,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><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> @@ -163,7 +163,7 @@ <ul class="wy-breadcrumbs"> <li><a href="../index.html">Traffic Control 1.8-dev</a> »</li> - <li>Administratorâs Guide</li> + <li>Administrator’s Guide</li> <li class="wy-breadcrumbs-aside"> <a href="../_sources/admin/index.rst.txt" rel="nofollow"> View page source</a> @@ -185,7 +185,7 @@ <div role="main" class="document"> <div class="section" id="administrator-s-guide"> -<h1>Administratorâs Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h1> +<h1>Administrator’s Guide<a class="headerlink" href="#administrator-s-guide" title="Permalink to this headline">¶</a></h1> <p>Traffic Control is distributed in source form for the developer, but also as a binary package. This guide details how to install and configure a Traffic Control CDN using the binary packages, as well as how to perform common operations running a CDN.</p> <p>When installing a complete CDN from scratch, a sample recommended order is:</p> <ol class="arabic simple"> @@ -242,6 +242,7 @@ <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#parent-selection">Parent Selection</a></li> <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#multi-site-origin">Multi Site Origin</a></li> <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#ccr-profile-or-traffic-router-profile">CCR Profile or Traffic Router Profile</a></li> +<li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#regex-remap-expression">Regex Remap Expression</a></li> <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#delivery-service-regexp">Delivery Service Regexp</a></li> <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#static-dns-entries">Static DNS Entries</a></li> <li class="toctree-l3"><a class="reference internal" href="traffic_ops_using.html#server-assignments">Server Assignments</a></li> @@ -310,12 +311,13 @@ <li class="toctree-l3"><a class="reference internal" href="traffic_router.html#suggested-way-of-setting-up-an-https-delivery-service">Suggested Way of Setting up an HTTPS Delivery Service</a></li> </ul> </li> +<li class="toctree-l2"><a class="reference internal" href="traffic_router.html#tuning-recommendations">Tuning Recommendations</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a><ul> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#installation">Installation</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#configuration">Configuration</a></li> -<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id2">InfluxDb Tools</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html#id1">InfluxDb Tools</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a><ul> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/dnssec.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/dnssec.html b/docs/latest/admin/quick_howto/dnssec.html index e3678b8..d978950 100644 --- a/docs/latest/admin/quick_howto/dnssec.html +++ b/docs/latest/admin/quick_howto/dnssec.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li><a href="index.html">Quick How To Guides</a> »</li> @@ -212,13 +212,13 @@ <li>Effective Date</li> </ul> </div></blockquote> -<p>Once the required information has been entered click on the âGenerate Keysâ button.</p> +<p>Once the required information has been entered click on the ‘Generate Keys’ button.</p> <p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p> </li> </ol> <a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a> <ol class="arabic" start="3"> -<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDNâs domain (e.g. If the CDNâs domain is âcdn.kabletown.netâ the parent zone is âkabletown.netâ).</p> +<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p> <p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p> </li> </ol> @@ -226,7 +226,7 @@ <ol class="arabic" start="4"> <li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p> <p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p> -<p>This will add a âdnssec.enabled = âtrueââ entry to CRConfig for the chosen CDN.</p> +<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p> </li> </ol> <a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a> @@ -238,7 +238,7 @@ </div></blockquote> </li> <li><p class="first">When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.</p> -<p>A new KSK can be generated by clicking the âRegenerate KSKâ button on the Manage DNSSEC Keys screen (see screenshot above).</p> +<p>A new KSK can be generated by clicking the ‘Regenerate KSK’ button on the Manage DNSSEC Keys screen (see screenshot above).</p> </li> </ol> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/federations.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/federations.html b/docs/latest/admin/quick_howto/federations.html index c633c0c..c0ee732 100644 --- a/docs/latest/admin/quick_howto/federations.html +++ b/docs/latest/admin/quick_howto/federations.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li><a href="index.html">Quick How To Guides</a> »</li> @@ -205,7 +205,7 @@ </ol> <a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a> <ol class="arabic simple" start="2"> -<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking âAdd Federation Mappingâ</li> +<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li> <li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li> </ol> <a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a> @@ -220,7 +220,7 @@ <ol class="arabic" start="5"> <li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p> <p>Example:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }' +<div class="highlight-default"><div class="highlight"><pre>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }' HTTP/1.1 200 OK Date: Wed, 02 Dec 2015 21:12:06 GMT @@ -242,7 +242,7 @@ Access-Control-Allow-Origin: http://localhost:8080 <li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p> <blockquote> <div><p>Example:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d ' +<div class="highlight-default"><div class="highlight"><pre>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d ' {"federations": [ { "deliveryService": "images-c1", "mappings": @@ -279,7 +279,7 @@ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept <li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p> <blockquote> <div><p>Example:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net +<div class="highlight-default"><div class="highlight"><pre>$ dig @tr.kabletown.net edge.images-c1.kabletown.net ; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net ; (1 server found) http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/index.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/index.html b/docs/latest/admin/quick_howto/index.html index 412e345..2fab93d 100644 --- a/docs/latest/admin/quick_howto/index.html +++ b/docs/latest/admin/quick_howto/index.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li>Quick How To Guides</li> <li class="wy-breadcrumbs-aside"> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/multi_site.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/multi_site.html b/docs/latest/admin/quick_howto/multi_site.html index ee609e9..57e3c61 100644 --- a/docs/latest/admin/quick_howto/multi_site.html +++ b/docs/latest/admin/quick_howto/multi_site.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li><a href="index.html">Quick How To Guides</a> »</li> @@ -192,7 +192,7 @@ <div class="section" id="configure-multi-site-origin"> <span id="rl-multi-site-origin-qht"></span><h1>Configure Multi Site Origin<a class="headerlink" href="#configure-multi-site-origin" title="Permalink to this headline">¶</a></h1> <ol class="arabic simple"> -<li>Create âcachegroupsâ for the origin locations, and assign the appropriate parent-child relationship between the mid cgâs and org cgs (click the image to see full size):</li> +<li>Create “cachegroups” for the origin locations, and assign the appropriate parent-child relationship between the mid cg’s and org cgs (click the image to see full size):</li> </ol> <a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" style="width: 1472.0px; height: 210.0px;" /></a> <ol class="arabic simple" start="2"> @@ -219,7 +219,7 @@ 3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.</p> </div> <ol class="arabic simple" start="6"> -<li>Select an option from the âMulti Site Origin Algorithmâ drop-down list. Four MSO algorithms are supported:</li> +<li>Select an option from the “Multi Site Origin Algorithm” drop-down list. Four MSO algorithms are supported:</li> </ol> <table border="1" class="docutils"> <colgroup> @@ -238,7 +238,7 @@ <tr class="row-odd"><td>Primary/back</td> <td>Round robin selection does not occur. The first origin server is selected unless it fails. If the first fails, the second and other following origin servers will be tried by order. -Order is defined by 2 factors - if the origin serverâs cachegroup is configured as the +Order is defined by 2 factors - if the origin server’s cachegroup is configured as the parent cachegroup for the mid, then this server will be used as the primary. The same rules apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort order further. If no parents are defined at the mid, then only rank is considered.</td> @@ -255,7 +255,7 @@ round-robin</td> </tbody> </table> <ol class="arabic simple" start="7"> -<li>Optionally, there are two configuration options that can set the order of the origins used if âPrimary/backupâ is selected for âMulti Site Origin Algorithmâ. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter ârankâ should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of â2â precedes OS with the rank of â5â. For any OS, if rank value is not defined in its profile, its rank value will default to â1â. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.</li> +<li>Optionally, there are two configuration options that can set the order of the origins used if “Primary/backup” is selected for “Multi Site Origin Algorithm”. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter ârankâ should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to â1â. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific bac kup servers for use at specific locations.</li> </ol> <a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" style="width: 585.0px; height: 105.6px;" /></a> <ol class="arabic simple" start="8"> @@ -264,7 +264,7 @@ round-robin</td> <a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" style="width: 658.0px; height: 601.0px;" /></a> <ol class="arabic" start="9"> <li><p class="first">Configure the mid hdr_rewrite on the delivery service, example:</p> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <sp an class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span > <span class="n">proxy</span><span class="o">.</span><span > class="n">config</span><span class="o">.</span><span > class="n">http</span><span class="o">.</span><span > class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span > class="n">__RETURN__</span> <span class="nb">set</span><span > class="o">-</span><span class="n">config</span> <span > class="n">proxy</span><span class="o">.</span><span > class="n">config</span><span class="o">.</span><span > class="n">http</span><span class="o">.</span><span > class="n">connect_attempts_max_retries</span> <span class="mi">2</span> > <span class="n">__RETURN__</span> <span class="nb">set</span><span > class="o">-</span><span class="n">config</span> <span > class="n">proxy</span><span class="o">.</span><span > class="n">config</span><span class="o">.</span><span > class="n">http</span><span class="o">.</span><span > class="n">connect_attempts_max_retries_dead_server</span> <span > class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set< /span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span> +<div class="highlight-default"><div class="highlight"><pre><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <span class="mi" >1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span >class="o">-</span><span class="n">config</span> <span >class="n">proxy</span><span class="o">.</span><span >class="n">config</span><span class="o">.</span><span >class="n">http</span><span class="o">.</span><span >class="n">parent_origin</span><span class="o">.</span><span >class="n">simple_retry_response_codes</span> <span >class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> ><span class="nb">set</span><span class="o">-</span><span >class="n">config</span> <span class="n">proxy</span><span >class="o">.</span><span class="n">config</span><span class="o">.</span><span >class="n">http</span><span class="o">.</span><span >class="n">parent_origin</span><span class="o">.</span><span >class="n">dead_server_retry_response_codes</span> <span >class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span >class="nb">set</span><span class="o">-</span><span class="n">config</span> ><span class ="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span c lass="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span> </pre></div> </div> </li> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/regionalgeo.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/regionalgeo.html b/docs/latest/admin/quick_howto/regionalgeo.html index 4c8aab4..82150ca 100644 --- a/docs/latest/admin/quick_howto/regionalgeo.html +++ b/docs/latest/admin/quick_howto/regionalgeo.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li><a href="index.html">Quick How To Guides</a> »</li> @@ -199,7 +199,7 @@ <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></span><span class="p">{</span> +<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> @@ -220,7 +220,7 @@ </pre></div> </div> <ul class="simple"> -<li>The value of âdeliveryServiceIdâ shall be equal to the âXML IDâ field of the intended delivery service defined on Traffic Ops.</li> +<li>The value of “deliveryServiceId” shall be equal to the âXML IDâ field of the intended delivery service defined on Traffic Ops.</li> <li>âurlRegexâ is to match request URLs. The URLs matching the regex are applicable to the rule.</li> <li>âgeoLocationâ currently supports âincludePostalCodeâ and âexcludePostalCodeâ attribute. When âincludePostalCodeâ attribute is used, only the clients whose FSAs are in the âincludePostalCodeâ list are able to view the content represented by âurlRegexâ. When âexcludePostalCodeâ is used, any client whose FSA are not in the âexcludePostalCodeâ list are allowed to view the content. âincludePostalCodeâ and âexcludePostalCodeâ are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)</li> <li>âredirectUrlâ 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 âurlRegexâ part to avoid HTTP 302 loop on Traffic Router.</li> @@ -231,8 +231,8 @@ </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> +<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"> @@ -242,15 +242,15 @@ <ol class="arabic simple" start="4"> <li>Make configuration effective</li> </ol> -<p>Go to Tools->Snapshot CRConfig, perform âDiff CRConfigâ and click âWrite CRConfigâ.</p> +<p>Go to Tools->Snapshot CRConfig, perform âDiff CRConfigâ 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></span><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> +<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"> @@ -261,7 +261,7 @@ <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></span><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> +<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> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/quick_howto/steering.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/quick_howto/steering.html b/docs/latest/admin/quick_howto/steering.html index e7582b2..640f534 100644 --- a/docs/latest/admin/quick_howto/steering.html +++ b/docs/latest/admin/quick_howto/steering.html @@ -61,7 +61,7 @@ - <img src="../../_static/tc_logo.png" class="logo" /> + <img src="../../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li><a href="index.html">Quick How To Guides</a> »</li> @@ -200,7 +200,7 @@ </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> +<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"> @@ -215,7 +215,7 @@ </div></blockquote> </li> </ol> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<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> @@ -237,7 +237,7 @@ </div></blockquote> </li> </ol> -<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> +<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> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/traffic_monitor.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_monitor.html b/docs/latest/admin/traffic_monitor.html index 9a64e8b..67e271d 100644 --- a/docs/latest/admin/traffic_monitor.html +++ b/docs/latest/admin/traffic_monitor.html @@ -61,7 +61,7 @@ - <img src="../_static/tc_logo.png" class="logo" /> + <img src="../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li>Traffic Monitor Administration</li> <li class="wy-breadcrumbs-aside"> @@ -213,7 +213,7 @@ <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><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt +<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 @@ -296,7 +296,7 @@ traffic_mon # </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></span><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> +<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> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/traffic_ops_config.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_ops_config.html b/docs/latest/admin/traffic_ops_config.html index ed5c16d..abc1191 100644 --- a/docs/latest/admin/traffic_ops_config.html +++ b/docs/latest/admin/traffic_ops_config.html @@ -61,7 +61,7 @@ - <img src="../_static/tc_logo.png" class="logo" /> + <img src="../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li>Configuring Traffic Ops</li> <li class="wy-breadcrumbs-aside"> @@ -199,7 +199,7 @@ </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> +<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%" /> @@ -219,11 +219,11 @@ </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> +<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> +<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> @@ -282,7 +282,7 @@ set this parameter on a production system.</td> </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> +<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"> @@ -320,6 +320,22 @@ The Traffic Monitor IP addresses have to be included in this, if they are using <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"><span class="std std-ref">Invalidate Content</span></a>)</td> </tr> +<tr class="row-odd"><td>coalesce_masklen_v4</td> +<td>ip_allow.config</td> +<td>The masklen to use when coalescing v4 networks into one line using <a class="reference external" href="http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm";>http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm</a></td> +</tr> +<tr class="row-even"><td>coalesce_number_v4</td> +<td>ip_allow.config</td> +<td>The number to use when coalescing v4 networks into one line using <a class="reference external" href="http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm";>http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm</a></td> +</tr> +<tr class="row-odd"><td>coalesce_masklen_v6</td> +<td>ip_allow.config</td> +<td>The masklen to use when coalescing v6 networks into one line using <a class="reference external" href="http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm";>http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm</a></td> +</tr> +<tr class="row-even"><td>coalesce_masklen_v6</td> +<td>ip_allow.config</td> +<td>The masklen to use when coalescing v6 networks into one line using <a class="reference external" href="http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm";>http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm</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> @@ -328,20 +344,59 @@ The Traffic Monitor IP addresses have to be included in this, if they are using 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> +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> +<table border="1" class="docutils"> +<colgroup> +<col width="9%" /> +<col width="8%" /> +<col width="28%" /> +<col width="55%" /> +</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>astats_over_http</td> +<td>package</td> +<td>The package version for the astats_over_http plugin.</td> +<td><a class="reference external" href="http://trafficcontrol.apache.org/downloads/index.html";>astats_over_http</a></td> +</tr> +<tr class="row-odd"><td>trafficserver</td> +<td>package</td> +<td>The package version for the trafficserver plugin.</td> +<td><a class="reference external" href="http://trafficcontrol.apache.org/downloads/index.html";>trafficserver</a></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> +<tr class="row-odd"><td>remap_stats</td> +<td>plugin.config</td> +<td>The config to be used for remap_stats. +Value is left blank.</td> +<td><a class="reference external" href="https://github.com/apache/trafficserver/tree/master/plugins/experimental/remap_stats";>remap_stats</a></td> +</tr> +</tbody> +</table> </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> +<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 lower 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"><span class="std std-ref">Configuring Traffic Server</span></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 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"><span class="std std-ref">Configuring Traffic Server</span></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> @@ -371,7 +426,7 @@ For example: ââ>1500000â means stop sending new traffic to this cache w <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> +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> @@ -388,7 +443,7 @@ For example: âconfig regex_revalidate.config</td> <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-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span> +<div class="highlight-default"><div class="highlight"><pre><span class="n">mkdir</span> <span class="n">newdir</span> <span class="n">cd</span> <span class="n">newdir</span><span class="o">/</span> <span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">../</span><span class="n">centos65</span><span class="o">/*</span> <span class="o">.</span> <span class="n">vim</span> <span class="n">ks</span><span class="o">.</span><span class="n">src</span> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/6b5a5ffa/docs/latest/admin/traffic_ops_extensions.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_ops_extensions.html b/docs/latest/admin/traffic_ops_extensions.html index efd62dc..31ec813 100644 --- a/docs/latest/admin/traffic_ops_extensions.html +++ b/docs/latest/admin/traffic_ops_extensions.html @@ -61,7 +61,7 @@ - <img src="../_static/tc_logo.png" class="logo" /> + <img src="../_static/tc_logo_c_only.png" class="logo" /> </a> @@ -104,7 +104,7 @@ </li> </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-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> @@ -120,7 +120,7 @@ </li> </ul> <ul> -<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developerâs Guide</a><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> @@ -164,7 +164,7 @@ <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">Administrator’s Guide</a> »</li> <li>Managing Traffic Ops Extensions</li> <li class="wy-breadcrumbs-aside"> @@ -193,7 +193,7 @@ <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-default"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level> +<div class="highlight-default"><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 @@ -205,7 +205,7 @@ where: <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-default"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span> +<div class="highlight-default"><div class="highlight"><pre><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span> <span class="c1"># IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.</span> <span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">hostName</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">domainName</span><span class="se">\"</span><span class="s2">]}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
