This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 12e019d73a For delivery service parameter docs explain parent_retry
deprecation (#7120)
12e019d73a is described below
commit 12e019d73ab55ee2e398122989bfa75f435e1b03
Author: Brian Olsen <[email protected]>
AuthorDate: Fri Dec 16 09:03:17 2022 -0700
For delivery service parameter docs explain parent_retry deprecation (#7120)
* For parent_retry docs explain parent_retry deprecation
* remove warning about simple retries not doing anything
* update changelog
* doc format updates
* more doc fixes
---
CHANGELOG.md | 1 +
docs/source/admin/quick_howto/multi_site.rst | 15 ++++++++------
docs/source/overview/delivery_services.rst | 31 +++++++++++++++++-----------
3 files changed, 29 insertions(+), 18 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ef0f6f2044..4429531560 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -31,6 +31,7 @@ The format is based on [Keep a
Changelog](http://keepachangelog.com/en/1.0.0/).
- [#7191](https://github.com/apache/trafficcontrol/issues/7191)
*tc-health-client* Uses Traffic Ops API 4.0. Also added reload option to
systemd service file
- [#4654](https://github.com/apache/trafficcontrol/pull/4654) *Traffic Ops,
Traffic Portal* Switched Delivery Service active state to a three-value system,
adding a state that will be used to prevent cache servers from deploying DS
configuration.
- [#7242](https://github.com/apache/trafficcontrol/pull/7242) *Traffic Portal*
Now depends on NodeJS version 18 or later.
+- [#7120](https://github.com/apache/trafficcontrol/pull/7120) *Docs* Update
t3c documentation regarding parent.config parent_retry.
### Fixed
- [#6229](https://github.com/apache/trafficcontrol/issues/6229) *Traffic Ops*
Fixed error message for assignment of non-existent parameters to a profile.
diff --git a/docs/source/admin/quick_howto/multi_site.rst
b/docs/source/admin/quick_howto/multi_site.rst
index 5e64937ec8..6f5233a42a 100644
--- a/docs/source/admin/quick_howto/multi_site.rst
+++ b/docs/source/admin/quick_howto/multi_site.rst
@@ -75,21 +75,24 @@ The following steps will take you through the procedure of
setting up an :abbr:`
| | |
consistent_hash | |
+-----------------------------------------+------------------+--------------------------+-------------------------+
| last.parent_retry | parent.config |
simple_retry, both, | parent_retry |
- | | |
unavailable_server_retry | |
+ | | |
unavailable_server_retry | (deprecated) |
+-----------------------------------------+------------------+--------------------------+-------------------------+
| last.unavailable_server_retry_responses | parent.config |
list of server response | defaults to the value |
| | |
codes, eg "500,502,503" | in records.config |
| | |
| when unused. |
+-----------------------------------------+------------------+--------------------------+-------------------------+
- | last.max_simple_retries | parent.config |
Nubmer of retries made | defaults to the value |
- | | |
after a 4xx error | in records.config |
+ | last.max_unavailable_server_retries | parent.config |
Number of retries made | defaults to the value |
+ | | |
after specified errors | in records.config |
| | |
| when unused. |
+-----------------------------------------+------------------+--------------------------+-------------------------+
- | last.max_unavailable_server_retries | parent.config |
Nubmer of retries made | defaults to the value |
- | | |
after a 5xx error | in records.config |
+ | last.simple_server_retry_responses | parent.config |
list of server response | defaults to the value |
+ | | |
codes, eg "404" | in records.config |
+ | | |
| when unused. |
+
+-----------------------------------------+------------------+--------------------------+-------------------------+
+ | last.max_simple_retries | parent.config |
Nubmer of retries made | defaults to the value |
+ | | |
after specified errors | in records.config |
| | |
| when unused. |
+-----------------------------------------+------------------+--------------------------+-------------------------+
-
.. figure:: multi_site/ds_profile_parameters.png
:scale: 100%
diff --git a/docs/source/overview/delivery_services.rst
b/docs/source/overview/delivery_services.rst
index 673dc4963e..0898ad0f7f 100644
--- a/docs/source/overview/delivery_services.rst
+++ b/docs/source/overview/delivery_services.rst
@@ -1061,8 +1061,8 @@ The following :term:`Parameters` must have the
:ref:`Config File <parameter-conf
- ``merge_parent_groups`` - on a Deliver Service :term:`Profile`, if this
exists, moves each of the space-separated :term:`Cache Groups` named in the
:ref:`parameter-value` from the secondary parent list into the primary parent
list. This can be used to combine all parents into a single consistent hash
ring.
- .. deprecated:: ATCv6.2
- In :ref:`to-api` version 4, TLS versions should be configured
using the `TLS Versions`_ property of the Delivery Service, and support for
this :term:`Parameter` will be removed at some point after the stabilization of
:ref:`to-api` version 4.
+.. deprecated:: 6.2
+ In :ref:`to-api` version 4, TLS versions should be configured using the
`TLS Versions`_ property of the Delivery Service, and support for this
:term:`Parameter` will be removed at some point after the stabilization of
:ref:`to-api` version 4.
Parameters that Affect Multi-Site Origin and Parent Down Behavior
'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
@@ -1073,6 +1073,7 @@ Each :term:`Parameter` directly corresponds to a field in
a line of the :abbr:`A
.. _max_unavailable_server_retries:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-max-unavailable-server-retries
.. _parent_retry:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-parent-retry
.. _unavailable_server_retry_responses:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-unavailable-server-retry-responses
+.. _simple_server_retry_responses:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-simple-server-retry-responses
.. _parent.config:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html
.. _parent:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-parent
.. _secondary_parent:
https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html#parent-config-format-secondary-parent
@@ -1087,27 +1088,33 @@ Each :term:`Parameter` directly corresponds to a field
in a line of the :abbr:`A
| algorithm | `round_robin`_
| Sets the algorithm used to determine from
which :term:`origin server` content will |
| |
| be requested.
|
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | max_simple_retries | `max_simple_retries`_
| Sets a strict limit on the number of "simple
retries" allowed before giving up |
-
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | max_unavailable_server_retries |
`max_unavailable_server_retries`_ | Sets a strict
limit on the number of times the :term:`cache server` will attempt to |
- | |
| request content from an :term:`origin server`
that has previously been considered |
- | |
| "unavailable".
|
-
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
| parent_retry | `parent_retry`_
| Sets whether the :term:`cache servers` will
use "simple retries", |
- | |
| "unavailable server retries", or both.
|
+ | |
| "unavailable server retries", or both.
(deprecated) |
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
- | simple_retry_response_codes | **UNKNOWN**
| **UNKNOWN** - supposedly defines HTTP response
codes from an :term:`origin server` |
+ | simple_server_retry_responses |
`simple_server_retry_responses`_ | Defines HTTP
response codes for an :term:`origin server |
| |
| that necessitate a "simple retry".
|
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
+ | max_simple_retries | `max_simple_retries`_
| Sets a strict limit on the number of "simple
retries" allowed before giving up |
+
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
| unavailable_server_retry_response_codes |
`unavailable_server_retry_responses`_ | Defines HTTP
response codes from an :term:`origin server` that indicate it is |
| |
| currently "unavailable".
|
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
+ | max_unavailable_server_retries |
`max_unavailable_server_retries`_ | Sets a strict
limit on the number of times the :term:`cache server` will attempt to |
+ | |
| request content from an :term:`origin server`
that has previously been considered |
+ | |
| "unavailable".
|
+
+-----------------------------------------+------------------------------------------------------------+-------------------------------------------------------------------------------------+
The above :term:`Parameters` are supported for ``first``, ``inner`` and
``last`` tiers by specifying prefixes ``first.``, ``inner.`` and ``last.``,
applicable to both topology and non topology. This allows fine tuning of
marking parents "down" and retry behavior inside a CDN.
-.. deprecated:: The ``mso.`` prefix is deprecated. ``last.`` prefix should be
preferred although no prefix can also be used.
+.. deprecated:: 7.0
+ The ``mso.`` prefix is deprecated. ``last.`` prefix should be
preferred although no prefix can also be used.
+
+.. deprecated:: 7.0
+ The `parent_retry` parameters are now inferred from the `simple retry`
and `unavailable server retry` parameters. To disable "simple retries" for a
:term:`Profile`, set the Value of its ``max_simple_retries`` :term:`Parameter`
to ``0``, and the Value of its ``max_simple_retry_responses`` :term:`Parameter`
to an empty string. "Unavailable server retries" may disabled in much the same
way, using the analogous :term:`Parameters`.
-.. warning:: The `simple_retry_response_codes`` :term:`Parameter` has no
apparent, possible use according to the :abbr:`ATS (Apache Traffic Server)`
`parent.config documentation
<https://docs.trafficserver.apache.org/en/9.1.x/admin-guide/files/parent.config.en.html>`_.
Whether or not it has any effect - let alone the *intended* effect - is not
known, and its use is therefore strongly discouraged.
+.. impl-detail:: With Apache Traffic Server 8.1.x the
``simple_retry_response_codes`` setting is not available.
+.. impl-detail:: With Apache Traffic Server 9.1.x
``unavailable_server_retry_response_codes`` are limited to 5xx responses and
``simple_retry_response_codes`` are limited to 4xx.
+.. impl-detail:: Apache Traffic Server 9.2.x allows more flexibility with 4xx
and 5xx codes available for use with ``simple_retry_response_codes``.
.. seealso:: To see how the :ref:`Values <parameter-value>` of these
Parameters are interpreted, refer to the `Apache Traffic Server documentation
on the parent.config configuration file
<https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/parent.config.en.html>`_
