Update docs from commit 09aaab5d91234780f410f6c8179d64907e9519ac
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/8b1ce2ea Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/8b1ce2ea Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/8b1ce2ea Branch: refs/heads/asf-site Commit: 8b1ce2ea4ca2405c31156c798ca8f7dbf0ef79c5 Parents: 4914c3a Author: jenkins <bui...@apache.org> Authored: Tue Mar 13 19:52:14 2018 +0000 Committer: jenkins <bui...@apache.org> Committed: Tue Mar 13 19:52:14 2018 +0000 ---------------------------------------------------------------------- .../D22DCAA3-18CC-48F4-965B-5312993F9820.png | Bin 0 -> 99921 bytes docs/master/_images/mso-rank.png | Bin 0 -> 140070 bytes docs/master/_images/tp_bottom_menu.png | Bin 0 -> 2345 bytes .../admin/quick_howto/multi_site_ats5.rst.txt | 95 +++++ .../_sources/admin/traffic_portal.rst.txt | 51 +++ docs/master/_static/favicon.ico | Bin 1150 -> 16958 bytes .../admin/quick_howto/multi_site_ats5.html | 369 +++++++++++++++++++ docs/master/admin/quick_howto/steering.html | 6 +- docs/master/admin/traffic_portal.html | 322 ++++++++++++++++ docs/master/development/index.html | 6 +- docs/master/development/traffic_ops.html | 2 +- docs/master/searchindex.js | 2 +- 12 files changed, 845 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png ---------------------------------------------------------------------- diff --git a/docs/master/_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png b/docs/master/_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png new file mode 100644 index 0000000..59d5b8e Binary files /dev/null and b/docs/master/_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_images/mso-rank.png ---------------------------------------------------------------------- diff --git a/docs/master/_images/mso-rank.png b/docs/master/_images/mso-rank.png new file mode 100644 index 0000000..de80ac5 Binary files /dev/null and b/docs/master/_images/mso-rank.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_images/tp_bottom_menu.png ---------------------------------------------------------------------- diff --git a/docs/master/_images/tp_bottom_menu.png b/docs/master/_images/tp_bottom_menu.png new file mode 100644 index 0000000..7733d27 Binary files /dev/null and b/docs/master/_images/tp_bottom_menu.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_sources/admin/quick_howto/multi_site_ats5.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/admin/quick_howto/multi_site_ats5.rst.txt b/docs/master/_sources/admin/quick_howto/multi_site_ats5.rst.txt new file mode 100644 index 0000000..570e844 --- /dev/null +++ b/docs/master/_sources/admin/quick_howto/multi_site_ats5.rst.txt @@ -0,0 +1,95 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _rl-multi-site-origin-qht-ats5: + +********************************* +Configure Multi Site Origin (5.x) +********************************* + +1) 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): + +.. image:: C5C4CD22-949A-48FD-8976-C673083E2177.png + :scale: 100% + :align: center + +2) Create a profile to assign to each of the origins: + +.. image:: 19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png + :scale: 100% + :align: center + +3) Create server entries for the origination vips: + +.. image:: D28614AA-9758-45ED-9EFD-3A284FC4218E.png + :scale: 100% + :align: center + +4) Check the multi-site check box in the delivery service screen: + +.. image:: mso-enable.png + :scale: 100% + :align: center + +5) Assign the org servers to the delivery service that will have the multi site feature: + +.. image:: 066CEF4F-C1A3-4A89-8B52-4F72B0531367.png + :scale: 100% + :align: center + +.. Note:: âOrigin Server Base URLâ uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that âOrigin Server Base URLâ (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are: + 1) If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured. + 2) If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN. + 3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN. + +6) Select an option from the "Multi Site Origin Algorithm" drop-down list. Four MSO algorithms are supported: + ++------------------+--------------------------------------------------------------------------------------------------------------------+ +| Option | Description | ++==================+====================================================================================================================+ +| Consistent hash | Origin server selection is based on the consistent hash of requested URLs. | ++------------------+--------------------------------------------------------------------------------------------------------------------+ +| Primary/back | 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 | +| | 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. | ++------------------+--------------------------------------------------------------------------------------------------------------------+ +| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, | +| round-robin | origin server 2 serves the second request, and so on. | ++------------------+--------------------------------------------------------------------------------------------------------------------+ +| IP based | MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache. | +| round-robin | | ++------------------+--------------------------------------------------------------------------------------------------------------------+ + +7) 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. + +.. image:: mso-rank.png + :scale: 60% + :align: center + +8) Assign the parent.config location parameter to the MID profile: + +.. image:: D22DCAA3-18CC-48F4-965B-5312993F9820.png + :scale: 100% + :align: center + + +9) Configure the mid hdr_rewrite on the delivery service, example: :: + + cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__ + +10) Turn on parent_proxy_routing in the MID profile. http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_sources/admin/traffic_portal.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/admin/traffic_portal.rst.txt b/docs/master/_sources/admin/traffic_portal.rst.txt new file mode 100644 index 0000000..ea7a303 --- /dev/null +++ b/docs/master/_sources/admin/traffic_portal.rst.txt @@ -0,0 +1,51 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +***************************** +Traffic Portal Administration +***************************** +The following are requirements to ensure an accurate set up: + +* CentOS 6.7 or 7 +* Node.js 6.0.x or above + +**Installing Traffic Portal** + + - Download the Traffic Portal RPM from `Apache Jenkins <https://builds.apache.org/view/S-Z/view/TrafficControl/job/incubator-trafficcontrol-master-build/>`_ or build from source (./pkg traffic_portal_build). + - Copy the Traffic Portal RPM to your server + - curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash - + - sudo yum install -y nodejs + - sudo yum install -y <traffic_portal rpm> + +**Configuring Traffic Portal** + + - update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew) + - update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew) + - [OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin) + +**Starting Traffic Portal** + + - sudo service traffic_portal start + +**Stopping Traffic Portal** + + - sudo service traffic_portal stop + + + + + + + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/_static/favicon.ico ---------------------------------------------------------------------- diff --git a/docs/master/_static/favicon.ico b/docs/master/_static/favicon.ico index a2e49cc..b0a7633 100644 Binary files a/docs/master/_static/favicon.ico and b/docs/master/_static/favicon.ico differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/admin/quick_howto/multi_site_ats5.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/quick_howto/multi_site_ats5.html b/docs/master/admin/quick_howto/multi_site_ats5.html new file mode 100644 index 0000000..240e644 --- /dev/null +++ b/docs/master/admin/quick_howto/multi_site_ats5.html @@ -0,0 +1,369 @@ + + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Configure Multi Site Origin (5.x) — Traffic Control 2.1-dev documentation </title> + + + + + <link rel="shortcut icon" href="../../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../../genindex.html"/> + <link rel="search" title="Search" href="../../search.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../../index.html"/> + <link rel="up" title="Quick How To Guides" href="index.html"/> + <link rel="next" title="Configure DNSSEC" href="dnssec.html"/> + <link rel="prev" title="Configure Multi Site Origin" href="multi_site.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Administrator’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="../traffic_ops/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"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2 current"><a class="reference internal" href="index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../development/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> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../../index.html">Traffic Control 2.1-dev</a> »</li> + + <li><a href="../index.html">Administrator’s Guide</a> »</li> + + <li><a href="index.html">Quick How To Guides</a> »</li> + + <li>Configure Multi Site Origin (5.x)</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/admin/quick_howto/multi_site_ats5.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="dnssec.html" class="btn btn-neutral float-right" title="Configure DNSSEC">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="configure-multi-site-origin-5-x"> +<span id="rl-multi-site-origin-qht-ats5"></span><h1>Configure Multi Site Origin (5.x)<a class="headerlink" href="#configure-multi-site-origin-5-x" 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> +</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"> +<li>Create a profile to assign to each of the origins:</li> +</ol> +<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" style="width: 1470.0px; height: 219.0px;" /></a> +<ol class="arabic simple" start="3"> +<li>Create server entries for the origination vips:</li> +</ol> +<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" style="width: 1468.0px; height: 166.0px;" /></a> +<ol class="arabic simple" start="4"> +<li>Check the multi-site check box in the delivery service screen:</li> +</ol> +<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1695.0px; height: 1079.0px;" /></a> +<ol class="arabic simple" start="5"> +<li>Assign the org servers to the delivery service that will have the multi site feature:</li> +</ol> +<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" style="width: 580.0px; height: 343.0px;" /></a> +<div class="admonition note"> +<p class="first admonition-title">Note</p> +<p class="last">âOrigin Server Base URLâ uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that âOrigin Server Base URLâ (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are: +1) If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured. +2) If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN. +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> +</ol> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="87%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Option</th> +<th class="head">Description</th> +</tr> +</thead> +<tbody valign="top"> +<tr class="row-even"><td>Consistent hash</td> +<td>Origin server selection is based on the consistent hash of requested URLs.</td> +</tr> +<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 +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> +</tr> +<tr class="row-even"><td>Strict +round-robin</td> +<td>MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, +origin server 2 serves the second request, and so on.</td> +</tr> +<tr class="row-odd"><td>IP based +round-robin</td> +<td>MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache.</td> +</tr> +</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 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"> +<li>Assign the parent.config location parameter to the MID profile:</li> +</ol> +<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 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> +<li><p class="first">Turn on parent_proxy_routing in the MID profile.</p> +</li> +</ol> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="dnssec.html" class="btn btn-neutral float-right" title="Configure DNSSEC">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="multi_site.html" class="btn btn-neutral" title="Configure Multi Site Origin"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'2.1-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../../_static/jquery.js"></script> + <script type="text/javascript" src="../../_static/underscore.js"></script> + <script type="text/javascript" src="../../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/admin/quick_howto/steering.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/quick_howto/steering.html b/docs/master/admin/quick_howto/steering.html index 0939796..6a5cada 100644 --- a/docs/master/admin/quick_howto/steering.html +++ b/docs/master/admin/quick_howto/steering.html @@ -40,7 +40,7 @@ <link rel="search" title="Search" href="../../search.html"/> <link rel="top" title="Traffic Control 2.2-dev documentation" href="../../index.html"/> <link rel="up" title="Quick How To Guides" href="index.html"/> - <link rel="next" title="Delivery Service Requests" href="ds_requests.html"/> + <link rel="next" title="Developerâs Guide" href="../../development/index.html"/> <link rel="prev" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/> @@ -189,7 +189,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="ds_requests.html" class="btn btn-neutral float-right" title="Delivery Service Requests">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developerâs Guide">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a> @@ -293,7 +293,7 @@ <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="ds_requests.html" class="btn btn-neutral float-right" title="Delivery Service Requests">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="../../development/index.html" class="btn btn-neutral float-right" title="Developerâs Guide">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="regionalgeo.html" class="btn btn-neutral" title="Configure Regional Geo-blocking (RGB)"><span class="fa fa-arrow-circle-left"></span> Previous</a> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/admin/traffic_portal.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/traffic_portal.html b/docs/master/admin/traffic_portal.html new file mode 100644 index 0000000..86a3cf2 --- /dev/null +++ b/docs/master/admin/traffic_portal.html @@ -0,0 +1,322 @@ + + + + +<!DOCTYPE html> +<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> +<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + + <title>Traffic Portal Administration — Traffic Control 2.1-dev documentation </title> + + + + + <link rel="shortcut icon" href="../_static/favicon.ico"/> + + + + + + + + + + + + + <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> + + + + <link rel="stylesheet" href="../_static/theme_overrides.css" type="text/css" /> + + + + <link rel="index" title="Index" + href="../genindex.html"/> + <link rel="search" title="Search" href="../search.html"/> + <link rel="top" title="Traffic Control 2.1-dev documentation" href="../index.html"/> + <link rel="up" title="Administratorâs Guide" href="index.html"/> + <link rel="next" title="Traffic Monitor Administration (Legacy)" href="traffic_monitor.html"/> + <link rel="prev" title="Managing Traffic Ops Extensions" href="traffic_ops/extensions.html"/> + + + <script src="_static/js/modernizr.min.js"></script> + +</head> + +<body class="wy-body-for-nav" role="document"> + + <div class="wy-grid-for-nav"> + + + <nav data-toggle="wy-nav-shift" class="wy-nav-side"> + <div class="wy-side-nav-search"> + + + + <a href="/" class="icon icon-home"> Traffic Control + + + + + <img src="../_static/tc_logo_c_only.png" class="logo" /> + + </a> + + +<div role="search"> + <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> + <input type="text" name="q" placeholder="Search docs" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> +</div> + + + </div> + + <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> + + + + <ul> +<li class="toctree-l1"><a class="reference internal" href="../basics/index.html">CDN Basics</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../basics/content_delivery_networks.html">Content Delivery Networks</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/http_11.html">HTTP 1.1</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/caching_proxies.html">Caching Proxies</a></li> +<li class="toctree-l2"><a class="reference internal" href="../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../overview/index.html">Traffic Control Overview</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../overview/introduction.html">Introduction</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_ops.html">Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_portal.html">Traffic Portal</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_router.html">Traffic Router</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_monitor.html">Traffic Monitor</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_stats.html">Traffic Stats</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_server.html">Traffic Server</a></li> +<li class="toctree-l2"><a class="reference internal" href="../overview/traffic_vault.html">Traffic Vault</a></li> +</ul> +</li> +</ul> +<ul class="current"> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="traffic_ops/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 current"><a class="current reference internal" href="#">Traffic Portal Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration (Legacy)</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"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li> +<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../development/index.html">Developer’s Guide</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../development/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> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../faq/index.html">FAQ</a><ul> +<li class="toctree-l2"><a class="reference internal" href="../faq/general.html">General</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/development.html">Development</a></li> +<li class="toctree-l2"><a class="reference internal" href="../faq/administration.html">Running a Traffic Control CDN</a></li> +</ul> +</li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li> +</ul> + + + + </div> + + </nav> + + <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> + + + <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="../index.html">Traffic Control</a> + </nav> + + + + <div class="wy-nav-content"> + <div class="rst-content"> + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> + <li><a href="../index.html">Traffic Control 2.1-dev</a> »</li> + + <li><a href="index.html">Administrator’s Guide</a> »</li> + + <li>Traffic Portal Administration</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../_sources/admin/traffic_portal.rst.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration (Legacy)">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_ops/extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="traffic-portal-administration"> +<h1>Traffic Portal Administration<a class="headerlink" href="#traffic-portal-administration" title="Permalink to this headline">¶</a></h1> +<p>The following are requirements to ensure an accurate set up:</p> +<ul class="simple"> +<li>CentOS 6.7 or 7</li> +<li>Node.js 6.0.x or above</li> +</ul> +<p><strong>Installing Traffic Portal</strong></p> +<blockquote> +<div><ul class="simple"> +<li>Download the Traffic Portal RPM from <a class="reference external" href="https://builds.apache.org/view/S-Z/view/TrafficControl/job/incubator-trafficcontrol-master-build/">Apache Jenkins</a> or build from source (./pkg traffic_portal_build).</li> +<li>Copy the Traffic Portal RPM to your server</li> +<li>curl –silent –location <a class="reference external" href="https://rpm.nodesource.com/setup_6.x">https://rpm.nodesource.com/setup_6.x</a> | sudo bash -</li> +<li>sudo yum install -y nodejs</li> +<li>sudo yum install -y <traffic_portal rpm></li> +</ul> +</div></blockquote> +<p><strong>Configuring Traffic Portal</strong></p> +<blockquote> +<div><ul class="simple"> +<li>update /etc/traffic_portal/conf/config.js (if upgrade, reconcile config.js with config.js.rpmnew and then delete config.js.rpmnew)</li> +<li>update /opt/traffic_portal/public/traffic_portal_properties.json (if upgrade, reconcile traffic_portal_properties.json with traffic_portal_properties.json.rpmnew and then delete traffic_portal_properties.json.rpmnew)</li> +<li>[OPTIONAL] update /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)</li> +</ul> +</div></blockquote> +<p><strong>Starting Traffic Portal</strong></p> +<blockquote> +<div><ul class="simple"> +<li>sudo service traffic_portal start</li> +</ul> +</div></blockquote> +<p><strong>Stopping Traffic Portal</strong></p> +<blockquote> +<div><ul class="simple"> +<li>sudo service traffic_portal stop</li> +</ul> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="traffic_monitor.html" class="btn btn-neutral float-right" title="Traffic Monitor Administration (Legacy)">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="traffic_ops/extensions.html" class="btn btn-neutral" title="Managing Traffic Ops Extensions"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + + <hr/> + + <div role="contentinfo"> + <p> + </p> + </div> + Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. + +</footer> + + </div> + </div> + + </section> + + </div> + + + + <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions"> + <span class="rst-current-version" data-toggle="rst-current-version"> + <span class="fa fa-book">Apache Traffic Control (Incubating)</span> + v: + <span class="fa fa-caret-down"></span> + </span> + <div class="rst-other-versions"> + <dl> + <dt>Versions</dt> + <dd><a href="/docs/master/">latest</a></dd> + <dd><a href="/docs/2.0/">2.0</a></dd> + <dd><a href="/docs/1.8.1/">1.8</a></dd> + <dd><a href="/docs/1.7.0/">1.7</a></dd> + </dl> + <hr/> + Free document hosting provided by <a href="http://www.readthedocs.org">Read the Docs</a>. + + </div> + </div> + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../', + VERSION:'2.1-dev', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + + + + + + <script type="text/javascript" src="../_static/js/theme.js"></script> + + + + + <script type="text/javascript"> + jQuery(function () { + SphinxRtdTheme.StickyNav.enable(); + }); + </script> + + +</body> +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/development/index.html ---------------------------------------------------------------------- diff --git a/docs/master/development/index.html b/docs/master/development/index.html index 3c066a3..1f751cf 100644 --- a/docs/master/development/index.html +++ b/docs/master/development/index.html @@ -40,7 +40,7 @@ <link rel="search" title="Search" href="../search.html"/> <link rel="top" title="Traffic Control 2.2-dev documentation" href="../index.html"/> <link rel="next" title="Building Traffic Control" href="building.html"/> - <link rel="prev" title="Delivery Service Requests" href="../admin/quick_howto/ds_requests.html"/> + <link rel="prev" title="Configure Delivery Service Steering" href="../admin/quick_howto/steering.html"/> <script src="_static/js/modernizr.min.js"></script> @@ -187,7 +187,7 @@ <a href="building.html" class="btn btn-neutral float-right" title="Building Traffic Control">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../admin/quick_howto/ds_requests.html" class="btn btn-neutral" title="Delivery Service Requests"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../admin/quick_howto/steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -279,7 +279,7 @@ <a href="building.html" class="btn btn-neutral float-right" title="Building Traffic Control">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="../admin/quick_howto/ds_requests.html" class="btn btn-neutral" title="Delivery Service Requests"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="../admin/quick_howto/steering.html" class="btn btn-neutral" title="Configure Delivery Service Steering"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8b1ce2ea/docs/master/development/traffic_ops.html ---------------------------------------------------------------------- diff --git a/docs/master/development/traffic_ops.html b/docs/master/development/traffic_ops.html index a02d582..ad79e88 100644 --- a/docs/master/development/traffic_ops.html +++ b/docs/master/development/traffic_ops.html @@ -486,7 +486,7 @@ Warning: Using a password on the command line interface can be insecure. <p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p> <p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p> <p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p> -<p>A check extension can have a column of <img alt="checkmark" src="../_images/good2.png" />‘s and <img alt="X" src="../_images/bad2.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p> +<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p> <div class="highlight-default"><div class="highlight"><pre><span class="n">Script</span> <span class="n">here</span><span class="o">.</span> </pre></div> </div>