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_r246023323
########## File path: docs/source/admin/traffic_ops/using.rst ########## @@ -541,6 +542,50 @@ 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. +.. index:: + Raw Remap Text + +.. _raw-remap-text: + +ANY_MAP Raw Remap Text +---------------------- +The Raw Remap Text may contain the following special strings that will be replaced by traffic_ops_ort.pl at the edge and mid levels: + ++---------------------+--------------------------------------+ +| 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 hostname) | ++---------------------+--------------------------------------+ +| __SERVER_TCP_PORT__ | Server TCP incoming port number | ++---------------------+--------------------------------------+ +| __RETURN__ | A newline | ++---------------------+--------------------------------------+ + +The ##OVERRIDE## special string was added to allow an ANY_MAP rule to override another Delivery Service's remap rule, implemented inside traffic_ops_ort.pl. The original remap rule is commented out with an ##OVERRIDDEN## prefix and the ##OVERRIDE## rule is activated in its place. + +.. Note:: The from endpoint must exactly match for this to properly work (ie: trailing url '/'), otherwise ATS may fail to initialize or reload while processing remap.config. Review comment: 'ATS' is an abbreviation; if it's expanded previously in the section this could be left alone, but it isn't. The preferred way is to decorate it with the `abbr` role, but it would also be acceptable to place the expansion followed by the abbreviation in parenthesis. Example: ```rst :abbr:`ATS (Apache Traffic Server)` is the preferred abbreviation method (especially since this isn't the abbreviation's first appearance in the section) but "Apache Traffic Server (ATS)" could also be used. ``` I'd also argue that this is more of a `warning` than a `note`, but that's really up to your preference. ---------------------------------------------------------------- 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
