http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/admin/traffic_router.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_router.html b/docs/latest/admin/traffic_router.html index 779b941..ba1ea23 100644 --- a/docs/latest/admin/traffic_router.html +++ b/docs/latest/admin/traffic_router.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Traffic Router Administration — Traffic Control master documentation </title> + <title>Traffic Router Administration — Traffic Control 2.1-dev documentation </title> @@ -33,10 +33,10 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> <link rel="up" title="Administratorâs Guide" href="index.html"/> <link rel="next" title="Traffic Stats Administration" href="traffic_stats.html"/> - <link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor.html"/> + <link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor_golang.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -102,13 +102,16 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</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 current"><a class="current reference internal" href="">Traffic Router Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor_golang.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="index.html">Administrator’s Guide</a> »</li> @@ -178,7 +183,7 @@ <a href="traffic_stats.html" class="btn btn-neutral float-right" title="Traffic Stats Administration">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="traffic_monitor_golang.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -228,7 +233,7 @@ <li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p> </li> <li><dl class="first docutils"> -<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><em>Configuration files</em></a></dt> +<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt> <dd><p class="first"># traffic_monitor.properties: url that should normally point to this file traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p> <p class="last"># Frequency for reloading this file @@ -236,9 +241,14 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert </dd> </dl> </li> -<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</p> +<li><dl class="first docutils"> +<dt>Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</dt> +<dd><p class="first last">To restart, <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">stop</span></code>, kill the traffic router process, and <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> +Also, crconfig previously recieved will be cached, and needs to be removed manually to actually be reloaded /opt/traffic_router/db/cr-config.json</p> +</dd> +</dl> </li> -<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a></p> +<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops/using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a></p> </li> </ol> <div class="admonition note"> @@ -259,7 +269,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert <p class="first admonition-title">Note</p> <p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p> </div> -<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p> +<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops/using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p> <div class="section" id="configuration-files"> <span id="rl-tr-config-files"></span><h3>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">¶</a></h3> <table border="1" class="docutils"> @@ -385,7 +395,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert </div> <div class="section" id="operation"> <h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">¶</a></h3> -<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> documentation for more information.</p> +<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops/using.html#rl-ccr-profile"><span class="std std-ref">Traffic Router Profile</span></a> documentation for more information.</p> <p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p> <p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p> </div> @@ -410,8 +420,8 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t <div class="section" id="sample-message"> <h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">¶</a></h3> <p>Items within brackets below are detailed under the HTTP and DNS sections</p> -<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result] -144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result] +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields </span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span> +<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <sp an class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span> </pre></div> </div> <div class="admonition note"> @@ -550,7 +560,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t <div class="section" id="http-specifics"> <h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">¶</a></h3> <p>Sample Message</p> -<div class="highlight-python"><div class="highlight"><pre>1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg" +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-& quot;</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span> </pre></div> </div> <p><strong>Request Fields</strong></p> @@ -610,7 +620,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t <div class="section" id="dns-specifics"> <h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">¶</a></h3> <p>Sample Message</p> -<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304" +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERRO R</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span> </pre></div> </div> <p><strong>Request Fields</strong></p> @@ -854,12 +864,12 @@ improved overall throughput for Traffic Router and reduced ‘Stop the World in setenv.sh will override init scripts in /etc/init.d/tomcat.</p> <blockquote> <div><p>/opt/tomcat/bin/setenv.sh:</p> -<div class="highlight-python"><div class="highlight"><pre>#! /bin/sh -export CATALINA_OPTS="$CATALINA_OPTS -server" -export CATALINA_OPTS="$CATALINA_OPTS -Xms2g -Xmx2g" -export CATALINA_OPTS="$CATALINA_OPTS -XX:+UseG1GC" -export CATALINA_OPTS="$CATALINA_OPTS -XX:+UnlockExperimentalVMOptions" -export CATALINA_OPTS="$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30" +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#! /bin/sh</span> +<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -server"</span> +<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -Xms2g -Xmx2g"</span> +<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -XX:+UseG1GC"</span> +<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -XX:+UnlockExperimentalVMOptions"</span> +<span class="n">export</span> <span class="n">CATALINA_OPTS</span><span class="o">=</span><span class="s2">"$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30"</span> </pre></div> </div> </div></blockquote> @@ -875,7 +885,7 @@ export CATALINA_OPTS="$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30& <a href="traffic_stats.html" class="btn btn-neutral float-right" title="Traffic Stats Administration">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="traffic_monitor.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="traffic_monitor_golang.html" class="btn btn-neutral" title="Traffic Monitor Administration"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -904,10 +914,11 @@ export CATALINA_OPTS="$CATALINA_OPTS -XX:InitiatingHeapOccupancyPercent=30& <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/admin/traffic_server.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_server.html b/docs/latest/admin/traffic_server.html index 1248ea4..02342ef 100644 --- a/docs/latest/admin/traffic_server.html +++ b/docs/latest/admin/traffic_server.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Traffic Server Administration — Traffic Control master documentation </title> + <title>Traffic Server Administration — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> <link rel="up" title="Administratorâs Guide" href="index.html"/> <link rel="next" title="Traffic Vault Administration" href="traffic_vault.html"/> <link rel="prev" title="Traffic Stats Administration" href="traffic_stats.html"/> @@ -102,15 +102,18 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server Administration</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">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> @@ -118,10 +121,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="index.html">Administrator’s Guide</a> »</li> @@ -188,21 +193,64 @@ <h1>Traffic Server Administration<a class="headerlink" href="#traffic-server-administration" title="Permalink to this headline">¶</a></h1> <div class="section" id="installing-traffic-server"> <h2>Installing Traffic Server<a class="headerlink" href="#installing-traffic-server" title="Permalink to this headline">¶</a></h2> +<ol class="arabic"> +<li><p class="first">Get the Traffic Server RPM and the astats RPM.</p> +<p>Sample command:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.7</span><span class="o">.</span><span class="mi">0</span><span class="o">/</span><span class="n">trafficserver</span><span class="o">-</span><span class="mf">5.3</span><span class="o">.</span><span class="mi">2</span><span class="o">-</span><span class="mf">759.</span><span class="n">ee14bbe</span><span class="o">.</span><span class="n">el6</span><span class="o">.</span><span class ="n">x86_64</span><span class="o">.</span><span class="n">rpm</span> +<span class="n">wget</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">traffic</span><span class="o">-</span><span class="n">control</span><span class="o">-</span><span class="n">cdn</span><span class="o">.</span><span class="n">net</span><span class="o">/</span><span class="n">downloads</span><span class="o">/</span><span class="mf">1.6</span><span class="o">.</span><span class="mi">1</span><span class="o">/</span><span class="n">RELEASE</span><span class="o">-</span><span class="mf">1.6</span><span class="o">.</span><span class="mi">1</span><span class="o">/</span><span class="n">astats_over_http</span><span class="o">-</span><span class="mf">1.2</span><span class="o">-</span><span class="mf">8.</span><span class="n">el6</span><span class="o">.</span><span class="n">x86_64</span><span class="o">.</span><span class="n">rpm</span> +</pre></div> +</div> +<p>(astats was not released as part of 1.7, so in this examples 1.6.1 was used)</p> +</li> +<li><p class="first">Install Traffic Server and astats:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">yum</span> <span class="o">-</span><span class="n">y</span> <span class="n">install</span> <span class="n">trafficserver</span><span class="o">-*.</span><span class="n">rpm</span> <span class="n">astats_over_http</span><span class="o">*.</span><span class="n">rpm</span> +</pre></div> +</div> +</li> +<li><p class="first">Add the server using the Traffic Ops web interface:</p> +<ol class="arabic"> +<li><p class="first">Select <strong>Servers</strong>.</p> +</li> +<li><p class="first">Scroll to the bottom of the page and click <strong>Add Server</strong>.</p> +</li> +<li><dl class="first docutils"> +<dt>Complete the “Required Info:” section:</dt> +<dd><ul class="first last simple"> +<li>Set ‘Interface Name’ to the name of the interface from which traffic server delivers content.</li> +<li>Set ‘Type’ to ‘MID’ or ‘EDGE’.</li> +</ul> +</dd> +</dl> +</li> +<li><p class="first">Click <strong>Submit</strong>.</p> +</li> +<li><p class="first">Click <strong>Save</strong>.</p> +</li> +<li><p class="first">Click <strong>Online Server</strong>.</p> +</li> +<li><p class="first">Verify that the server status is now listed as <strong>Reported</strong></p> +</li> +</ol> +</li> +<li><p class="first">Install the ORT script and run it in ‘badass’ mode to create the initial configuration, see <a class="reference internal" href="#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a></p> +</li> +<li><p class="first">Start the service: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">trafficserver</span> <span class="pre">start</span></code></p> +</li> +<li><p class="first">Configure traffic server to start automatically: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">chkconfig</span> <span class="pre">trafficserver</span> <span class="pre">on</span></code></p> +</li> +<li><p class="first">Verify that the installation is good:</p> <ol class="arabic simple"> -<li>Select <strong>Servers</strong> in the Traffic Ops web interface.</li> -<li>Scroll to the bottom of the page and click <strong>Add Server</strong>.</li> -<li>Complete the <em>Required Info</em>: section.</li> -<li>Click <strong>Submit</strong>.</li> -<li>Click <strong>Save</strong>.</li> +<li>Make sure that the service is running: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">trafficserver</span> <span class="pre">status</span></code></li> +<li>Assuming a traffic monitor is already installed, browse to it, and verify that the traffic server appears in the “Cahce States” table, in white.</li> +</ol> +</li> </ol> </div> <div class="section" id="configuring-traffic-server"> <span id="reference-traffic-ops-ort"></span><h2>Configuring Traffic Server<a class="headerlink" href="#configuring-traffic-server" title="Permalink to this headline">¶</a></h2> -<p>All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.</p> -<dl class="docutils"> -<dt><strong>traffic_ops_ort.pl</strong></dt> -<dd><p class="first">The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p> -<div class="highlight-python"><div class="highlight"><pre>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net +<p>All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script. +The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do the initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl Thu May 26 15:52:11 UTC 2016 ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-==== Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags] @@ -225,20 +273,69 @@ Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL&g $ </pre></div> </div> -<p>For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below:</p> -<div class="highlight-python"><div class="highlight"><pre>run here +<div class="section" id="installing-the-ort-script"> +<h3>Installing the ORT script<a class="headerlink" href="#installing-the-ort-script" title="Permalink to this headline">¶</a></h3> +<ol class="arabic"> +<li><p class="first">The ORT script is not a part of the traffic server distribution. In this sample session, we get it manually from github:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sudo</span> <span class="n">mkdir</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span> +<span class="n">sudo</span> <span class="n">wget</span> <span class="o">-</span><span class="n">P</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">raw</span><span class="o">.</span><span class="n">githubusercontent</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">apache</span><span class="o">/</span><span class="n">incubator</span><span class="o">-</span><span class="n">trafficcontrol</span><span class="o">/</span><span class="mf">1.7</span><span class="o">.</span><span class="n">x</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> +<span class="n">sudo</span> <span class="n">chmod</span> <span class="o">+</span><span class="n">x</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> </pre></div> </div> -<p>For “every day changes” such as adding deliveryservices or changing records.config parameters caches should run the script in “syncds” mode out of cron. Example crontab entry:</p> -<div class="highlight-python"><div class="highlight"><pre>*/15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1 +</li> +<li><p class="first">Install modules required by ORT: <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">perl-JSON</span> <span class="pre">perl-Crypt-SSLeay</span></code></p> +</li> +<li><p class="first">For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages +will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted.</p> +<p>Example run below:</p> +<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo /opt/ort/traffic_ops_ort.pl --dispersion=0 badass warn https://ops.$tcDomain admin:admin123 </pre></div> </div> -<div class="last admonition note"> +<div class="admonition note"> <p class="first admonition-title">Note</p> -<p class="last"><disclaimer on what is “hot changeable” here></p> +<p class="last">First run gives a lot of state errors that are expected. The “badass” mode fixes these issue s. Run it a second time, this should be cleaner. +Also, note that many ERROR messages emitted by ORT are actually information messages. Do not panic.</p> +</div> +</li> +<li><p class="first">Create a cron entry for running ort in ‘syncds’ mode every 15 minutes. +This makes traffic control check periodically if ‘Queue Updates’ was run on Traffic Ops, and it so, get the updated configuration.</p> +<p>Run <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p> +<div class="highlight-default"><div class="highlight"><pre><span></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="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">--</span><span class="n">dispersion</span><span class="o">=</span><span c lass="mi">180</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span> +</pre></div> +</div> +<p>Changing <code class="docutils literal"><span class="pre">https://traffops.kabletown.net</span></code>, <code class="docutils literal"><span class="pre">admin</span></code>, and <code class="docutils literal"><span class="pre">password</span></code> to your CDN URL and credentials.</p> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">By default, running ort on an edge traffic server waits for it’s parent (mid) servers to download their configuration before +it downloads it’s own configuration. Because of this, scheduling ort for running every 15 minutes (with 5 minutes default dispersion) means +that it might take up to ~35 minutes for a “Queue Updates” operation to affect all traffic servers. To customize this dispersion time, use +the command line option –dispersion=x where x is the number of seconds for the dispersion period. Servers will select a random number from +within this dispersion period to being pulling down configuration files from Traffic Ops. Another option, –login_dispersion=x can be used. +This option creates a dispersion period after the job begins during which ORT will wait before logging in and checking Traffic Ops for updates +to the server. This defaults to 0. If use_reval_pending, a.k.a. Rapid Revalidate is enabled, edges will NOT wait for their parents to download +their configuration before downloading their own.</p> +</div> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p>In ‘syncds’ mode, the ort script updates only configurations that might be changed as part of normal operations, such as:</p> +<ul class="last simple"> +<li>Delivery Services</li> +<li>SSL certificates</li> +<li>Traffic Monitor IP addresses</li> +<li>Logging configuration</li> +<li>Revalidation requests (By default. If Rapid Revalidate is enabled, this will only be checked by using a separate revalidate command in ORT.)</li> +</ul> +</div> +</li> +<li><p class="first">If Rapid Revalidate is enabled in Traffic Ops, create a second cron job for revalidation checks. ORT will not check revalidation files if Rapid Revalidate +is enabled. This setting allows for a separate check to be performed every 60 seconds to verify if a revalidation update has been made.</p> +<p>Run <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">crontab</span> <span class="pre">-e</span></code> and add the following line</p> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">1</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">revalidate</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">--</span><span class="n">login_dispersion</span><span class="o">=</span><span class="mi">30</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span cl ass="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span> +</pre></div> +</div> +</li> +</ol> </div> -</dd> -</dl> </div> </div> @@ -280,10 +377,11 @@ $ <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/admin/traffic_stats.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_stats.html b/docs/latest/admin/traffic_stats.html index e6120bf..23a289a 100644 --- a/docs/latest/admin/traffic_stats.html +++ b/docs/latest/admin/traffic_stats.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Traffic Stats Administration — Traffic Control master documentation </title> + <title>Traffic Stats Administration — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> <link rel="up" title="Administratorâs Guide" href="index.html"/> <link rel="next" title="Traffic Server Administration" href="traffic_server.html"/> <link rel="prev" title="Traffic Router Administration" href="traffic_router.html"/> @@ -102,14 +102,17 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats Administration</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">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> @@ -118,10 +121,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="index.html">Administrator’s Guide</a> »</li> @@ -192,9 +197,10 @@ <p><strong>Installing Traffic Stats:</strong></p> <blockquote> <div><ul class="simple"> -<li>Download the Traffic Stats RPM from the traffic control <a class="reference external" href="https://trafficcontrol.apache.org/downloads/index.html">downloads</a> page.</li> -<li>Copy the Traffic Stats RPM to your server</li> -<li>sudo rpm -ivh <traffic_stats rpm></li> +<li>See the <a class="reference external" href="https://trafficcontrol.apache.org/downloads/index.html">downloads</a> page for Traffic Control to get the lastest release.</li> +<li>Follow our build <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/build">intructions</a> to generate an RPM.</li> +<li>Copy the RPM to your server</li> +<li>perform the following command: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">rpm</span> <span class="pre">-ivh</span> <span class="pre"><traffic_stats</span> <span class="pre">rpm></span></code></li> </ul> </div></blockquote> <p><strong>Installing InfluxDB:</strong></p> @@ -325,27 +331,27 @@ The following values need to be configured:</p> <p>Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb. They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.</p> <dl class="docutils"> -<dt><strong>create_ts_databases</strong></dt> +<dt><strong>create/create_ts_databases.go</strong></dt> <dd><p class="first">This script creates all <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#database">databases</a>, <a class="reference external" href="https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#retention-policy">retention policies</a>, and <a class="reference external" href="https://docs.influxdata.com/influxdb/v0.11/query_language/continuous_queries/">continuous queries</a> required by traffic stats.</p> <p><strong>How to use create_ts_databases:</strong></p> <p>Pre-Requisites:</p> <blockquote> <div><ol class="arabic simple"> -<li>Go 1.4 or later</li> +<li>Go 1.7 or later</li> <li>configured $GOPATH (e.g. export GOPATH=~/go)</li> </ol> </div></blockquote> <p>Using create_ts_databases.go</p> <blockquote class="last"> <div><ol class="arabic"> -<li><p class="first">go get github.com/influxdata/influxdb</p> +<li><p class="first">go to the traffic_stats/influxdb_tools/create directory</p> </li> -<li><p class="first">go build create_ts_databases.go</p> +<li><p class="first">build it by running <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">create_ts_databases.go</span></code> or simply <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span></code></p> </li> <li><dl class="first docutils"> <dt>Run it:</dt> <dd><ul class="first last"> -<li><p class="first">./create_ts_databases -help</p> +<li><p class="first"><code class="docutils literal"><span class="pre">./create_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal"><span class="pre">./create</span> <span class="pre">-help</span></code></p> </li> <li><dl class="first docutils"> <dt>optional flags:</dt> @@ -358,7 +364,7 @@ They are specific for traffic stats and are not meant to be generic to influxdb. </dd> </dl> </li> -<li><p class="first">example: ./create_ts_databases -url=localhost:8086 -replication=3 -user=joe -password=mysecret</p> +<li><p class="first">example: <code class="docutils literal"><span class="pre">./create_ts_databases</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code> or <code class="docutils literal"><span class="pre">./create</span> <span class="pre">-url=localhost:8086</span> <span class="pre">-replication=3</span> <span class="pre">-user=joe</span> <span class="pre">-password=mysecret</span></code></p> </li> </ul> </dd> @@ -373,27 +379,27 @@ They are specific for traffic stats and are not meant to be generic to influxdb. <p>Pre-Requisites:</p> <blockquote> <div><ol class="arabic simple"> -<li>Go 1.4 or later</li> +<li>Go 1.7 or later</li> <li>configured $GOPATH (e.g. export GOPATH=~/go)</li> </ol> </div></blockquote> <p>Using sync_ts_databases.go:</p> <blockquote class="last"> <div><ol class="arabic"> -<li><p class="first">go get github.com/influxdata/influxdb</p> +<li><p class="first">go to the traffic_stats/influxdb_tools/create directory</p> </li> -<li><p class="first">go build sync_ts_databases.go</p> +<li><p class="first">build it by running <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span> <span class="pre">sync_ts_databases.go</span></code> or simply <code class="docutils literal"><span class="pre">go</span> <span class="pre">build</span></code></p> </li> <li><dl class="first docutils"> <dt>Run it</dt> <dd><ul class="first"> -<li><p class="first">./sync_ts_databases -help</p> +<li><p class="first"><code class="docutils literal"><span class="pre">./sync_ts_databases</span> <span class="pre">-help</span></code> or <code class="docutils literal"><span class="pre">./sync</span> <span class="pre">-help</span></code></p> </li> <li><dl class="first docutils"> <dt>required flags:</dt> <dd><ul class="first last simple"> -<li>sourceUrl - The URL of the source database</li> -<li>targetUrl - The URL of the target database</li> +<li>source-url - The URL of the source database</li> +<li>target-url - The URL of the target database</li> </ul> </dd> </dl> @@ -404,15 +410,15 @@ They are specific for traffic stats and are not meant to be generic to influxdb. <dd><ul class="first last simple"> <li>database - The database to sync (default = sync all databases)</li> <li>days - Days in the past to sync (default = sync all data)</li> -<li>sourceUser - The user of the source database</li> -<li>sourcePass - The password for the source database</li> -<li>targetUser - The user of the target database</li> -<li>targetPass - The password for the target database</li> +<li>source-user - The user of the source database</li> +<li>source-pass - The password for the source database</li> +<li>target-user - The user of the target database</li> +<li>target-pass - The password for the target database</li> </ul> </dd> </dl> <ul class="last simple"> -<li>example: ./sync_ts_databases -sourceUrl=http://influxdb-production-01.kabletown.net:8086 -targetUrl=http://influxdb-dev-01.kabletown.net:8086 -database=cache_stats -days=7 -sourceUser=joe sourcePass=mysecret</li> +<li>example: <cite>./sync -source-url=http://idb-01.foo.net:8086 -target-url=http://idb-01.foo.net:8086 -database=cache_stats -days=7 -source-user=admin source-pass=mysecret</cite></li> </ul> </dd> </dl> @@ -462,10 +468,11 @@ They are specific for traffic stats and are not meant to be generic to influxdb. <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/admin/traffic_vault.html ---------------------------------------------------------------------- diff --git a/docs/latest/admin/traffic_vault.html b/docs/latest/admin/traffic_vault.html index 77048d1..6bcd894 100644 --- a/docs/latest/admin/traffic_vault.html +++ b/docs/latest/admin/traffic_vault.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Traffic Vault Administration — Traffic Control master documentation </title> + <title>Traffic Vault Administration — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> <link rel="up" title="Administratorâs Guide" href="index.html"/> <link rel="next" title="Quick How To Guides" href="quick_howto/index.html"/> <link rel="prev" title="Traffic Server Administration" href="traffic_server.html"/> @@ -102,26 +102,31 @@ </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_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/using.html">Traffic Ops - Using</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_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Vault Administration</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li> </ul> </li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="index.html">Administrator’s Guide</a> »</li> @@ -480,10 +485,11 @@ The installation instructions for Riak can be found <a class="reference external <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/42d25dc5/docs/latest/basics/cache_revalidation.html ---------------------------------------------------------------------- diff --git a/docs/latest/basics/cache_revalidation.html b/docs/latest/basics/cache_revalidation.html index 7015042..3879f87 100644 --- a/docs/latest/basics/cache_revalidation.html +++ b/docs/latest/basics/cache_revalidation.html @@ -7,7 +7,7 @@ <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <title>Cache Control Headers and Revalidation — Traffic Control master documentation </title> + <title>Cache Control Headers and Revalidation — Traffic Control 2.1-dev documentation </title> @@ -33,7 +33,7 @@ - <link rel="top" title="Traffic Control master documentation" href="../index.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> <link rel="up" title="CDN Basics" href="index.html"/> <link rel="next" title="Traffic Control Overview" href="../overview/index.html"/> <link rel="prev" title="Caching Proxies" href="caching_proxies.html"/> @@ -83,7 +83,7 @@ <li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li> <li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li> <li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li> -<li class="toctree-l2 current"><a class="current reference internal" href="">Cache Control Headers and Revalidation</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="#">Cache Control Headers and Revalidation</a></li> </ul> </li> </ul> @@ -102,12 +102,15 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../admin/index.html">Administrator’s Guide</a><ul> -<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_install.html">Installing Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_using.html">Using Traffic Ops</a></li> -<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_portal.html">Traffic Portal Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor.html">Traffic Monitor Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="../admin/traffic_monitor_golang.html">Traffic Monitor Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_router.html">Traffic Router Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_stats.html">Traffic Stats Administration</a></li> <li class="toctree-l2"><a class="reference internal" href="../admin/traffic_server.html">Traffic Server Administration</a></li> @@ -118,10 +121,12 @@ </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/building.html">Building Traffic Control</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_ops.html">Traffic Ops</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_portal.html">Traffic Portal</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_router.html">Traffic Router</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../development/traffic_monitor_golang.html">Traffic Monitor Golang</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_stats.html">Traffic Stats</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/traffic_server.html">Traffic Server</a></li> </ul> @@ -159,7 +164,7 @@ <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> - <li><a href="../index.html">Traffic Control master</a> »</li> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> <li><a href="index.html">CDN Basics</a> »</li> @@ -187,49 +192,49 @@ <div class="section" id="cache-control-headers-and-revalidation"> <span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">¶</a></h1> <p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 14 Dec 2014 23:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Cache-Control: max-age=86400 -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">86400</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> <p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</spa n> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p> -<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1 -If-None-Match: "1aa008f-2d-50a3559482cc0" -Host: www.origin.com +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> +<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> <p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p> -<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK -Date: Sun, 18 Dec 2014 3:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50aa00feadd" -Cache-Control: max-age=604800 -Content-Length: 49 -Connection: close -Content-Type: text/html; charset=UTF-8 - -<html><body>This is NOT a fun file</body></html> +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50aa00feadd"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">49</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> + +<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span> </pre></div> </div> <p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p> -<div class="highlight-python"><div class="highlight"><pre>304 Not Modified -Date: Sun, 18 Dec 2014 3:22:44 GMT -Server: Apache/2.2.15 (Red Hat) -Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT -ETag: "1aa008f-2d-50a3559482cc0" -Cache-Control: max-age=604800 -Content-Length: 45 -Connection: close -Content-Type: text/html; charset=UTF-8 +<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span> +<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span> +<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span> +<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span> +<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span> +<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span> +<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span> +<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span> </pre></div> </div> <p>Note that the 304 response only has headers, not the data.</p> @@ -273,10 +278,11 @@ Content-Type: text/html; charset=UTF-8 <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', - VERSION:'master', + VERSION:'2.1-dev', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '' }; </script> <script type="text/javascript" src="../_static/jquery.js"></script>