Skip to content

Commit

Permalink
Add warnings for Content Invalidation creation and documentation (apa…
Browse files Browse the repository at this point in the history
…che#6332)

Co-authored-by: Taylor Frey <[email protected]>
  • Loading branch information
tcfdev and Taylor Frey authored Nov 8, 2021
1 parent 9a1ee9f commit d012eae
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Added definition for `heartbeat.polling.interval` for CDN Traffic Monitor config in API documentation.
- New `pkg` script options, `-h`, `-s`, `-S`, and `-L`.
- Added `Invalidation Type` (REFRESH or REFETCH) for invalidating content to Traffic Portal.
- IMS warnings to Content Invalidation requests in Traffic Portal and documentation.

### Fixed
- [#6197](https://github.com/apache/trafficcontrol/issues/6197) - TO `/deliveryservices/:id/routing` makes requests to all TRs instead of by CDN.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/admin/quick_howto/content_invalidation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Invalidating content on the CDN is sometimes necessary when the :term:`Origin` w

.. impl-detail:: Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Control does not try to remove the content from the caches, but it makes the content inaccessible using the `regex_revalidate plugin for Apache Traffic Server <https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/plugins/regex_revalidate.en.html>`_. This forces a "re-validation" of the content.

.. Note:: This method forces :term:`cache servers` to "re-validate" content, so in order to work properly the :term:`Origin` needs to support revalidation according to section 13 of :rfc:`2616`.
.. Warning:: This method forces :term:`cache servers` to "re-validate" content, so in order to work properly the :term:`Origin` needs to support revalidation according to section 4.3.2 of :rfc:`7234`.

To invalidate content for a specific :term:`Delivery Service`, follow these steps:

Expand Down
6 changes: 5 additions & 1 deletion docs/source/admin/traffic_portal/usingtrafficportal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -645,7 +645,11 @@ Tools

Invalidate Content
------------------
Here, specific assets can be invalidated in all caches of a :term:`Delivery Service`, forcing content to be updated from the origin. Specifically, this *doesn't* mean that :term:`cache servers` will immediately remove items from their caches, but rather will fetch new copies whenever a request is made matching the 'Asset URL' regular expression. This behavior persists until the Invalidate Content Job's :abbr:`TTL (Time To Live)` expires. Each entry in the table on this page has the following fields:
Here, specific assets can be invalidated in all caches of a :term:`Delivery Service`, forcing content to be updated from the origin. Specifically, this *doesn't* mean that :term:`cache servers` will immediately remove items from their caches, but rather will fetch new copies whenever a request is made matching the 'Asset URL' regular expression. This behavior persists until the Invalidate Content Job's :abbr:`TTL (Time To Live)` expires.

.. Warning:: This method forces :term:`cache servers` to "re-validate" content, so in order to work properly the :term:`Origin` needs to support revalidation according to section 4.3.2 of :rfc:`7234`.

Each entry in the table on this page has the following fields:

:term:`Delivery Service`: The :term:`Delivery Service` to which to apply this Invalidate Content Job
:Asset URL: A URL or regular expression which describes the asset(s) to be invalidated
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@
<div class="clearfix"></div>
</div>
<div class="x_content">
<div class="helptext">
<aside class="warning">
<h6>Warning</h6>
<p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
</aside>
</div>
<br>
<form name="jobForm" class="form-horizontal form-label-left" novalidate>
<div class="form-group" ng-class="{'has-error': hasError(jobForm.regex), 'has-feedback': hasError(jobForm.regex)}">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@
<div class="clearfix"></div>
</div>
<div class="x_content">
<div class="helptext">
<aside class="warning">
<h6>Warning</h6>
<p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
</aside>
</div>
<br>
<form name="jobForm" class="form-horizontal form-label-left" novalidate>
<div class="form-group" ng-class="{'has-error': hasError(jobForm.deliveryservice), 'has-feedback': hasError(jobForm.deliveryservice)}">
Expand Down

0 comments on commit d012eae

Please sign in to comment.