This is an automated email from the ASF dual-hosted git repository.
mattjackson pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new d012eae Add warnings for Content Invalidation creation and
documentation (#6332)
d012eae is described below
commit d012eaeabbb74dc11d4c484798e01aa814f13cb1
Author: Taylor Clayton Frey <[email protected]>
AuthorDate: Mon Nov 8 08:43:52 2021 -0700
Add warnings for Content Invalidation creation and documentation (#6332)
Co-authored-by: Taylor Frey <[email protected]>
---
CHANGELOG.md | 1 +
docs/source/admin/quick_howto/content_invalidation.rst | 2 +-
docs/source/admin/traffic_portal/usingtrafficportal.rst | 6 +++++-
.../form/deliveryServiceJob/form.deliveryServiceJob.tpl.html | 6 ++++++
traffic_portal/app/src/common/modules/form/job/form.job.tpl.html | 6 ++++++
5 files changed, 19 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index ae451a7..d95858a 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -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.
diff --git a/docs/source/admin/quick_howto/content_invalidation.rst
b/docs/source/admin/quick_howto/content_invalidation.rst
index 32d2aa2..7e5061c 100644
--- a/docs/source/admin/quick_howto/content_invalidation.rst
+++ b/docs/source/admin/quick_howto/content_invalidation.rst
@@ -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 [...]
-.. 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:
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst
b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index a22645e..2858c94 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -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 follo [...]
+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
diff --git
a/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
b/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
index 470a9c6..6001000 100644
---
a/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
+++
b/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
@@ -28,6 +28,12 @@ under the License.
<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)}">
diff --git a/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
b/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
index 028cafd..76e4a38 100644
--- a/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
+++ b/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
@@ -26,6 +26,12 @@ under the License.
<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)}">
