You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2022/07/21 15:10:15 UTC
[GitHub] [trafficcontrol] traeak opened a new pull request, #6978: Add t3c support for __CACHE_DIRECTIVE__ in raw remap text
traeak opened a new pull request, #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
Closes: #ISSUE
Related: #ISSUE
If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
This PR allows the cachekey.so plugin and args to be moved into the raw remap text, similar to the __RANGE_DIRECTIVE__ hack.
This allows custom things like lua scripts to modify the uri path, args, etc before the cachekey is created and set.
<!-- **^ Add meaningful description above** --><hr/>
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this PR.
Feel free to add the name of a tool or script that is affected but not on the list.
-->
- Documentation
- Traffic Control Cache Config (`t3c`, formerly ORT)
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your PR.
If your PR has tests (and most should), provide the steps needed to run the tests.
If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. ->
Take any DS that doesn't have default cachekey values (ie: one that has qstring handling as: "Do not use query string parameters in cache key, but do pass in upstream requests", then add raw remap text with __CACHEKEY_DIRECTIVE__ inside ie:
```
@plugin=tslua.so @pparam=uri-manipulation.lua __CACHEKEY_DIRECTIVE__
```
Ensure that the t3c generated remap.config line has the cachey.so plugin after the tslua.so plugin as expected.
## If this is a bugfix, which Traffic Control versions contained the bug?
<!-- Delete this section if the PR is not a bugfix, or if the bug is only in the master branch.
Examples:
- 5.1.2
- 5.1.3 (RC1)
-->
## PR submission checklist
- [x] This PR has tests <!-- If not, please delete this text and explain why this PR does not need tests. -->
- [x] This PR has documentation <!-- If not, please delete this text and explain why this PR does not need documentation. -->
- [x] This PR has a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should have a changelog entry. -->
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] ocket8888 commented on pull request #6978: Add t3c support for __CACHEKEY_DIRECTIVE__ in raw remap text
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on PR #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978#issuecomment-1191862088
> It isn't replaced in any other locations, like the doc says and like all those other directives are.
That's not strictly true. That section is also appropriate for replacements restricted to a single file, for example the `##OVERRIDE##` description reads:
> This string is only valid in the content of files named “remap.config”.
But looking at the code this isn't just restricted to a single configuration file it's, as you say:
> ... only replaced inside the DS Raw Remap Text...
which I didn't realize right away. So
> This does add docs for the particular DS field it affects. Is that sufficient?
Yes.
> Or if you want, I guess we could add some kind of line to the `the list of strings with special meaning to t3c` doc, "see individual Delivery Service and Server fields for replacements unique to data in those fields" or something?
No, I don't think that's necessary.
> Also removing the low_impact tag, if that's ok.
The point is just that it should have *some* impact level tag. I just took a guess at what that would be but you should absolutely replace it with whichever is more appropriate.
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rob05c commented on pull request #6978: Add t3c support for __CACHEKEY_DIRECTIVE__ in raw remap text
Posted by GitBox <gi...@apache.org>.
rob05c commented on PR #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978#issuecomment-1191657645
@ocket8888 This does add docs for the particular DS field it affects. Is that sufficient?
Or if you want, I guess we could add some kind of line to the `the list of strings with special meaning to t3c` doc, "see individual Delivery Service and Server fields for replacements unique to data in those fields" or something?
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rob05c commented on pull request #6978: Add t3c support for __CACHEKEY_DIRECTIVE__ in raw remap text
Posted by GitBox <gi...@apache.org>.
rob05c commented on PR #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978#issuecomment-1191659234
Also removing the `low_impact` tag, if that's ok. This isn't a lot of code, but it's a pretty big impact, it makes it possible for tenants to do significant things that aren't possible without this.
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rob05c commented on pull request #6978: Add t3c support for __CACHEKEY_DIRECTIVE__ in raw remap text
Posted by GitBox <gi...@apache.org>.
rob05c commented on PR #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978#issuecomment-1191644666
> This should be added to [the list of strings with special meaning to `t3c`](https://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_server.html?highlight=special%20meaning#strings-with-special-meaning-to-t3c).
That doc says
> When processing configuration files, if traffic_ops_ort encounters any of the strings in the [Replacement Strings] table it will perform the indicated replacement. This means that these strings can be used to create templates in [Profile] [Parameters] [Delivery Service] configuration fields.
This isn't true for `__CACHEKEY_DIRECTIVE__`, it's only replaced inside the DS Raw Remap Text, and then further logic will _not_ add the cachekey that would otherwise be added elsewhere. It isn't replaced in any other locations, like the doc says and like all those other directives are.
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [trafficcontrol] rob05c merged pull request #6978: Add t3c support for __CACHEKEY_DIRECTIVE__ in raw remap text
Posted by GitBox <gi...@apache.org>.
rob05c merged PR #6978:
URL: https://github.com/apache/trafficcontrol/pull/6978
--
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: issues-unsubscribe@trafficcontrol.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org