Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add warnings for Content Invalidation creation and documentation #6332

Merged
merged 1 commit into from
Nov 8, 2021

Conversation

tcfdev
Copy link
Collaborator

@tcfdev tcfdev commented Nov 4, 2021

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.


Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Portal

What is the best way to verify this PR?

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

Quick How-To - Content Invalidation

PR submission checklist

@rawlinp rawlinp added documentation related to documentation improvement The functionality exists but it could be improved in some way. Traffic Portal v1 related to Traffic Portal version 1 labels Nov 4, 2021
Copy link
Contributor

@mattjackson220 mattjackson220 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me! tests pass, tested locally and works as expected! docs build and look good! ill merge after a rebase

@tcfdev tcfdev force-pushed the feature/5698-warn-origin-304 branch from c1d46d6 to 698e51e Compare November 6, 2021 01:34
@mattjackson220 mattjackson220 merged commit d012eae into apache:master Nov 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation related to documentation improvement The functionality exists but it could be improved in some way. Traffic Portal v1 related to Traffic Portal version 1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Traffic Portal Invalidate Content page: warning about origin needing to support 304s
3 participants