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 cfeffd6 removed the 'Tools' parts of the TO UI documentation (#3694)
cfeffd6 is described below
commit cfeffd678c89c672a59a0eb8ffe5d8a8f73ce56e
Author: ocket8888 <[email protected]>
AuthorDate: Tue Jun 25 14:14:59 2019 -0600
removed the 'Tools' parts of the TO UI documentation (#3694)
---
.../admin/quick_howto/anonymous_blocking.rst | 18 +-
.../admin/quick_howto/anonymous_blocking/01.png | Bin 109855 -> 51535 bytes
.../admin/quick_howto/anonymous_blocking/02.png | Bin 28800 -> 50901 bytes
.../admin/quick_howto/anonymous_blocking/03.png | Bin 0 -> 61373 bytes
docs/source/admin/quick_howto/ciab.rst | 4 +-
docs/source/admin/quick_howto/ds_requests.rst | 6 +-
docs/source/admin/quick_howto/regionalgeo.rst | 10 +-
docs/source/admin/quick_howto/regionalgeo/01.png | Bin 75096 -> 47648 bytes
docs/source/admin/quick_howto/regionalgeo/02.png | Bin 93191 -> 33700 bytes
docs/source/admin/quick_howto/regionalgeo/03.png | Bin 42367 -> 54978 bytes
docs/source/admin/traffic_ops/using.rst | 188 ---------------------
.../admin/traffic_portal/usingtrafficportal.rst | 35 +++-
docs/source/admin/traffic_router.rst | 6 +-
docs/source/api/cachegroups_id_queue_update.rst | 11 +-
docs/source/api/cdns_id_queue_update.rst | 4 +-
docs/source/api/cdns_id_snapshot.rst | 12 +-
docs/source/api/cdns_name_configs_monitoring.rst | 2 +-
docs/source/api/cdns_name_snapshot.rst | 14 +-
docs/source/api/cdns_name_snapshot_new.rst | 14 +-
docs/source/api/servers_id_queue_update.rst | 9 +-
docs/source/api/snapshot_name.rst | 12 +-
docs/source/glossary.rst | 17 +-
docs/source/overview/delivery_services.rst | 2 +-
docs/source/tools/compare.rst | 2 +-
24 files changed, 103 insertions(+), 263 deletions(-)
diff --git a/docs/source/admin/quick_howto/anonymous_blocking.rst
b/docs/source/admin/quick_howto/anonymous_blocking.rst
index 7f45577..166f47a 100644
--- a/docs/source/admin/quick_howto/anonymous_blocking.rst
+++ b/docs/source/admin/quick_howto/anonymous_blocking.rst
@@ -50,29 +50,29 @@ Configure Anonymous Blocking
An optional element. It includes a list of :abbr:`CIDR
(Classless Inter-Domain Routing)` blocks indicating the IPv4 and IPv6 subnets
that are allowed by the rule. If this list exists and the value is not
``null``, client IPs will be matched against the :abbr:`CIDR (Classless
Inter-Domain Routing)` list, and if there is any match, the request will be
allowed. If there is no match in the white list, further anonymous blocking
logic will continue.
-#. Add the following three Anonymous Blocking parameters in Traffic Portal
into CRConfig.json:
+#. Add the following three Anonymous Blocking parameters in Traffic Portal
with the "CRConfig.json" "Config File", and ensure they are assigned to all of
the Traffic Routers that should perform Anonymous Blocking:
``anonymousip.policy.configuration``
- The HTTP URL of the Anonymous Blocking configuration file.
Traffic Router will fetch the file from this URL.
+ The URL of the Anonymous Blocking configuration file. Traffic
Router will fetch the file from this URL.
``anonymousip.polling.url``
- The HTTP URL of the Anonymous IP Database. Traffic Router will
fetch the file from this URL.
+ The URL of the Anonymous IP Database. Traffic Router will fetch
the file from this URL.
``anonymousip.polling.interval``
The interval that Traffic Router polls the Anonymous Blocking
configuration file and Anonymous IP Database.
.. figure:: anonymous_blocking/01.png
- :scale: 100%
+ :width: 40%
:align: center
-#. Enable Anonmyous Blocking for a :term:`Delivery Service`
+#. Enable Anonmyous Blocking for a :term:`Delivery Service` using the
:ref:`Delivery Services view in Traffic Portal <tp-services-delivery-service>`
(don't forget to save changes!)
.. figure:: anonymous_blocking/02.png
- :scale: 100%
+ :width: 40%
:align: center
-#. Go to :menuselection:`Tools --> Snapshot CRConfig`, perform :guilabel:`Diff
CRConfig` and click :guilabel:`Write CRConfig`.
+#. Go to :ref:`the Traffic Portal CDNs view <tp-cdns>`, click on
:guilabel:`Diff CDN Config Snapshot`, and click :guilabel:`Perform Snapshot`.
- .. figure:: regionalgeo/03.png
- :scale: 70%
+ .. figure:: anonymous_blocking/03.png
+ :width: 40%
:align: center
diff --git a/docs/source/admin/quick_howto/anonymous_blocking/01.png
b/docs/source/admin/quick_howto/anonymous_blocking/01.png
index bda89db..5b785e4 100644
Binary files a/docs/source/admin/quick_howto/anonymous_blocking/01.png and
b/docs/source/admin/quick_howto/anonymous_blocking/01.png differ
diff --git a/docs/source/admin/quick_howto/anonymous_blocking/02.png
b/docs/source/admin/quick_howto/anonymous_blocking/02.png
index 0b74046..60df6df 100644
Binary files a/docs/source/admin/quick_howto/anonymous_blocking/02.png and
b/docs/source/admin/quick_howto/anonymous_blocking/02.png differ
diff --git a/docs/source/admin/quick_howto/anonymous_blocking/03.png
b/docs/source/admin/quick_howto/anonymous_blocking/03.png
new file mode 100644
index 0000000..92363e3
Binary files /dev/null and
b/docs/source/admin/quick_howto/anonymous_blocking/03.png differ
diff --git a/docs/source/admin/quick_howto/ciab.rst
b/docs/source/admin/quick_howto/ciab.rst
index 2683a8f..abee210 100644
--- a/docs/source/admin/quick_howto/ciab.rst
+++ b/docs/source/admin/quick_howto/ciab.rst
@@ -201,9 +201,9 @@ The enroller runs within CDN in a Box using :option:`--dir`
which provides the a
Auto Snapshot/Queue-Updates
---------------------------
-An automatic snapshot of the current Traffic Ops CDN configuration/toplogy
will be performed once the "enroller" has finished loading all of the data and
a minimum number of servers have been enrolled. To enable this feature, set
the boolean ``AUTO_SNAPQUEUE_ENABLED`` to ``true`` [8]_. The snapshot and
queue-updates actions will not be performed until all servers in
``AUTO_SNAPQUEUE_SERVERS`` (comma-delimited string) have been enrolled. The
current enrolled servers will be polled ever [...]
+An automatic :term:`Snapshot` of the current Traffic Ops CDN
configuration/topology will be performed once the "enroller" has finished
loading all of the data and a minimum number of servers have been enrolled. To
enable this feature, set the boolean ``AUTO_SNAPQUEUE_ENABLED`` to ``true``
[8]_. The :term:`Snapshot` and :term:`Queue Updates` actions will not be
performed until all servers in ``AUTO_SNAPQUEUE_SERVERS`` (comma-delimited
string) have been enrolled. The current enrolled serve [...]
-.. [8] Automatic Snapshot/Queue-Updates is enabled by default in
:file:`infrastructure/cdn-in-a-box/variables.env`.
+.. [8] Automatic :term:`Snapshot`/:term:`Queue Updates` is enabled by default
in `variables.env`_.
.. [9] Server poll interval and delay action wait are defaulted to a value of
2 seconds.
Mock Origin Service
diff --git a/docs/source/admin/quick_howto/ds_requests.rst
b/docs/source/admin/quick_howto/ds_requests.rst
index 833db82..e069ffb 100644
--- a/docs/source/admin/quick_howto/ds_requests.rst
+++ b/docs/source/admin/quick_howto/ds_requests.rst
@@ -18,7 +18,7 @@
*************************
Delivery Service Requests
*************************
-When enabled in :file:`traffic_portal_properties.json`, Delivery Service
Requests are created when *all* users attempt to create, update or delete a
:term:`Delivery Service`. This allows users with higher level permissions
("operations" or "admin") to review the changes for completeness and accuracy
before deploying the changes. In addition, most :term:`Delivery Service`
changes require cache configuration updates (aka queue updates) and/or a CDN
:term:`Snapshot`. Both of these actions a [...]
+When enabled in :file:`traffic_portal_properties.json`, Delivery Service
Requests are created when *all* users attempt to create, update or delete a
:term:`Delivery Service`. This allows users with higher level permissions
("operations" or "admin") to review the changes for completeness and accuracy
before deploying the changes. In addition, most :term:`Delivery Service`
changes require configuration updates (i.e. :term:`Queue Updates`) and/or a CDN
:term:`Snapshot`. Both of these action [...]
A list of the Delivery Service requests associated with your :term:`Tenant`
can be found under :menuselection:`Services --> Delivery Service Requests`
@@ -53,10 +53,10 @@ Reject the Delivery Service Request
Rejecting a Delivery Service Request will set status to 'rejected' and
the request can no longer be modified. This will auto-assign the request to the
user doing the rejection.
Fulfill the Delivery Service Request
- Fulfilling a Delivery Service Request will show the requested changes
and, once committed, will apply the desired changes and set status to
'pending'. The request is pending because many types of changes will require
:term:`cache server` configuration updates (aka queue updates) and/or a CDN
snapshot. Once queue updates and/or CDN snapshot is complete, the request
should be marked 'complete'.
+ Fulfilling a Delivery Service Request will show the requested changes
and, once committed, will apply the desired changes and set status to
'pending'. The request is pending because many types of changes will require
:term:`cache server` configuration updates (i.e. :term:`Queue Updates`) and/or
a CDN :term:`Snapshot`. Once :term:`Queue Updates` and/or CDN :term:`Snapshot`
is complete, the request should be marked 'complete'.
Complete the Delivery Service Request
- Only after the Delivery Service Request has been fulfilled and the
changes have been applied can a Delivery Service Request be marked as
'complete'. Marking a Delivery Service Request as 'complete' is currently a
manual step because some changes require :term:`cache server` configuration
updates (aka queue updates) and/or a CDN :term:`Snapshot`. Once that is done
and the changes have been deployed, the request status should be changed from
'pending' to 'complete'.
+ Only after the Delivery Service Request has been fulfilled and the
changes have been applied can a Delivery Service Request be marked as
'complete'. Marking a Delivery Service Request as 'complete' is currently a
manual step because some changes require :term:`cache server` configuration
updates (i.e. :term:`Queue Updates`) and/or a CDN :term:`Snapshot`. Once that
is done and the changes have been deployed, the request status should be
changed from 'pending' to 'complete'.
Delete the Delivery Service request
Delivery Service Requests with a status of 'draft' or 'submitted' can
always be deleted entirely if appropriate.
diff --git a/docs/source/admin/quick_howto/regionalgeo.rst
b/docs/source/admin/quick_howto/regionalgeo.rst
index eaa9abf..33e8198 100644
--- a/docs/source/admin/quick_howto/regionalgeo.rst
+++ b/docs/source/admin/quick_howto/regionalgeo.rst
@@ -64,19 +64,19 @@ Configure Regional Geo-blocking (RGB)
The interval on which Traffic Router polls the :abbr:`RGB
(Regional Geographic-based Blocking)` configuration file.
.. figure:: regionalgeo/01.png
- :scale: 100%
+ :width: 40%
:align: center
-#. Enable RGB for a :term:`Delivery Service`
+#. Enable :abbr:`RGB (Regional Geographic-based Blocking)` for a
:term:`Delivery Service` using the :ref:`Delivery Services view in Traffic
Portal <tp-services-delivery-service>` (don't forget to save changes!)
.. figure:: regionalgeo/02.png
- :scale: 100%
+ :width: 40%
:align: center
-#. Go to :menuselection:`Tools --> Snapshot CRConfig`, perform :guilabel:`Diff
CRConfig` and click :guilabel:`Write CRConfig`.
+#. Go to :ref:`the Traffic Portal CDNs view <tp-cdns>`, click on
:guilabel:`Diff CDN Config Snapshot`, and click :guilabel:`Perform Snapshot`.
.. figure:: regionalgeo/03.png
- :scale: 70%
+ :width: 40%
:align: center
Traffic Router Access Log
diff --git a/docs/source/admin/quick_howto/regionalgeo/01.png
b/docs/source/admin/quick_howto/regionalgeo/01.png
index 0443a17..f9b11c5 100644
Binary files a/docs/source/admin/quick_howto/regionalgeo/01.png and
b/docs/source/admin/quick_howto/regionalgeo/01.png differ
diff --git a/docs/source/admin/quick_howto/regionalgeo/02.png
b/docs/source/admin/quick_howto/regionalgeo/02.png
index 5530920..9684ab1 100644
Binary files a/docs/source/admin/quick_howto/regionalgeo/02.png and
b/docs/source/admin/quick_howto/regionalgeo/02.png differ
diff --git a/docs/source/admin/quick_howto/regionalgeo/03.png
b/docs/source/admin/quick_howto/regionalgeo/03.png
index ce2676b..713ec68 100644
Binary files a/docs/source/admin/quick_howto/regionalgeo/03.png and
b/docs/source/admin/quick_howto/regionalgeo/03.png differ
diff --git a/docs/source/admin/traffic_ops/using.rst
b/docs/source/admin/traffic_ops/using.rst
index 4e87d11..10c86b9 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -60,26 +60,6 @@ Parameters and Profiles can be edited here. Hover over the
tab to get the follow
| Orphaned Parameters | A table of parameters that are not associated
to any profile of :term:`Cache Group`. These parameters either should be
deleted or associated with a profile of :term:`Cache Group`. |
+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-Tools
------
-Tools for working with Traffic Ops and it's servers. Hover over this tab to
get the following options:
-
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Option |
Description |
-+====================+===================================================================================================================================+
-| Generate ISO | Generate a bootable image for any of the servers in the
Servers table (or any server for that matter). See :ref:`generate-iso` |
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Queue Updates | Send Updates to the caches. See :ref:`queue-updates`
|
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| DB Dump | Backup the Database to a .sql file.
|
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router
servers. See :ref:`queue-updates` |
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Invalidate Content | Invalidate or purge content from all caches in the CDN.
See :ref:`purge` |
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-| Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN.
|
-+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-
.. index::
Change Log
@@ -214,174 +194,6 @@ Traffic Router Profile
| | |
multiplier * TTL). Default is 2.
|
+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-Tools
-=====
-
-.. index::
- ISO
- Generate ISO
-
-.. _generate-iso:
-
-Generate ISO
-------------
-Generate ISO is a tool for building custom ISOs for building caches on remote
hosts. Currently it only supports Centos 7, but if you're brave and pure of
heart you MIGHT be able to get it to work with other unix-like OS's.
-
-The interface is *mostly* self-explanatory as it's got hints.
-
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Field | Explaination
|
-+===============================+=================================================================================================================================+
-|Choose a server from list: | This option gets all the server names
currently in the Traffic Ops database and will autofill known values.
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| OS Version: | There needs to be an _osversions.cfg_ file
in the ISO directory that maps the name of a directory to a name that shows up
here. |
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Hostname: | This is the FQDN of the server to be
installed. It is required.
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Root password: | If you don't put anything here it will
default to the salted MD5 of "Fred". Whatever put is MD5 hashed and writte to
disk. |
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| DHCP: | if yes, other IP settings will be ignored
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| IP Address: | Required if DHCP=no
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Netmask: | Required if DHCP=no
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Gateway: | Required if DHCP=no
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| IPV6 Address: | Optional. /64 is assumed if prefix is
omitted
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| IPV6 Gateway: | Ignored if an IPV4 gateway is specified
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Network Device: | Optional. Typical values are bond0, eth4,
etc. Note: if you enter bond0, a LACP bonding config will be written
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| MTU: | If unsure, set to 1500
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-| Specify disk for OS install: | Optional. Typical values are "sda".
|
-+-------------------------------+---------------------------------------------------------------------------------------------------------------------------------+
-
-
-When you click the **Download ISO** button the folling occurs (all paths
relative to the top level of the directory specified in _osversions.cfg_):
-
-#. Reads /etc/resolv.conf to get a list of nameservers. This is a rather ugly
hack that is in place until we get a way of configuring it in the interface.
-#. Writes a file in the ks_scripts/state.out that contains directory from
_osversions.cfg_ and the mkisofs string that we'll call later.
-#. Writes a file in the ks_scripts/network.cfg that is a bunch of key=value
pairs that set up networking.
-#. Creates an MD5 hash of the password you specify and writes it to
ks_scripts/password.cfg. Note that if you do not specify a password "Fred" is
used. Also note that we have experienced some issues with webbrowsers
autofilling that field.
-#. Writes out a disk configuration file to ks_scripts/disk.cfg.
-#. mkisofs is called against the directory configured in _osversions.cfg_ and
an ISO is generated in memory and delivered to your webbrowser.
-
-You now have a customized ISO that can be used to install Red Hat and
derivative Linux installations with some modifications to your ks.cfg file.
-
-Kickstart/Anaconda will mount the ISO at /mnt/stage2 during the install
process (at least with 6).
-
-You can directly include the password file anywhere in your ks.cfg file
(usually in the top) by doing %include /mnt/stage2/ks_scripts/password.cfg
-
-What we currently do is have 2 scripts, one to do hard drive configuration and
one to do network configuration. Both are relatively specific to the
environment they were created in, and both are *probably* wrong for other
organizations, however they are currently living in the "misc" directory as
examples of how to do things.
-
-We trigger those in a %pre section in ks.cfg and they will write config files
to /tmp. We will then include those files in the appropriate places using %pre.
-
-For example this is a section of our ks.cfg file: ::
-
- %include /mnt/stage2/ks_scripts/packages.txt
-
- %pre
- python /mnt/stage2/ks_scripts/create_network_line.py
- bash /mnt/stage2/ks_scripts/drive_config.sh
- %end
-
-These two scripts will then run _before_ anaconda sets up it's internal
structures, then a bit further up in the ks.cfg file (outside of the %pre %end
block) we do an ::
-
- %include /mnt/stage2/ks_scripts/password.cfg
- ...
- %include /tmp/network_line
-
- %include /tmp/drive_config
- ...
-
-This snarfs up the contents and inlines them.
-
-If you only have one kind of hardware on your CDN it is probably best to just
put the drive config right in the ks.cfg.
-
-If you have simple networking needs (we use bonded interfaces in most, but not
all locations and we have several types of hardware meaning different ethernet
interface names at the OS level etc.) then something like this:
-
-.. code-block:: bash
-
- #!/bin/bash
- source /mnt/stage2/ks_scripts/network.cfg
- echo "network --bootproto=static --activate --ipv6=$IPV6ADDR
--ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY
--nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
-
-,, Note:: that this is an example and may not work at all.
-
-You could also put this in the %pre section. Lots of ways to solve it.
-
-We have included the two scripts we use in the "misc" directory of the git
repo:
-
-* kickstart_create_network_line.py
-* kickstart_drive_config.sh
-
-These scripts were written to support a very narrow set of expectations and
environment and are almost certainly not suitable to just drop in, but they
might provide a good starting point.
-
-.. _queue-updates:
-
-Queue Updates and Snapshot CRConfig
------------------------------------
-When changing delivery services special care has to be taken so that Traffic
Router will not send traffic to caches for delivery services that the cache
doesn't know about yet. In general, when adding delivery services, or adding
servers to a delivery service, it is best to update the caches before updating
Traffic Router and Traffic Monitor. When deleting delivery services, or
deleting server assignments to delivery services, it is best to update Traffic
Router and Traffic Monitor first [...]
-
-.. index::
- Cache Updates
- Queue Updates
-
-Queue Updates
-"""""""""""""
-Every 15 minutes the caches should run a *syncds* to get all changes needed
from Traffic Ops. The files that will be updated by the syncds job are:
-
-- records.config
-- remap.config
-- parent.config
-- cache.config
-- hosting.config
-- url\_sig\_(.*)\.config
-- hdr\_rw\_(.*)\.config
-- regex_revalidate.config
-- ip_allow.config
-
-A cache will only get updated when the update flag is set for it. To set the
update flag, use the *Queue Updates* menu - here you can schedule updates for a
whole CDN or a :term:`Cache Group`:
-
-#. Click **Tools > Queue Updates**.
-#. Select the CDN to queue updates for or select All.
-#. Select the :term:`Cache Group` to queue updates for or select All.
-#. Click the **Queue Updates** button.
-#. When the Queue Updates for this Server? (all) window opens, click **OK**.
-
-To schedule updates for just one cache, use the "Server Checks" page, and
click the |checkmark| in the *UPD* column. The UPD column of Server Checks page
will change show a |clock| when updates are pending for that cache.
-
-.. index::
- Snapshot CRConfig
-
-.. _snapshot-crconfig:
-
-Snapshot CRConfig
-"""""""""""""""""
-Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new
CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig,
and Traffic Router polls Traffic Monitor for the same file. This is necessary
to ensure that Traffic Monitor sees configuration changes first, which helps to
ensure that the health and state of caches and delivery services propagates
properly to Traffic Router. See :ref:`ccr-profile` for more information on the
CRConfig file.
-
-To create a new snapshot, use the *Tools > Snapshot CRConfig* menu:
-
- #. Click **Tools > Snapshot CRConfig**.
- #. Verify the selection of the correct CDN from the Choose CDN drop
down and click **Diff CRConfig**.
- On initial selection of this, the CRConfig Diff window says
the following:
-
- There is no existing CRConfig for [cdn] to diff against... Is
this the first snapshot???
- If you are not sure why you are getting this message, please
do not proceed!
- To proceed writing the snapshot anyway click the 'Write
CRConfig' button below.
-
- If there is an older version of the CRConfig, a window will
pop up showing the differences
- between the active CRConfig and the CRConfig about to be
written.
-
- #. Click **Write CRConfig**.
- #. When the This will push out a new CRConfig.json. Are you sure?
window opens, click **OK**.
- #. The "Successfully wrote CRConfig.json!" window opens, click **OK**.
-
-.. Note:: Snapshotting the CDN also deletes all HTTPS certificates for every
:term:`Delivery Service` which has been deleted since the last :term:`Snapshot`.
-
.. index::
Invalidate Content
Purge
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst
b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index b45a2aa..85c971d 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -57,6 +57,8 @@ Admin Down Caches
Each component of this view is updated on the intervals defined in the
:atc-file:`traffic_portal/app/src/traffic_portal_properties.json` configuration
file.
+.. _tp-cdns:
+
CDNs
====
A table of CDNs with the following columns:
@@ -70,8 +72,9 @@ CDN management includes the ability to (where applicable):
- create a new CDN
- update an existing CDN
- delete an existing CDN
-- queue/clear updates on all servers in a CDN
-- compare and take CDN :term:`Snapshots`
+- :term:`Queue Updates` on all servers in a CDN, or clear such updates
+- Compare CDN :term:`Snapshots`
+- create a CDN :term:`Snapshot`
- manage a CDN's DNSSEC keys
- manage a CDN's :term:`Federations`
- view :term:`Delivery Services` of a CDN
@@ -287,7 +290,7 @@ Server management includes the ability to (where
applicable):
- create a new server
- update an existing server
- delete an existing server
-- queue/clear updates on a server
+- :term:`Queue Updates` on a server, or clear such updates
- update server status
- view server :term:`Delivery Services`
- view server configuration files
@@ -415,7 +418,7 @@ Topology
Cache Groups
------------
-This page is a table of :term:`Cache Group`\ s, each entry of which has the
following fields:
+This page is a table of :term:`Cache Groups`, each entry of which has the
following fields:
:Name: The full name of this :term:`Cache Group`
:Short Name: A shorter, more human-friendly name for this :term:`Cache Group`
@@ -428,12 +431,12 @@ This page is a table of :term:`Cache Group`\ s, each
entry of which has the foll
- create a new :term:`Cache Group`
- update an existing :term:`Cache Group`
- delete an existing :term:`Cache Group`
-- queue/clear updates for all servers in a :term:`Cache Group`
+- :term:`Queue Updates` for all servers in a :term:`Cache Group`, or clear
such updates
- view :term:`Cache Group` :abbr:`ASN (Autonomous System Number)`\ s
.. seealso:: `The Wikipedia page on Autonomous System Numbers
<https://en.wikipedia.org/wiki/Autonomous_System_Number>`_
-- view and assign :term:`Cache Group` :term:`Parameter`\ s
+- view and assign :term:`Cache Group` :term:`Parameters`
- view :term:`Cache Group` servers
Coordinates
@@ -550,11 +553,23 @@ DHCP
If this is 'no' the IP settings of the system must be specified, and
the following extra fields will appear:
IP Address
- The resultant system's IPv4 Address
+ The resultant system's IPv4 address
+ IPv6 Address
+ The resultant system's IPv6 address
Network Subnet
The system's network subnet mask
Network Gateway
- The system's network gateway's IPv4 Address
+ The system's network gateway's IPv4 address
+ IPv6 Gateway
+ The system's network gateway's IPv6 address
+ Management IP Address
+ An optional IP address (IPv4 or IPv6) of a "management"
server for the resultant system (e.g. for :abbr:`ILO (Integrated Lights-Out)`)
+ Management IP Netmask
+ The subnet mask (IPv4 or IPv6) used by a "management"
server for the resultant system (e.g. for :abbr:`ILO (Integrated Lights-Out)`)
- only needed if the Management IP Address is provided
+ Management IP Gateway
+ The IP address (IPv4 or IPv6) of the network gateway
used by a "management" server for the resultant system (e.g. for :abbr:`ILO
(Integrated Lights-Out)`) - only needed if the Management IP Address is provided
+ Management Interface
+ The network interface used by a "management" server for
the resultant system (e.g. for :abbr:`ILO (Integrated Lights-Out)`) - only
needed if the Management IP Address is provided. Must not be the same as
"Interface Name".
Network MTU
The system's network's :abbr:`MTU (Maximum Transmission Unit)`. Despite
being a text field, this can only be 1500 or 9000 - it should almost always be
1500
@@ -564,7 +579,7 @@ Network MTU
Disk for OS Install
The disk on which to install the base system. A reasonable default is
``sda`` (the ``/dev/`` prefix is not necessary)
Root Password
- The password to be used for the root user. Input is MD5 hashed before
being written to disk
+ The password to be used for the root user. Input is hashed using MD5
before being written to disk
Confirm Root Password
Repeat the 'Root Password' to be sure it's right
Interface Name
@@ -575,6 +590,8 @@ Interface Name
Stream ISO
If this is 'yes', then the download will start immediately as the ISO
is written directly to the socket connection to Traffic Ops. If this is 'no',
then the download will begin only *after* the ISO has finished being generated.
For almost all use cases, this should be 'yes'.
+.. impl-detail:: Traffic Ops uses Red Hat's `Kickstart
<https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/7/html/installation_guide/chap-kickstart-installations>`
to create these ISOs, so many configuration options not available here can be
tweaked in the :ref:`Kickstart configuration file <Creating-CentOS-Kickstart>`.
+
User Admin
==========
This section offers administrative functionality for users and their
permissions.
diff --git a/docs/source/admin/traffic_router.rst
b/docs/source/admin/traffic_router.rst
index cb0b92d..661bad3 100644
--- a/docs/source/admin/traffic_router.rst
+++ b/docs/source/admin/traffic_router.rst
@@ -81,8 +81,6 @@ Installing Traffic Router
#. Perform a CDN :term:`Snapshot`.
- .. SeeAlso:: :ref:`snapshot-crconfig`
-
.. Note:: Once the :term:`Snapshot` is taken, live traffic will be sent
to the new Traffic Routers provided that their status has been set to
``ONLINE``.
#. Ensure that the parent domain (e.g.: ``cdn.local``) for the CDN's top level
domain (e.g.: ``ciab.cdn.local``) contains a delegation (Name Server records)
for the new Traffic Router, and that the value specified matches the
:abbr:`FQDN (Fully Qualified Domain Name)` of the Traffic Router.
@@ -95,7 +93,7 @@ Configuring Traffic Router
.. versionchanged:: 3.0
Traffic Router 3.0 has been converted to a formal Tomcat instance,
meaning that is now installed separately from the Tomcat servlet engine. The
Traffic Router installation package contains all of the Traffic Router-specific
software, configuration and startup scripts including some additional
configuration files needed for Tomcat. These new configuration files can all be
found in the :file:`/opt/traffic_router/conf` directory and generally serve to
override Tomcat's default settings.
-For the most part, the configuration files and :term:`Parameter`\ s used by
Traffic Router are used to bring it online and start communicating with various
Traffic Control components. Once Traffic Router is successfully communicating
with Traffic Control, configuration should mostly be performed in Traffic
Portal, and will be distributed throughout Traffic Control via CDN
:term:`Snapshot` process. See :ref:`snapshot-crconfig` for more information.
Please see the :term:`Parameter` documen [...]
+For the most part, the configuration files and :term:`Parameters` used by
Traffic Router are used to bring it online and start communicating with various
Traffic Control components. Once Traffic Router is successfully communicating
with Traffic Control, configuration should mostly be performed in Traffic
Portal, and will be distributed throughout Traffic Control via CDN
:term:`Snapshot` process. Please see the :term:`Parameter` documentation for
Traffic Router in the Using Traffic Ops gu [...]
.. _tr-config-files:
.. table:: Traffic Router Parameters
@@ -352,7 +350,7 @@ DS_BYPASS
DS_CLIENT_GEO_UNSUPPORTED
Traffic Router did not find a resource supported by coverage zone data
and was unable to determine the geographic location of the requesting client
DS_CZ_BACKUP_CG
- Traffic Router found a backup cache via fall-back (CRconfig's
``edgeLocation``) or via coordinates (:abbr:`CZF (Coverage Zone File)`)
configuration
+ Traffic Router found a backup cache via fall-back (through the
``edgeLocation`` field of a :term:`Snapshot`) or via coordinates
(:term:`Coverage Zone File`) configuration
DS_CZ_ONLY
The selected :term:`Delivery Service` only supports resource lookup
based on coverage zone data
DS_NO_BYPASS
diff --git a/docs/source/api/cachegroups_id_queue_update.rst
b/docs/source/api/cachegroups_id_queue_update.rst
index 89f95fe..51bbf45 100644
--- a/docs/source/api/cachegroups_id_queue_update.rst
+++ b/docs/source/api/cachegroups_id_queue_update.rst
@@ -21,7 +21,7 @@
``POST``
========
-Queue or dequeue updates for all servers assigned to a :term:`Cache Group`
limited to a specific CDN.
+:term:`Queue` or "dequeue" updates for all servers assigned to a :term:`Cache
Group` limited to a specific CDN.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -38,8 +38,8 @@ Request Structure
+------+---------------------------------------------------------------------------------------------------------+
:action: The action to perform; one of "queue" or "dequeue"
-:cdn: The full name of the CDN in need of update queue/dequeue\ [1]_
-:cdnId: The integral, unique identifier for the CDN in need of update
queue/dequeue\ [1]_
+:cdn: The full name of the CDN in need of :term:`Queue Updates`, or a
"dequeue" thereof\ [#required]_
+:cdnId: The integral, unique identifier for the CDN in need of :term:`Queue
Updates`, or a "dequeue" thereof\ [#required]_
.. code-block:: http
:caption: Request Example
@@ -54,12 +54,11 @@ Request Structure
{"action": "queue", "cdn": "CDN-in-a-Box"}
-.. [1] Either 'cdn' or 'cdnID' *must* be in the request data (but not both).
Response Structure
------------------
:action: The action processed, one of "queue" or "dequeue"
-:cachegroupId: The integral, unique identifier of the :term:`Cache Group`
for which updates were queued/dequeued
+:cachegroupId: The integral, unique identifier of the :term:`Cache Group`
for which :term:`Queue Updates` was performed or cleared
:cachegroupName: The name of the :term:`Cache Group` for which updates were
queued/dequeued
:cdn: The name of the CDN to which the queue/dequeue operation was
restricted
:serverNames: An array of the (short) hostnames of the servers within the
:term:`Cache Group` which are also assigned to the CDN specified in the
``"cdn"`` field
@@ -88,3 +87,5 @@ Response Structure
"cdn": "CDN-in-a-Box",
"cachegroupID": 8
}}
+
+.. [#required] Either 'cdn' or 'cdnID' *must* be in the request data (but not
both).
diff --git a/docs/source/api/cdns_id_queue_update.rst
b/docs/source/api/cdns_id_queue_update.rst
index a83c79c..79ea2ad 100644
--- a/docs/source/api/cdns_id_queue_update.rst
+++ b/docs/source/api/cdns_id_queue_update.rst
@@ -21,7 +21,7 @@
``POST``
========
-Queue or dequeue updates for all servers assigned to a specific CDN.
+:term:`Queue` or "dequeue" updates for all servers assigned to a specific CDN.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -55,7 +55,7 @@ Request Structure
Response Structure
------------------
:action: The action processed, either ``"queue"`` or ``"dequeue"``
-:cdnId: The integral, unique identifier for the CDN on which updates were
(de)queued
+:cdnId: The integral, unique identifier for the CDN on which :term:`Queue
Updates` was performed or cleared
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/cdns_id_snapshot.rst
b/docs/source/api/cdns_id_snapshot.rst
index b7076de..d7df4ca 100644
--- a/docs/source/api/cdns_id_snapshot.rst
+++ b/docs/source/api/cdns_id_snapshot.rst
@@ -23,7 +23,7 @@
``PUT``
=======
-Performs a CDN snapshot. Effectively, this propagates the new *configuration*
of the CDN to its *operating state*, which replaces the output of the
:ref:`to-api-cdns-name-snapshot` endpoint with the output of the
:ref:`to-api-cdns-name-snapshot-new` endpoint.
+Performs a CDN :term:`Snapshot`. Effectively, this propagates the new
*configuration* of the CDN to its *operating state*, which replaces the output
of the :ref:`to-api-cdns-name-snapshot` endpoint with the output of the
:ref:`to-api-cdns-name-snapshot-new` endpoint.
.. Note:: Snapshotting the CDN also deletes all HTTPS certificates for every
:term:`Delivery Service` which has been deleted since the last CDN
:term:`Snapshot`.
@@ -35,11 +35,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
-
+------+--------------------------------------------------------------------------------+
- | Name | Description
|
-
+======+================================================================================+
- | ID | The integral, unique identifier of the CDN for which a
snapshot shall be taken |
-
+------+--------------------------------------------------------------------------------+
+
+------+----------------------------------------------------------------------------------------+
+ | Name | Description
|
+
+======+========================================================================================+
+ | ID | The integral, unique identifier of the CDN for which a
:term:`Snapshot` shall be taken |
+
+------+----------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/cdns_name_configs_monitoring.rst
b/docs/source/api/cdns_name_configs_monitoring.rst
index b3e1665..7952d25 100644
--- a/docs/source/api/cdns_name_configs_monitoring.rst
+++ b/docs/source/api/cdns_name_configs_monitoring.rst
@@ -57,7 +57,7 @@ Response Structure
:health.polling.interval: An interval in milliseconds on which to
poll for health statistics
:health.threadPool: The number of threads to be used for
health polling
:health.timepad: A 'padding time' to add to requests to
spread them out for Traffic Control systems that use a large number of Traffic
Monitors
- :tm.crConfig.polling.url: The URL from which a CRConfig can be
obtained
+ :tm.crConfig.polling.url: The URL from which a :term:`Snapshot` can
be obtained
:tm.dataServer.polling.url: The URL from which a list of data servers
can be obtained
:tm.healthParams.polling.url: The URL from which a list of
health-polling parameters can be obtained
:tm.polling.interval: The interval at which to poll for
configuration updates
diff --git a/docs/source/api/cdns_name_snapshot.rst
b/docs/source/api/cdns_name_snapshot.rst
index 846c6bd..58e8b13 100644
--- a/docs/source/api/cdns_name_snapshot.rst
+++ b/docs/source/api/cdns_name_snapshot.rst
@@ -22,7 +22,7 @@
``GET``
=======
-Retrieves the *current* snapshot for a CDN, which represents the current
*operating state* of the CDN, **not** the current *configuration* of the CDN.
The contents of this snapshot are currently used by Traffic Monitor and Traffic
Router.
+Retrieves the *current* :term:`Snapshot` for a CDN, which represents the
current *operating state* of the CDN, **not** the current *configuration* of
the CDN. The contents of this :term:`Snapshot` are currently used by Traffic
Monitor and Traffic Router.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -32,11 +32,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+------------------------------------------------------------+
- | Name | Description |
- +======+============================================================+
- | name | The name of the CDN for which a snapshot shall be returned |
- +------+------------------------------------------------------------+
+
+------+--------------------------------------------------------------------+
+ | Name | Description
|
+
+======+====================================================================+
+ | name | The name of the CDN for which a :term:`Snapshot` shall be
returned |
+
+------+--------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -316,7 +316,7 @@ Response Structure
:CDN_name: The name of this CDN
:date: The UNIX epoch timestamp date in the Traffic Ops server's
own timezone
:tm_host: The FQDN of the Traffic Ops server
- :tm_path: A path relative to the root of the Traffic Ops server where
a request may be replaced to have this snapshot overwritten by the current
*configured state* of the CDN
+ :tm_path: A path relative to the root of the Traffic Ops server where
a request may be replaced to have this :term:`Snapshot` overwritten by the
current *configured state* of the CDN
.. deprecated:: 1.1
This field is still present for legacy compatibility
reasons, but its contents should be ignored. Instead, make a ``PUT`` request to
:ref:`to-api-snapshot-name`.
diff --git a/docs/source/api/cdns_name_snapshot_new.rst
b/docs/source/api/cdns_name_snapshot_new.rst
index 352e771..c866c71 100644
--- a/docs/source/api/cdns_name_snapshot_new.rst
+++ b/docs/source/api/cdns_name_snapshot_new.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Retrieves the *pending* snapshot for a CDN, which represents the current
*configuration* of the CDN, **not** the current *operating state* of the CDN.
The contents of this snapshot are currently used by Traffic Monitor and Traffic
Router.
+Retrieves the *pending* :term:`Snapshot` for a CDN, which represents the
current *configuration* of the CDN, **not** the current *operating state* of
the CDN. The contents of this :term:`Snapshot` are currently used by Traffic
Monitor and Traffic Router.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,11 +31,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+------------------------------------------------------------+
- | Name | Description |
- +======+============================================================+
- | name | The name of the CDN for which a snapshot shall be returned |
- +------+------------------------------------------------------------+
+
+------+--------------------------------------------------------------------+
+ | Name | Description
|
+
+======+====================================================================+
+ | name | The name of the CDN for which a :term:`Snapshot` shall be
returned |
+
+------+--------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -315,7 +315,7 @@ Response Structure
:CDN_name: The name of this CDN
:date: The UNIX epoch timestamp date in the Traffic Ops server's
own timezone
:tm_host: The FQDN of the Traffic Ops server
- :tm_path: A path relative to the root of the Traffic Ops server where
a request may be replaced to have this snapshot overwritten by the current
*configured state* of the CDN
+ :tm_path: A path relative to the root of the Traffic Ops server where
a request may be replaced to have this :term:`Snapshot` overwritten by the
current *configured state* of the CDN
.. deprecated:: 1.1
This field is still present for legacy compatibility
reasons, but its contents should be ignored. Instead, make a ``PUT`` request to
:ref:`to-api-snapshot-name`.
diff --git a/docs/source/api/servers_id_queue_update.rst
b/docs/source/api/servers_id_queue_update.rst
index 383e4a3..1ac729a 100644
--- a/docs/source/api/servers_id_queue_update.rst
+++ b/docs/source/api/servers_id_queue_update.rst
@@ -18,12 +18,11 @@
*******************************
``servers/{{ID}}/queue_update``
*******************************
-.. deprecated:: 1.1
- Use the ``PUT`` method of the :ref:`to-api-servers-id` endpoint instead.
+.. caution:: In the vast majority of cases, it is advisable that the ``PUT``
method of the :ref:`to-api-servers-id` endpoint be used instead.
``POST``
========
-Queue or dequeue updates for a specific server.
+:term:`Queue` or dequeue updates for a specific server.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -42,7 +41,7 @@ Request Structure
:action: A string describing what action to take regarding server updates; one
of:
queue
- Enqueue updates for the server, propagating configuration
changes to the actual server
+ :term:`Queue Updates` for the server, propagating configuration
changes to the actual server
dequeue
Cancels any pending updates on the server
@@ -66,7 +65,7 @@ Response Structure
:action: The action processed, one of:
queue
- Enqueued updates for the server, propagating configuration
changes to the actual server
+ :term:`Queue Updates` was performed on the server, propagating
configuration changes to the actual server
dequeue
Canceled any pending updates on the server
diff --git a/docs/source/api/snapshot_name.rst
b/docs/source/api/snapshot_name.rst
index 0141bf1..19377b4 100644
--- a/docs/source/api/snapshot_name.rst
+++ b/docs/source/api/snapshot_name.rst
@@ -21,7 +21,7 @@
``PUT``
=======
-Performs a CDN snapshot. Effectively, this propagates the new *configuration*
of the CDN to its *operating state*, which replaces the output of the
:ref:`to-api-cdns-name-snapshot` endpoint with the output of the
:ref:`to-api-cdns-name-snapshot-new` endpoint.
+Performs a CDN :term:`Snapshot`. Effectively, this propagates the new
*configuration* of the CDN to its *operating state*, which replaces the output
of the :ref:`to-api-cdns-name-snapshot` endpoint with the output of the
:ref:`to-api-cdns-name-snapshot-new` endpoint.
.. Note:: Snapshotting the CDN also deletes all HTTPS certificates for every
:term:`Delivery Service` which has been deleted since the last :term:`Snapshot`.
@@ -33,11 +33,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+---------------------------------------------------------+
- | Name | Description |
- +======+=========================================================+
- | name | The name of the CDN for which a snapshot shall be taken |
- +------+---------------------------------------------------------+
+
+------+-----------------------------------------------------------------+
+ | Name | Description
|
+
+======+=================================================================+
+ | name | The name of the CDN for which a :term:`Snapshot` shall be
taken |
+
+------+-----------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index 5185a46..c5cc845 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -322,15 +322,28 @@ Glossary
.. warning:: For legacy reasons, the names of Profiles
of this type *must* begin with ``ELASTICSEARCH``. This is **not** enforced by
the :ref:`to-api` or Traffic Portal, but certain Traffic Control
operations/components expect this and will fail to work otherwise!
ATS_PROFILE
- A Profile that can be used with either an Edge-tier or
Mid-tier :term:`cache server`\ ` (but not both, in general).
+ A Profile that can be used with either an Edge-tier or
Mid-tier :term:`cache server` (but not both, in general).
.. warning:: For legacy reasons, the names of Profiles
of this type *must* begin with ``EDGE`` or ``MID``. This is **not** enforced by
the :ref:`to-api` or Traffic Portal, but certain Traffic Control
operations/components expect this and will fail to work otherwise!
- .. tip:: A :dfn:`Profile` of the wrong type assigned to a
Traffic Control component *will* (in general) cause it to function incorrectly,
regardless of the :term:`Parameter`\ s assigned to it.
+ .. tip:: A :dfn:`Profile` of the wrong type assigned to a
Traffic Control component *will* (in general) cause it to function incorrectly,
regardless of the :term:`Parameters` assigned to it.
.. danger:: Nearly all of these :dfn:`Profile` types have
strict naming requirements, and it may be noted that some of said requirements
are prefixes ending with ``_``, while others are either not prefixes or do not
end with ``_``. This is exactly true; some requirements **need** that ``_`` and
some may or may not have it. It is our suggestion, therefore, that for the time
being all prefixes use the ``_`` notation to separate words, so as to avoid
causing headaches remembering when tha [...]
+ Queue
+ Queue Updates
+ Queue Server Updates
+ :dfn:`Queuing Updates` is an action that signals to various ATC
components - most notably :term:`cache servers` - that any configuration
changes that are pending are to be applied now. Specifically, Traffic Monitor
and Traffic Router are updated through a CDN :term:`Snapshot`, and *not*
:dfn:`Queued Updates`. In particular, :term:`ORT` will notice that the server
on which it's running has new configuration, and will request the new
configuration from Traffic Ops.
+
+ Updates may be queued on a server-by-server basis (in Traffic
Portal's :ref:`tp-configure-servers` view), a Cache Group-wide basis (in
Traffic Portal's :ref:`tp-configure-cache-groups` view), or on a CDN-wide basis
(in Traffic Portal's :ref:`tp-cdns` view). Usually using the CDN-wide version
is easiest, and unless there are special circumstances, and/or the user really
knows what he or she is doing, it is recommended that the full CDN-wide
:dfn:`Queue Updates` be used.
+
+ This is similar to taking a CDN :term:`Snapshot`, but this
configuration change affects only servers, and not routing.
+
+ That seems like a vague difference because it is - in general
the rule to follow is that changes to :term:`Profiles` and :term:`Parameters`
requires only updates be queued, changes to the assignments of :term:`cache
servers` to :term:`Delivery Services` requires both a :term:`Snapshot` *and* a
:dfn:`Queue Updates`, and changes to only a :term:`Delivery Service` itself
(usually) entails a :term:`Snapshot` only. These aren't exhaustive rules, and a
grasp of what changes require which act [...]
+
+ .. warning:: Updates to :term:`Parameters` with certain
"configFile" values may require running :term:`ORT` in a different mode,
occasionally manually. Though the server may appear to no longer have pending
updates in these cases, until this manual intervention is performed the
configuration *will* **not** *be correct*.
+
Region
Regions
A group of :term:`Physical Location`\ s.
diff --git a/docs/source/overview/delivery_services.rst
b/docs/source/overview/delivery_services.rst
index 653e1e4..7fd4d35 100644
--- a/docs/source/overview/delivery_services.rst
+++ b/docs/source/overview/delivery_services.rst
@@ -26,7 +26,7 @@ Delivery Services are modeled several times over, in the
Traffic Ops database, i
Active
------
-Whether or not this Delivery Service is active on the CDN and can be served.
When a Delivery Service is not "active", Traffic Router will not be made aware
of its existence - i.e. it will not appear in CDN :term:`Snapshot`\ s. Setting
a Delivery Service to be "active" (or "inactive") will require that a new
:term:`Snapshot` be taken.
+Whether or not this Delivery Service is active on the CDN and can be served.
When a Delivery Service is not "active", Traffic Router will not be made aware
of its existence - i.e. it will not appear in CDN :term:`Snapshots`. Setting a
Delivery Service to be "active" (or "inactive") will require that a new
:term:`Snapshot` be taken.
Anonymous Blocking
------------------
diff --git a/docs/source/tools/compare.rst b/docs/source/tools/compare.rst
index 4a12634..107940a 100644
--- a/docs/source/tools/compare.rst
+++ b/docs/source/tools/compare.rst
@@ -82,7 +82,7 @@ traffic_ops/testing/compare/compare.go
Print version information and exit
.. versionchanged:: 3.0.0
- Removed the ``-s`` command line switch to compare CDN :term:`Snapshot`\
s - this is now the responsibility of the :program:`genConfigRoutes.py` script.
+ Removed the ``-s`` command line switch to compare CDN :term:`Snapshots`
- this is now the responsibility of the :program:`genConfigRoutes.py` script.
.. program:: genConfigRoutes.py
