You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by mi...@apache.org on 2019/06/25 16:03:47 UTC
[trafficcontrol] branch master updated: removed the 'Servers' parts
of the TO UI documentation (#3693)
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 3c45e1a removed the 'Servers' parts of the TO UI documentation (#3693)
3c45e1a is described below
commit 3c45e1a8a3b70a88b856a2c9dea185859676bb08
Author: ocket8888 <oc...@gmail.com>
AuthorDate: Tue Jun 25 10:03:42 2019 -0600
removed the 'Servers' parts of the TO UI documentation (#3693)
---
docs/source/admin/traffic_ops/using.rst | 141 ---------------------
.../admin/traffic_portal/usingtrafficportal.rst | 6 +-
docs/source/glossary.rst | 40 +++++-
3 files changed, 41 insertions(+), 146 deletions(-)
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 723f8cb..4e87d11 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -38,16 +38,6 @@ The Traffic Ops Menu
The following tabs are available in the menu at the top of the Traffic Ops user interface.
-Servers
--------
-The main Servers table. This is where you Create/Read/Update/Delete servers of all types. Click the main tab to get to the main table, and hover over to get these sub options:
-
-+-------------------+--------------------------------------+
-| Option | Description |
-+===================+======================================+
-| Upload Server CSV | Bulk add of servers from a CSV file. |
-+-------------------+--------------------------------------+
-
Parameters
----------
Parameters and Profiles can be edited here. Hover over the tab to get the following options:
@@ -112,137 +102,6 @@ Help for Traffic Ops and Traffic Control. Hover over this tab to get the followi
| Logout | Logout from Traffic Ops |
+---------------+---------------------------------------------------------------------+
-.. _server:
-
-Server
-======
-This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The **IPAddrr** column is clickable to launch an ``ssh://`` link to this server. The |graph| icon will link to a Traffic Stats graph of this server for caches, and the |info| will link to the server status pages for other server types.
-
-
-Server Types
-------------
-These are the types of servers that can be managed in Traffic Ops:
-
-+---------------+---------------------------------------------+
-| Name | Description |
-+===============+=============================================+
-| EDGE | Edge Cache |
-+---------------+---------------------------------------------+
-| MID | Mid Tier Cache |
-+---------------+---------------------------------------------+
-| ORG | Origin |
-+---------------+---------------------------------------------+
-| CCR | Traffic Router |
-+---------------+---------------------------------------------+
-| RASCAL | Rascal health polling & reporting |
-+---------------+---------------------------------------------+
-| TOOLS_SERVER | Ops hosts for managment |
-+---------------+---------------------------------------------+
-| RIAK | Riak keystore |
-+---------------+---------------------------------------------+
-| SPLUNK | SPLUNK indexer search head etc |
-+---------------+---------------------------------------------+
-| TRAFFIC_STATS | traffic_stats server |
-+---------------+---------------------------------------------+
-| INFLUXDB | influxDb server |
-+---------------+---------------------------------------------+
-
-.. _asn-czf:
-
-The Coverage Zone File and ASN Table
-------------------------------------
-The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:
-
-.. code-block:: json
-
- {
- "coverageZones": {
- "cache-group-01": {
- "coordinates": {
- "latitude": 1.1,
- "longitude": 2.2
- },
- "network6": [
- "1234:5678::/64",
- "1234:5679::/64"
- ],
- "network": [
- "192.168.8.0/24",
- "192.168.9.0/24"
- ]
- },
- "cache-group-02": {
- "coordinates": {
- "latitude": 3.3,
- "longitude": 4.4
- },
- "network6": [
- "1234:567a::/64",
- "1234:567b::/64"
- ],
- "network": [
- "192.168.4.0/24",
- "192.168.5.0/24"
- ]
- }
- }
- }
-
-.. _deep-czf:
-
-The Deep Coverage Zone File
----------------------------
-The Deep Coverage Zone File (DCZF) format is similar to the CZF format but adds a ``caches`` list under each ``deepCoverageZone``:
-
-.. code-block:: json
-
- {
- "deepCoverageZones": {
- "location-01": {
- "coordinates": {
- "latitude": 5.5,
- "longitude": 6.6
- },
- "network6": [
- "1234:5678::/64",
- "1234:5679::/64"
- ],
- "network": [
- "192.168.8.0/24",
- "192.168.9.0/24"
- ],
- "caches": [
- "edge-01",
- "edge-02"
- ]
- },
- "location-02": {
- "coordinates": {
- "latitude": 7.7,
- "longitude": 8.8
- },
- "network6": [
- "1234:567a::/64",
- "1234:567b::/64"
- ],
- "network": [
- "192.168.4.0/24",
- "192.168.5.0/24"
- ],
- "caches": [
- "edge-02",
- "edge-03"
- ]
- }
- }
- }
-
-Each entry in the ``caches`` list is the hostname of an edge cache registered in Traffic Ops which will be used for "deep" caching in that Deep Coverage Zone. Unlike a regular CZF, coverage zones in the DCZF do not map to a :term:`Cache Group` in Traffic Ops, so currently the deep coverage zone name only needs to be unique.
-
-If the Traffic Router gets a DCZF "hit" for a requested :term:`Delivery Service` that has Deep Caching enabled, the client will be routed to an available "deep" cache from that zone's ``caches`` list.
-
-.. note:: The ``"coordinates"`` section is optional.
-
.. _working-with-profiles:
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index 92b4d29..b45a2aa 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -266,14 +266,14 @@ A table of all servers (of all kinds) across all :term:`Delivery Services` and C
:UPD: 'true' when updates to the server's configuration are pending, 'false' otherwise
:Host: The hostname of the server
-:Domain: The server's domain. (The :abbr:`FQDN (Fully Qualified Domain Name)` of the server is given by 'Host.Domain')
+:Domain: The server's domain. (The :abbr:`FQDN (Fully Qualified Domain Name)` of the server is given by :file:`{Host}.{Domain}`)
:IP: The server's IPv4 address
:IPv6: The server's IPv6 address
-:Status: The server's status
+:Status: The server's :term:`Status`
.. seealso:: :ref:`health-proto`
-:Type: The type of server e.g. EDGE for an Edge-tier :term:`cache server`
+:Type: The :term:`Type` of server e.g. EDGE for an :term:`Edge-tier cache server`
:Profile: The name of the server's :term:`Profile`
:CDN: The name of the CDN to which this server is assigned (if any)
:Cache Group: The name of the :term:`Cache Group` to which this server belongs
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index b01a7db..5185a46 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -44,7 +44,7 @@ Glossary
.. Note:: Often the Edge-tier to Mid-tier relationship is based on network distance, and does not necessarily match the geographic distance.
- .. seealso:: A :dfn:`Cache Group` serves a particular part of the network as defined in the coverage zone file. See :ref:`asn-czf` for details.
+ .. seealso:: A :dfn:`Cache Group` serves a particular part of the network as defined in the :term:`Coverage Zone File` (or :term:`Deep Coverage Zone File`, when applicable).
Consider the example CDN in :numref:`fig-cg_hierarchy`. Here some country/province/region has been divided into quarters: Northeast, Southeast, Northwest, and Southwest. The arrows in the diagram indicate the flow of requests. If a client in the Northwest, for example, were to make a request to the :term:`Delivery Service`, it would first be directed to some :term:`cache server` in the "Northwest" Edge-tier :dfn:`Cache Group`. Should the requested content not be in cache, the Edge-tier [...]
@@ -64,10 +64,46 @@ Glossary
Coverage Zone Map
The :abbr:`CZM (Coverage Zone Map)` or :abbr:`CZF (Coverage Zone File)` is a file that maps network prefixes to :term:`Cache Groups`. Traffic Router uses the :abbr:`CZM (Coverage Zone Map)` to determine what :term:`Cache Group` is closest to the client. If the client IP address is not in this :abbr:`CZM (Coverage Zone Map)`, it falls back to geographic mapping, using a `MaxMind GeoIP2 database <https://www.maxmind.com/en/geoip2-databases>`_ to find the client's location, and the geogra [...]
+ .. code-block:: json
+ :caption: Example Coverage Zone File
+
+ { "coverageZones": {
+ "cache-group-01": {
+ "network6": [
+ "1234:5678::/64",
+ "1234:5679::/64"
+ ],
+ "network": [
+ "192.168.8.0/24",
+ "192.168.9.0/24"
+ ]
+ }
+ }}
+
+
Deep Coverage Zone File
Deep Coverage Zone Map
The :abbr:`DCZF (Deep Coverage Zone File)` or :abbr:`DCZM (Deep Coverage Zone Map)` maps network prefixes to "locations" - almost like the :term:`Coverage Zone File`. Location names must be unique, and within the file are simply used to group :term:`Edge-tier cache servers`. When a mapping is performed by Traffic Router, it will only look in the :abbr:`DCZF (Deep Coverage Zone File)` if the :term:`Delivery Service` to which a client is being directed makes use of :ref:`ds-deep-caching` [...]
+ .. code-block:: json
+ :caption: Example Deep Coverage Zone File
+
+ { "coverageZones": {
+ "cache-group-01": {
+ "network6": [
+ "1234:5678::/64",
+ "1234:5679::/64"
+ ],
+ "network": [
+ "192.168.8.0/24",
+ "192.168.9.0/24"
+ ],
+ "caches": [
+ "edge"
+ ]
+ }
+ }}
+
Delivery Service
Delivery Services
:dfn:`Delivery Services` are often referred to as a :term:`reverse proxy` "remap rule" that exists on Edge-tier :term:`cache servers`. In most cases, a :dfn:`Delivery Service` is a one-to-one mapping to an :abbr:`FQDN (Fully Qualified Domain Name)` that is used as a hostname to deliver the content. Many options and settings regarding how to optimize the content delivery exist, which are configurable on a :dfn:`Delivery Service` basis. Some examples of these :dfn:`Delivery Service`\ set [...]
@@ -85,7 +121,7 @@ Glossary
Division
Divisions
- A group of :term:`Region`\ s.
+ A group of :term:`Regions`.
Edge
Edge-tier