[GitHub] [trafficcontrol] TaylorCFrey opened a new pull request #6332: Add warnings for Content Invalidation creation and documentation

[GitBox <gi...@apache.org>]

TaylorCFrey opened a new pull request #6332:
URL: https://github.com/apache/trafficcontrol/pull/6332


   <!--
   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.
   -->
   
   Closes: #5698
   
   This is an aesthetic change to add information warnings related to Content Invalidation. Specifically, this is to notify a person using this feature that the Origin(s) for the Delivery Service should support IMS and other proper cache invalidation requirements as specified in RFC 7234, Section 4.3.2.
   
   If an origin server were to be misconfigured and only return 200s, disregarding IMS headers, then a Content Invdalidation request may have unintended load consequences.
   
   <!-- **^ 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 Portal
   
   ## 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. -->
   
   Launch and run Traffic Ops and Traffic Portal. Manually verify there is a warning, of appropriate visual representation, when attempting to create a Content Invalidation job at:
   
   `host.domain.tld/#!/jobs/new` endpoint
   
   (Navigate _Tools_ -> _Invalidate Content_ -> _More_ dropdown -> _Create Invalidation Request_)
   
   `host.domain.tld/#!/delivery-services/<id>/jobs/new` endpoint
   
   (Navigate _Services_ -> _Delivery Services_ -> Select a DS -> _More_ dropdown -> _Manage Invalidation Requests_ -> _More_ downdown -> _Create Invalidation Request_)
   
   Documentation for content invalidation was also updated to reference RFC 7234 in both content invalidation locations
   
   [Using Traffic Portal - Invalidate Content](https://traffic-control-cdn.readthedocs.io/en/latest/admin/traffic_portal/usingtrafficportal.html#invalidate-content)
   
   [Quick How-To - Content Invalidation](https://traffic-control-cdn.readthedocs.io/en/latest/admin/quick_howto/content_invalidation.html)
   
   
   ## PR submission checklist
   - [ ] This PR has tests - Aesthetic changes only
   - [x] This PR has 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] mattjackson220 merged pull request #6332: Add warnings for Content Invalidation creation and documentation

[GitBox <gi...@apache.org>]

mattjackson220 merged pull request #6332:
URL: https://github.com/apache/trafficcontrol/pull/6332


   


-- 
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