Update docs from commit 37133ca2a21a8476958a8f52ddd609fac5aefbb7
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/e0650364 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/e0650364 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/e0650364 Branch: refs/heads/asf-site Commit: e0650364230c08d106e06d06deb120b6f5d592d4 Parents: 064f20d Author: jenkins <bui...@apache.org> Authored: Mon Feb 12 15:40:07 2018 +0000 Committer: jenkins <bui...@apache.org> Committed: Mon Feb 12 15:40:07 2018 +0000 ---------------------------------------------------------------------- docs/master/_images/mso-enable.png | Bin 107805 -> 124819 bytes .../admin/quick_howto/multi_site.rst.txt | 50 ++++--------- docs/master/admin/quick_howto/multi_site.html | 70 ++++++------------- docs/master/searchindex.js | 2 +- 4 files changed, 36 insertions(+), 86 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/e0650364/docs/master/_images/mso-enable.png ---------------------------------------------------------------------- diff --git a/docs/master/_images/mso-enable.png b/docs/master/_images/mso-enable.png index 9932de1..70207ba 100644 Binary files a/docs/master/_images/mso-enable.png and b/docs/master/_images/mso-enable.png differ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/e0650364/docs/master/_sources/admin/quick_howto/multi_site.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/admin/quick_howto/multi_site.rst.txt b/docs/master/_sources/admin/quick_howto/multi_site.rst.txt index bd4807d..270efc2 100644 --- a/docs/master/_sources/admin/quick_howto/multi_site.rst.txt +++ b/docs/master/_sources/admin/quick_howto/multi_site.rst.txt @@ -57,45 +57,12 @@ Configure Multi Site Origin 4) This OFQDN must be valid - ATS will perform a DNS lookup on this FQDN even if IPs, not DNS, are used in the parent.config. 5) The OFQDN entered as the "Origin Server Base URL" will be sent to the origins as a host header. All origins must be configured to respond to this host. -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) For ATS 5.x, configure the mid hdr_rewrite on the delivery service, example: :: +6) For ATS 5.x, 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) As of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See `ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html>` for more details. These parameters are now handled by the creation of a delivery service profile. +7) Create a delivery service profile. This must be done to set the MSO algorithm. Also, as of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See `ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html>` for more details. These parameters are now handled by the creation of a delivery service profile. a) Create a profile of the type DS_PROFILE for the delivery service in question. @@ -114,8 +81,17 @@ b) Click "Show profile parameters" to bring up the parameters screen for the pro | mso.parent_retry | parent.config | simple_retry, both, | parent_retry | | | | unavailable_server_retry | | +----------------------------------------+------------------+--------------------------+-------------------------+ -| mso.unavailable_server_retry_responses | parent.config | list of server response | | -| | | codes, eg "500,502,503" | | +| mso.unavailable_server_retry_responses | parent.config | list of server response | defaults to the value | +| | | codes, eg "500,502,503" | in records.config | +| | | | when unused. | ++----------------------------------------+------------------+--------------------------+-------------------------+ +| mso.max_simple_retries | parent.config | Nubmer of retries made | defaults to the value | +| | | after a 4xx error | in records.config | +| | | | when unused. | ++----------------------------------------+------------------+--------------------------+-------------------------+ +| mso.max_unavailable_server_retries | parent.config | Nubmer of retries made | defaults to the value | +| | | after a 5xx error | in records.config | +| | | | when unused. | +----------------------------------------+------------------+--------------------------+-------------------------+ http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/e0650364/docs/master/admin/quick_howto/multi_site.html ---------------------------------------------------------------------- diff --git a/docs/master/admin/quick_howto/multi_site.html b/docs/master/admin/quick_howto/multi_site.html index 2748be2..e9211d7 100644 --- a/docs/master/admin/quick_howto/multi_site.html +++ b/docs/master/admin/quick_howto/multi_site.html @@ -214,7 +214,7 @@ <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> +<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: 1636.0px; height: 1005.0px;" /></a> <ol class="arabic simple" start="5"> <li>Assign the org servers to the delivery service that will have the multi site feature. Org servers assigned to a delivery service with multi-site checked will be assigned to be the origin servers for this DS.</li> </ol> @@ -228,57 +228,13 @@ 4) This OFQDN must be valid - ATS will perform a DNS lookup on this FQDN even if IPs, not DNS, are used in the parent.config. 5) The OFQDN entered as the “Origin Server Base URL” will be sent to the origins as a host header. All origins must be configured to respond to this host.</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"> +<ol class="arabic" start="6"> <li><p class="first">For ATS 5.x, 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">As of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See <cite>ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html></cite> for more details. These parameters are now handled by the creation of a delivery service profile.</p> +<li><p class="first">Create a delivery service profile. This must be done to set the MSO algorithm. Also, as of ATS 6.x, multi-site options must be set as parameters within the parent.config. Header rewrite parameters will be ignored. See <cite>ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html></cite> for more details. These parameters are now handled by the creation of a delivery service profile.</p> </li> </ol> <ol class="loweralpha simple"> @@ -319,7 +275,25 @@ unavailable_server_retry</td> <td>parent.config</td> <td>list of server response codes, eg “500,502,503”</td> -<td> </td> +<td>defaults to the value +in records.config +when unused.</td> +</tr> +<tr class="row-odd"><td>mso.max_simple_retries</td> +<td>parent.config</td> +<td>Nubmer of retries made +after a 4xx error</td> +<td>defaults to the value +in records.config +when unused.</td> +</tr> +<tr class="row-even"><td>mso.max_unavailable_server_retries</td> +<td>parent.config</td> +<td>Nubmer of retries made +after a 5xx error</td> +<td>defaults to the value +in records.config +when unused.</td> </tr> </tbody> </table>
