zrhoffman commented on a change in pull request #6013:
URL: https://github.com/apache/trafficcontrol/pull/6013#discussion_r668172976
##########
File path: docs/source/api/v4/deliveryservices_id.rst
##########
@@ -224,8 +222,6 @@ Response Structure
:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on
this :term:`Delivery Service`
:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
Review comment:
Removing <code>:ref:`ds-longdesc2`</code> and
<code>:ref:`ds-longdesc3`</code> fixes the docs warnings, so it makes sense to
include it in this PR.
##########
File path: docs/source/admin/traffic_server.rst
##########
@@ -119,3 +119,87 @@ Installing the Cache Config Tool
#. If "Rapid Revalidate" is enabled in Traffic Ops, create a second
:manpage:`cron(8)` job for revalidation checks by running :term:`t3c` in
"revalidate" mode. :term:`t3c` 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.
+
+.. _t3c-special-strings:
+
+Strings with Special Meaning to ``t3c``
+"""""""""""""""""""""""""""""""""""""""
+When processing configuration files, if ``traffic_ops_ort`` encounters any of
the strings in the :ref:`Replacement Strings <t3c-replacement-strings>` table
it will perform the indicated replacement. This means that these strings can be
used to create templates in :term:`Profile` :term:`Parameters` and certain
:term:`Delivery Service` configuration fields.
+
+.. _t3c-replacement-strings:
+
+.. table:: Replacement Strings
+
+
+-------------------------+--------------------------------------------------------------------+
+ | String | Replaced With
|
+
+=========================+====================================================================+
+ | ``__CACHE_IPV4__`` | The IPv4 address of the :term:`cache
server` on which ``t3c`` is |
+ | | running.
|
+
+-------------------------+--------------------------------------------------------------------+
+ | ``__FULL_HOSTNAME__`` | The full hostname (i.e. including the full
domain to which it |
+ | | belongs) of the :term:`cache server` on
which ``t3c`` is running. |
+
+-------------------------+--------------------------------------------------------------------+
+ | ``__HOSTNAME__`` | The (short) hostname of the :term:`cache
server` on which ``t3c`` |
+ | | is running.
|
+
+-------------------------+--------------------------------------------------------------------+
+ | ``__RETURN__`` | A newline character (``\\n``).
|
+
+-------------------------+--------------------------------------------------------------------+
+ | ``__SERVER_TCP_PORT__`` | If the :term:`cache server` on which
``t3c`` is being run has a |
+ | | TCP port configured to something besides
``80``, this will be |
+ | | replaced with that TCP port value. *If it*
**is** *set to* |
+ | | *``80``, this string will simply be
removed,* **NOT** *replaced* |
+ | | *with* **ANYTHING**.
|
+
+-------------------------+--------------------------------------------------------------------+
+ | ``##OVERRIDE##`` | This string is only valid in the content of
files named |
+ | | "remap.config". It is further described in
`Remap Override`_ |
+
+-------------------------+--------------------------------------------------------------------+
+
+.. deprecated:: ATCv4.0
+ The use of ``__RETURN__`` in lieu of a true newline character is
(finally) no longer necessary,
+ and the ability to do so will be removed in the future.
+
+.. note:: There is currently no way to indicate that a server's IPv6 address
should be inserted -
+ only IPv4 is supported.
+
+.. _t3c-remap-override:
+
+Remap Override
+""""""""""""""
+.. warning:: The ANY_MAP ``##OVERRIDE##`` special string is a temporary
solution and will be
+ deprecated once Delivery Service Versioning is implemented. For this
reason it is suggested that
+ it not be used unless absolutely necessary.
+
+The ``##OVERRIDE##`` template string allows the :term:`Delivery Service`
:ref:`ds-raw-remap` field
+to override to fully override the :term:`Delivery Service`'s line in the
+`remap.config ATS configuration file
<https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/remap.config.en.html>`_,
Review comment:
ATS 7 is not a supported version according to
https://trafficserver.apache.org/downloads, this should link to 8.1.x.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
