trafficcontrol-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mitchell...@apache.org
Subject [trafficcontrol] branch master updated: Moved content invalidation docs into qht guide (#3918)
Date Fri, 27 Sep 2019 13:42:12 GMT
This is an automated email from the ASF dual-hosted git repository.

mitchell852 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 8609eda  Moved content invalidation docs into qht guide (#3918)
8609eda is described below

commit 8609eda5bbf311eb1b9a575465c781aa4109f3a4
Author: ocket8888 <ocket8888@gmail.com>
AuthorDate: Fri Sep 27 07:42:07 2019 -0600

    Moved content invalidation docs into qht guide (#3918)
---
 .../admin/quick_howto/content_invalidation.rst     |  53 +++++++++++++++++++++
 .../admin/quick_howto/content_invalidation/01.png  | Bin 0 -> 42695 bytes
 .../admin/quick_howto/content_invalidation/02.png  | Bin 0 -> 18733 bytes
 .../admin/quick_howto/content_invalidation/03.png  | Bin 0 -> 32869 bytes
 docs/source/admin/quick_howto/index.rst            |  14 +-----
 docs/source/admin/traffic_ops/using.rst            |  24 ----------
 6 files changed, 55 insertions(+), 36 deletions(-)

diff --git a/docs/source/admin/quick_howto/content_invalidation.rst b/docs/source/admin/quick_howto/content_invalidation.rst
new file mode 100644
index 0000000..98248eb
--- /dev/null
+++ b/docs/source/admin/quick_howto/content_invalidation.rst
@@ -0,0 +1,53 @@
+..
+..
+.. Licensed 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.
+..
+
+.. _content-invalidation:
+
+****************************
+Forcing Content Invalidation
+****************************
+Invalidating content on the CDN is sometimes necessary when the :term:`origin` was mis-configured
and something is cached in the CDN  that needs to be removed.
+
+.. 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`.
+
+To invalidate content for a specific :term:`Delivery Service`, follow these steps:
+
+#. Select the desired :term:`Delivery Service` from the :ref:`tp-services-delivery-service`
view of Traffic Portal
+
+	.. figure:: content_invalidation/01.png
+		:align: center
+		:alt: The Traffic Portal Delivery Services view
+
+		The Traffic Portal Delivery Services view
+
+#. From the :guilabel:`More` drop-down menu, select :menuselection:`Manage Invalidation Requests`
+
+	.. figure:: content_invalidation/02.png
+		:align: center
+		:alt: The 'Manage Invalidation Requests' option under 'More'
+
+		Select 'Manage Invalidation Requests'
+
+#. Click/tap on the :guilabel:`+` button to open the submission form for a new content invalidation.
Fill out this form. The "Path Regex" field should be a `PCRE <http://www.pcre.org/>`_-compatible
regular expression that matches all content that must be invalidated - and should **not**
match any content that must *not* be invalidated. "TTL (hours)" specifies the number of hours
for which the invalidation should remain active. Best practice is to set this to the same
as the content's cac [...]
+
+	.. figure:: content_invalidation/03.png
+		:align: center
+		:alt: The new content invalidation submission form
+
+		The 'new content invalidation submission' Form
+
+#. Click on the :guilabel:`Create` button to finalize the content invalidation.
diff --git a/docs/source/admin/quick_howto/content_invalidation/01.png b/docs/source/admin/quick_howto/content_invalidation/01.png
new file mode 100644
index 0000000..d0b94e2
Binary files /dev/null and b/docs/source/admin/quick_howto/content_invalidation/01.png differ
diff --git a/docs/source/admin/quick_howto/content_invalidation/02.png b/docs/source/admin/quick_howto/content_invalidation/02.png
new file mode 100644
index 0000000..ec25dc4
Binary files /dev/null and b/docs/source/admin/quick_howto/content_invalidation/02.png differ
diff --git a/docs/source/admin/quick_howto/content_invalidation/03.png b/docs/source/admin/quick_howto/content_invalidation/03.png
new file mode 100644
index 0000000..83d8935
Binary files /dev/null and b/docs/source/admin/quick_howto/content_invalidation/03.png differ
diff --git a/docs/source/admin/quick_howto/index.rst b/docs/source/admin/quick_howto/index.rst
index c797496..fa22cb0 100644
--- a/docs/source/admin/quick_howto/index.rst
+++ b/docs/source/admin/quick_howto/index.rst
@@ -19,16 +19,6 @@ Quick How To Guides
 Traffic Control is a complicated system, and documenting it is not trivial. Sometimes a picture
says more than a thousand words, so here are some screenshot-based tutorials on how to use
some of the more involved features.
 
 .. toctree::
+	:glob:
 
-	anonymous_blocking
-	cachegroup_fallback
-	ciab
-	dnssec
-	ds_requests
-	federations
-	multi_site
-	oauth_login
-	regionalgeo
-	static_dns
-	steering
-	profile_compare_mgmt
+	*
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 7f2417d..112c9bf 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -53,27 +53,3 @@ Help for Traffic Ops and Traffic Control. Hover over this tab to get the
followi
 +---------------+---------------------------------------------------------------------+
 | Logout        | Logout from Traffic Ops                                             |
 +---------------+---------------------------------------------------------------------+
-
-.. index::
-	Invalidate Content
-	Purge
-
-.. _purge:
-
-Invalidate Content
-==================
-Invalidating content on the CDN is sometimes necessary when the origin was mis-configured
and something is cached in the CDN  that needs to be removed. 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 Ops will
not try to remove the content from the caches, but it makes the content inaccessible using
the *regex_revalidate* ATS plugin.  [...]
-
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* -
the origin needs to support revalidation according to the HTTP/1.1 specification, and send
a ``200 OK`` or ``304 Not Modified`` as applicable.
-
-To invalidate content:
-
-#. Click **Tools > Invalidate Content**
-#. Fill out the form fields:
-
-	- Select the *:term:`Delivery Service`**
-	- Enter the **Path Regex** - this should be a `PCRE <http://www.pcre.org/>`_ compatible
regular expression for the path to match for forcing the revalidation. Be careful to only
match on the content you need to remove - revalidation is an expensive operation for many
origins, and a simple ``/.*`` can cause an overload condition of the origin.
-	- Enter the **Time To Live** - this is how long the revalidation rule will be active for.
It usually makes sense to make this the same as the ``Cache-Control`` header from the origin
which sets the object time to live in cache (by ``max-age`` or ``Expires``). Entering a longer
TTL here will make the caches do unnecessary work.
-	- Enter the **Start Time** - this is the start time when the revalidation rule will be made
active. It is pre-populated with the current time, leave as is to schedule ASAP.
-
-#. Click the **Submit** button.


Mime
View raw message