You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2018/04/27 18:45:45 UTC

[GitHub] knutsel closed pull request #2178: Remove trafficserver overview docs, move to admin faq

knutsel closed pull request #2178: Remove trafficserver overview docs, move to admin faq
URL: https://github.com/apache/incubator-trafficcontrol/pull/2178
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/docs/source/development/index.rst b/docs/source/development/index.rst
index 999025ac3..5c659fb08 100644
--- a/docs/source/development/index.rst
+++ b/docs/source/development/index.rst
@@ -26,5 +26,4 @@ Use this guide to start developing applications that consume the Traffic Control
   traffic_router
   traffic_monitor
   traffic_stats
-  traffic_server
 
diff --git a/docs/source/development/traffic_server.rst b/docs/source/development/traffic_server.rst
deleted file mode 100644
index f8a78fbf6..000000000
--- a/docs/source/development/traffic_server.rst
+++ /dev/null
@@ -1,19 +0,0 @@
-.. 
-.. 
-.. 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.
-.. 
-
-Traffic Server
-**************
-See the `Apache Traffic Server documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_.
-
diff --git a/docs/source/faq/administration.rst b/docs/source/faq/administration.rst
index feecff7a6..e9060f44b 100644
--- a/docs/source/faq/administration.rst
+++ b/docs/source/faq/administration.rst
@@ -16,6 +16,35 @@
 Running a Traffic Control CDN
 *****************************
 
+.. _rl-cachegroup:
+
+Cache Group
+-------------------
+  A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group. 
+
+  There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group. 
+
+  ..  Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance. 
+
+  A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
+
+  Consider the example CDN below:
+
+  .. image:: cache_groups_1.png
+	:align: center
+
+  There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent. 
+
+All caches (and other servers) are assigned a Profile in Traffic Ops. 
+
+
+.. _rl-profile:
+
+Profile
+---------------
+  A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles. 
+
+
 
 Why is my CRConfig.json rejected?
 =================================
diff --git a/docs/source/overview/cache_groups_1.png b/docs/source/faq/cache_groups_1.png
similarity index 100%
rename from docs/source/overview/cache_groups_1.png
rename to docs/source/faq/cache_groups_1.png
diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst
index 65dd20e95..865d34431 100644
--- a/docs/source/overview/index.rst
+++ b/docs/source/overview/index.rst
@@ -26,5 +26,4 @@ Introduces the Traffic Control architecture, components, and their integration.
   traffic_router
   traffic_monitor
   traffic_stats
-  traffic_server
   traffic_vault
diff --git a/docs/source/overview/traffic_server.rst b/docs/source/overview/traffic_server.rst
deleted file mode 100644
index c91b98f1e..000000000
--- a/docs/source/overview/traffic_server.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. 
-.. 
-.. 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.
-.. 
-
-Traffic Server
-==============
-The caches in a Traffic Control CDN are servers running the Apache Traffic Server software. See `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_ for more information. Caches in a Traffic Control CDN are deployed in cache groups.
-
-.. |arrow| image:: fwda.png
-
-.. _rl-cachegroup:
-
-|arrow| Cache Group
--------------------
-  A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group. 
-
-  There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group. 
-
-  ..  Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance. 
-
-  A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
-
-  Consider the example CDN below:
-
-  .. image:: cache_groups_1.png
-	:align: center
-
-  There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent. 
-
-All caches (and other servers) are assigned a Profile in Traffic Ops. 
-
-
-.. _rl-profile:
-
-|arrow| Profile
----------------
-  A Profile is a set of configuration settings and parameters, applied to a server or deliveryservice. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles. 
-


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services