ocket8888 commented on a change in pull request #3140: Add traffic_ops_ort.pl suuport for processing ##OVERRIDE## lines from… URL: https://github.com/apache/trafficcontrol/pull/3140#discussion_r246430426
########## File path: docs/source/admin/traffic_ops/using.rst ########## @@ -541,6 +542,62 @@ The deliveryservice screen also allows you to set the DSCP value of traffic sent .. Note:: The DSCP setting in the UI is *only* for setting traffic towards the client, and gets applied *after* the initial TCP handshake is complete, and the HTTP request is received (before that the cache can't determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked. +.. _raw-remap-text: + +ANY_MAP Raw Remap Text +---------------------- +The Raw Remap Text may contain the following special strings that will be replaced by :program:`traffic_ops_ort` at :abbr:`ATS (Apache Traffic Server)` edge and mid levels in `remap.config <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/remap.config.en.html>`_: + +.. table:: Traffic Ops ORT special strings + + +---------------------+-------------------------------------------------+ + | Traffic Ops Entry | Gets Replaced with | + +=====================+=================================================+ + | __CACHE_IPV4__ | The cache's IPv4 address | + +---------------------+-------------------------------------------------+ + | __HOSTNAME__ | Short hostname (same as ``hostname -s``) | + +---------------------+-------------------------------------------------+ + | __FULL_HOSTNAME__ | Long hostname (same as :manpage:`hostname(1)`) | + +---------------------+-------------------------------------------------+ + | __SERVER_TCP_PORT__ | Server incoming TCP port number | + +---------------------+-------------------------------------------------+ + | __RETURN__ | A newline | + +---------------------+-------------------------------------------------+ + +ANY_MAP ##OVERRIDE## +"""""""""""""""""""" +.. warning:: The ANY_MAP ``##OVERRIDE##`` special string is a temporary solution and will be deprecated once Delivery Service Versioning is implemented. + +A special ``##OVERRIDE##`` string has been added to allow an ANY_MAP rule to override another Delivery Service's remap rule, implemented by :program:`traffic_ops_ort`. When present, the original Delivery Service remap rule is commented out with an ``##OVERRIDDEN##`` prefix and the ``##OVERRIDE##`` rule is activated in its place. + +For example given an :abbr:`ATS (Apache Traffic Server)` `remap.config <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/remap.config.en.html>`_ rule: + +.. code-block:: text + :caption: Example + + map http://from.com/ http://to.com/ + +And ANY_MAP Raw Remap Text override: + +.. code-block:: text + :caption: Example + + ##OVERRIDE## map http://from.com/ http://to.com/ thundering_herd_mitigation.so + +After processing by :program:`traffic_ops_ort` will result in :file:`remap.config` lines as: + +.. code-block:: text + :caption: Example Review comment: These captions should be unique, and once again please use tabs not spaces.. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
