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/07/17 14:54:23 UTC
[trafficcontrol] branch master updated: Pulled Profiles/Parameters
docs out of TO UI and added it as an overview section (#3714)
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 2ccc46a Pulled Profiles/Parameters docs out of TO UI and added it as an overview section (#3714)
2ccc46a is described below
commit 2ccc46a36e69ed81ab81bdcce70b3ed5f912c71c
Author: ocket8888 <oc...@gmail.com>
AuthorDate: Wed Jul 17 09:54:15 2019 -0500
Pulled Profiles/Parameters docs out of TO UI and added it as an overview section (#3714)
---
.../admin/quick_howto/anonymous_blocking.rst | 2 +-
docs/source/admin/quick_howto/multi_site.rst | 8 +-
docs/source/admin/quick_howto/regionalgeo.rst | 2 +-
docs/source/admin/traffic_ops/configuration.rst | 168 +-----
docs/source/admin/traffic_ops/using.rst | 142 +----
.../admin/traffic_portal/default_profiles.rst | 46 --
.../admin/traffic_portal/usingtrafficportal.rst | 46 +-
docs/source/admin/traffic_router.rst | 151 ++++-
docs/source/admin/traffic_stats.rst | 6 +-
.../api/cachegroup_parameterID_parameter.rst | 8 +-
docs/source/api/cachegroupparameters.rst | 18 +-
.../api/cachegroupparameters_id_parameterID.rst | 16 +-
docs/source/api/cachegroups_id_parameters.rst | 16 +-
.../api/cachegroups_id_unassigned_parameters.rst | 27 +-
...cachegroups_parameterID_parameter_available.rst | 4 +-
docs/source/api/caches_stats.rst | 2 +-
docs/source/api/cdns_domains.rst | 10 +-
docs/source/api/cdns_name_configs_monitoring.rst | 14 +-
docs/source/api/cdns_name_snapshot.rst | 8 +-
docs/source/api/cdns_name_snapshot_new.rst | 21 +-
docs/source/api/deliveryservices.rst | 97 ++-
docs/source/api/deliveryservices_id.rst | 57 +-
docs/source/api/deliveryservices_id_safe.rst | 6 +-
docs/source/api/deliveryservices_id_servers.rst | 6 +-
.../api/deliveryservices_id_servers_eligible.rst | 6 +-
.../api/deliveryservices_id_unassigned_servers.rst | 6 +-
docs/source/api/origins.rst | 56 +-
docs/source/api/osversions.rst | 4 +-
docs/source/api/parameterprofile.rst | 14 +-
docs/source/api/parameters.rst | 62 +-
docs/source/api/parameters_id.rst | 48 +-
docs/source/api/parameters_id_profiles.rst | 30 +-
.../api/parameters_id_unassigned_profiles.rst | 30 +-
docs/source/api/parameters_profile_name.rst | 26 +-
docs/source/api/parameters_validate.rst | 26 +-
docs/source/api/profileparameter.rst | 17 +-
docs/source/api/profileparameters.rst | 36 +-
.../profileparameters_profileID_parameterID.rst | 16 +-
docs/source/api/profiles.rst | 66 +--
docs/source/api/profiles_id.rst | 97 ++-
docs/source/api/profiles_id_parameters.rst | 74 +--
.../api/profiles_id_unassigned_parameters.rst | 26 +-
docs/source/api/profiles_name_name_copy_copy.rst | 26 +-
docs/source/api/profiles_name_name_parameters.rst | 71 +--
.../profiles_profile_configfiles_ats_filename.rst | 16 +-
docs/source/api/profiles_trimmed.rst | 2 +-
docs/source/api/servers.rst | 16 +-
docs/source/api/servers_hostname_name_details.rst | 4 +-
docs/source/api/servers_id.rst | 14 +-
docs/source/api/servers_id_deliveryservices.rst | 8 +-
docs/source/api/servers_server_configfiles_ats.rst | 6 +-
docs/source/api/system_info.rst | 2 +-
docs/source/api/users_id_deliveryservices.rst | 6 +-
.../development/documentation_guidelines.rst | 2 +-
.../traffic_router/traffic_router_api.rst | 2 +-
docs/source/glossary.rst | 80 +--
docs/source/overview/delivery_services.rst | 2 +-
docs/source/overview/index.rst | 11 +-
docs/source/overview/profiles_and_parameters.rst | 651 +++++++++++++++++++++
59 files changed, 1381 insertions(+), 1059 deletions(-)
diff --git a/docs/source/admin/quick_howto/anonymous_blocking.rst b/docs/source/admin/quick_howto/anonymous_blocking.rst
index 166f47a..3a1bce1 100644
--- a/docs/source/admin/quick_howto/anonymous_blocking.rst
+++ b/docs/source/admin/quick_howto/anonymous_blocking.rst
@@ -50,7 +50,7 @@ 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 with the "CRConfig.json" "Config File", and ensure they are assigned to all of the Traffic Routers that should perform Anonymous Blocking:
+#. Add the following three Anonymous Blocking :ref:`Parameters` in Traffic Portal with the "CRConfig.json" :ref:`parameter-config-file`, and ensure they are assigned to all of the Traffic Routers that should perform Anonymous Blocking:
``anonymousip.policy.configuration``
The URL of the Anonymous Blocking configuration file. Traffic Router will fetch the file from this URL.
diff --git a/docs/source/admin/quick_howto/multi_site.rst b/docs/source/admin/quick_howto/multi_site.rst
index f919e6b..565f39c 100644
--- a/docs/source/admin/quick_howto/multi_site.rst
+++ b/docs/source/admin/quick_howto/multi_site.rst
@@ -58,15 +58,15 @@ The following steps will take you through the procedure of setting up an :abbr:`
- This :abbr:`OSBU (Origin Server Base URL)` must be valid - :abbr:`ATS (Apache Traffic Server)` will perform a DNS lookup on this :abbr:`FQDN (Fully Qualified Domain Name)` even if IPs, not DNS, are used in the :file:`parent.config`.
- The :abbr:`OSBU (Origin Server Base URL)` entered as the "Origin Server Base URL" will be sent to the origins as a host header. All origins must be configured to respond to this host.
-#. Create a delivery service profile. This must be done to set the :abbr:`MSO (Multi-Site Origin)` algorithm. Also, as of :abbr:`ATS (Apache Traffic Server)` 6.x, multi-site options must be set as parameters within the :file:`parent.config`. Header rewrite parameters will be ignored. See `ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html>`_ for more details. These parameters are now handled by the creation of a :term:`Delivery Servi [...]
+#. Create a delivery service profile. This must be done to set the :abbr:`MSO (Multi-Site Origin)` algorithm. Also, as of :abbr:`ATS (Apache Traffic Server)` 6.x, multi-site options must be set as parameters within the :file:`parent.config`. Header rewrite parameters will be ignored. See `ATS parent.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/parent.config.en.html>`_ for more details. These :term:`Parameters` are now handled by the creation of a :term:`Delive [...]
- a) Create a profile of the type ``DS_PROFILE`` for the :term:`Delivery Service` in question.
+ a) Create a :term:`Profile` of the :ref:`profile-type` ``DS_PROFILE`` for the :term:`Delivery Service` in question.
.. figure:: multi_site/ds_profile.png
:scale: 50%
:align: center
- #) Click :guilabel:`Show profile parameters` to bring up the parameters screen for the profile. Create parameters for the following:
+ #) Click :guilabel:`Show profile parameters` to bring up the :term:`Parameters` screen for the :term:`Profile`. Create the following :term:`Parameters`:
+----------------------------------------+------------------+--------------------------+-------------------------+
| Parameter Name | Config File Name | Value | ATS parent.config value |
@@ -97,6 +97,6 @@ The following steps will take you through the procedure of setting up an :abbr:`
#) In the :term:`Delivery Service` page, select the newly created ``DS_PROFILE`` and save the :term:`Delivery Service`.
-#. Turn on parent_proxy_routing in the MID profile.
+#. Turn on parent_proxy_routing in the MID :term:`Profile`.
.. Note:: Support for multisite configurations with single-layer CDNs is now available. If a :term:`Cache Group`\ s defined parents are either blank or of the type ``ORG_LOC``, that :term:`cache server`'s ``parent.config`` will be generated as a top layer cache, even if it is an edge. In the past, ``parent.config`` generation was strictly determined by cache type. The new method examines the parent :term:`Cache Group` definitions and generates the :file:`parent.config` accordingly.
diff --git a/docs/source/admin/quick_howto/regionalgeo.rst b/docs/source/admin/quick_howto/regionalgeo.rst
index 33e8198..121518b 100644
--- a/docs/source/admin/quick_howto/regionalgeo.rst
+++ b/docs/source/admin/quick_howto/regionalgeo.rst
@@ -56,7 +56,7 @@ Configure Regional Geo-blocking (RGB)
An optional element that is an array of :abbr:`CIDR (Classless Inter-Domain Routing)` blocks indicating the IPv4 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the :abbr:`CIDR (Classless Inter-Domain Routing)` list, bypassing the value of ``geoLocation``. If there is no match in the white list, Traffic Router defers to the value of ``geoLocation`` to determine if content ought to be blocked.
-#. Add :abbr:`RGB (Regional Geographic-based Blocking)` parameters in Traffic Portal to the :term:`Delivery Service`'s Traffic Router(s)'s profile(s). The ``configFile`` field should be set to ``CRConfig.json``, and the following two parameter name/values need to be specified:
+#. Add :abbr:`RGB (Regional Geographic-based Blocking)` :term:`Parameters` in Traffic Portal to the :term:`Delivery Service`'s Traffic Router(s)'s :term:`Profile`\ (s). The :ref:`parameter-config-file` value should be set to ``CRConfig.json``, and the following two :term:`Parameter` :ref:`parameter-name`/:ref:`parameter-value` pairs need to be specified:
``regional_geoblocking.polling.url``
The URL of the RGB configuration file. Traffic Router will fetch the file from this URL using an HTTP ``GET`` request.
diff --git a/docs/source/admin/traffic_ops/configuration.rst b/docs/source/admin/traffic_ops/configuration.rst
index 8d75494..fc9d232 100644
--- a/docs/source/admin/traffic_ops/configuration.rst
+++ b/docs/source/admin/traffic_ops/configuration.rst
@@ -130,147 +130,6 @@ You will need to update the file :file:`/opt/traffic_ops/app/conf/cdn.conf` with
...
-Content Delivery Networks
-=========================
-
-.. _param-prof:
-
-Profile Parameters
-------------------
-Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the :menuselection:`Configure --> Parameters` view of Traffic Portal. Parameters are grouped in profiles and profiles are assigned to a server or a :term:`Delivery Service`. For a typical cache there are hundreds of configuration settings to apply. The Traffic Portal :menuselection:`Parameters` view contains the defined settings. To make life easier, Traffic Portal allows for duplicati [...]
-
-.. _global-profile-parameters:
-.. table:: Global Profile Parameters
-
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | Name | ConfigFile | Value |
- +==========================+===============+=======================================================================================================================================+
- | tm.url | global | The URL at which this Traffic Ops instance services requests |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.rev_proxy.url | global | Not required. The URL where a caching proxy for configuration files generated by Traffic Ops may be found. Requires a minimum |
- | | | :term:`ORT` version of 2.1. When configured, :term:`ORT` will request configuration files via this |
- | | | :abbr:`FQDN (Fully Qualified Domain Name)`, which should be set up as a reverse proxy to the Traffic Ops server(s). The suggested |
- | | | cache lifetime for these files is 3 minutes or less. This setting allows for greater scalability of a CDN maintained by Traffic Ops |
- | | | by caching configuration files of profile and CDN scope, as generating these is a very computationally expensive process |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops" - this will appear in the comment headers of the generated files |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.infourl | global | This is the "for more information go here" URL, which used to be visible in the "About" page of the now-deprecated Traffic Ops UI |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.logourl | global | This is the URL of the logo for Traffic Ops and can be relative if the logo is under :file:`traffic_ops/app/public` |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.instance_name | global | The name of the Traffic Ops instance - typically to distinguish instances when multiple are active |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | tm.traffic_mon_fwd_proxy | global | When collecting stats from Traffic Monitor, Traffic Ops will use this forward proxy instead of the actual Traffic Monitor host. |
- | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
- | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
- | | | set this parameter on a production system. |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | geolocation.polling.url | CRConfig.json | The location of a geographic IP mapping database for Traffic Router instances to use |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | geolocation6.polling.url | CRConfig.json | The location of a geographic IPv6 mapping database for Traffic Router instances to use |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
- | maxmind.default.override | CRConfig.json | The destination geographic coordinates to use for client location when the geographic IP mapping database returns a default location |
- | | | that matches the country code. This parameter can be specified multiple times with different values to support default overrides for |
- | | | multiple countries. The reason for the name "maxmind" is because MaxMind's GeoIP2 database is the default geographic IP mapping |
- | | | database implementation used by Comcast production servers (and the only officially supported implementation at the time of this |
- | | | writing). The format of this Parameter's value is: ``<Country Code>;<Latitude>,<Longitude>``, e.g. ``US;37.751,-97.822`` |
- +--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-
-These parameters should be set to reflect the local environment.
-
-After running the :program:`postinstall` script, Traffic Ops has the :ref:`tbl-default-profiles` pre-loaded.
-
-.. _tbl-default-profiles:
-.. table:: Default Profiles
-
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +==========+=================================================================================================================================================+
- | EDGE1 | The profile to be applied to the latest supported version of :abbr:`ATS (Apache Traffic Server)`, when running as an Edge-tier cache |
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | TR1 | The profile to be applied to the latest version of Traffic Router |
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | TM1 | The profile to be applied to the latest version of Traffic Monitor |
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | MID1 | The profile to be applied to the latest supported version of :abbr:`ATS (Apache Traffic Server)`, when running as a Mid-tier cache |
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
- | RIAK_ALL | "Riak" profile for all CDNs to be applied to the Traffic Vault servers ("Riak" being the name of the underlying database used by Traffic Vault) |
- +----------+-------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. Note:: The "EDGE1" and "MID1" profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to "mix-and-match" different hardware configurations. The :ref:`cache-server-hardware-parameters` table tabulates the cache parameters that are likely to need changes f [...]
-
-.. _cache-server-hardware-parameters:
-.. table:: Cache Server Hardware Parameters
-
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | ConfigFile | Description |
- +===========================================+===================+==============================================================================================================================================+
- | allow_ip | astats.config | This is a comma-separated list of IPv4 :abbr:`CIDR (Classless Inter-Domain Routing)` blocks that will have access to the 'astats' statistics |
- | | | on the cache servers. The Traffic Monitor IP addresses have to be included in this if they are using IPv4 to monitor the cache servers |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | allow_ip6 | astats.config | This is a comma-separated list of IPv6 :abbr:`CIDR (Classless Inter-Domain Routing)` blocks that will have access to the 'astats' statistics |
- | | | on the cache servers. The Traffic Monitor IP addresses have to be included in this if they are using IPv6 to monitor the cache servers |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Drive_Prefix | storage.config | The device path start of the disks. For example, if storage devices ``/dev/sda`` through ``/dev/sdf`` are to be used for caching, this |
- | | | should be set to ``/dev/sd`` |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Drive_Letters | storage.config | A comma-separated list of the letter part of the storage devices to be used for caching. For example, if storage devices ``/dev/sda`` |
- | | | through ``/dev/sdf`` are to be used for caching, this should be set to ``a,b,c,d,e,f`` |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`purge`) |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | coalesce_masklen_v4 | ip_allow.config | The mask length to use when coalescing IPv4 networks into one line using |
- | | | `the NetAddr\:\:IP Perl library <http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm>`_ |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | coalesce_number_v4 | ip_allow.config | The number to use when coalescing IPv4 networks into one line using |
- | | | `the NetAddr\:\:IP Perl library <http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm>`_ |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | coalesce_masklen_v6 | ip_allow.config | The mask length to use when coalescing IPv6 networks into one line using |
- | | | `the NetAddr\:\:IP Perl library. <http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm>`_ |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | health.threshold.loadavg | rascal.properties | The Unix 'load average' (as given by :manpage:`uptime(1)`) at which Traffic Router will stop sending traffic to this cache |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | health.threshold.availableBandwidthInKbps | rascal.properties | The amount of bandwidth (in kilobits per second) that Traffic Router will try to keep available on the cache. For example ">1500000" means |
- | | | "stop sending new traffic to this cache server when traffic is at 8.5Gbps on a 10Gbps interface" |
- +-------------------------------------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------+
-
-The :ref:`plugin-parameters` table contains all Traffic Server plug-ins that must be configured as global parameters.
-
-.. _plugin-parameters:
-.. table:: Plugin Parameters
-
- +------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | ConfigFile | Description |
- +==================+===============+===========================================================================================================================================+
- | astats_over_http | package | The package version for the :abbr:`ATS (Apache Traffic Server)` |
- | | | `astats_over_http plugin <https://github.com/apache/trafficcontrol/tree/master/traffic_server/plugins/astats_over_http>`_ |
- +------------------+---------------+----------------------------------------------------------+--------------------------------------------------------------------------------+
- | trafficserver | package | The package version of :abbr:`ATS (Apache Traffic Server)` |
- +------------------+---------------+----------------------------------------------------------+--------------------------------------------------------------------------------+
- | regex_revalidate | plugin.config | The configuration to be used for the :abbr:`ATS (Apache Traffic Server)` `regex_revalidate plugin`_ |
- +------------------+---------------+----------------------------------------------------------+--------------------------------------------------------------------------------+
- | remap_stats | plugin.config | The configuration to be used for the :abbr:`ATS (Apache Traffic Server)` |
- | | | `remap_stats plugin <https://github.com/apache/trafficserver/tree/master/plugins/experimental/remap_stats>`_ - value should be left blank |
- +------------------+---------------+-------------------------------------------------------------------------------------------------------------------------------------------+
-
-Cache server parameters for special configurations, which are unlikely to need changes but may be useful in particular circumstances, may be found in the :ref:`special-parameters` table.
-
-.. _special-parameters:
-.. table:: Special Parameters
-
- +--------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | ConfigFile | Description |
- +==============+===================+=============================================================================================================================================================================+
- | not_a_parent | parent.config | This is a boolean flag and is considered ``true`` if it exists and has any value except ``false``. This prevents cache servers with this parameter in their profile from being |
- | | | inserted into the ``parent.config`` files generated for other cache servers that have the affected cache server(s)'s :term:`Cache Group` as a parent of their own |
- | | | :term:`Cache Group`. This is primarily useful for when Edge-tier cache servers are configured to have a :term:`Cache Group` of other Edge-tier cache servers as parents (a |
- | | | highly unusual configuration), and it is necessary to exclude some - but not all - Edge-tier cache servers in the parent :term:`Cache Group` from the ``parent.config`` (for |
- | | | example because they lack necessary capabilities), but still have all Edge-tier cache servers in the same :term:`Cache Group` in order to take traffic from ordinary |
- | | | :term:`Delivery Service`\ s at that :term:`Cache Group`\ 's geographic location. Once again, this is a highly unusual scenario, and under ordinary circumstances this parameter |
- | | | should not exist. |
- +--------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
Regions, Locations and Cache Groups
===================================
All servers have to have a :term:`Physical Location`, which defines their geographic latitude and longitude. Each :term:`Physical Location` is part of a :term:`Region`, and each :term:`Region` is part of a :term:`Division`. For example, ``Denver`` could be the name of a :term:`Physical Location` in the ``Mile High`` :term:`Region` and that :term:`Region` could be part of the ``West`` :term:`Division`. The hierarchy between these terms is illustrated graphically in :ref:`topography-hierarchy`.
@@ -289,32 +148,7 @@ All servers also have to be part of a :term:`Cache Group`. A :term:`Cache Group`
Configuring Content Purge
=========================
-Purging cached content using :abbr:`ATS (Apache Traffic Server)` is not simple; there is no file system from which to delete files and/or directories, and in large caches it can be hard to delete content matching a simple regular expression from the cache. This is why Traffic Control uses the `Regex Revalidate Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html>`_ to purge content from the cache. The cached content is not actually removed, [...]
-
-.. _content-purge-parameters:
-.. table:: Content Purge Parameters
-
- +----------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | ConfigFile | Description |
- +======================+=========================+================================================================================================================================================================+
- | location | regex_revalidate.config | Where in the file system the ``regex_revalidate.config`` file should located on the cache server. The presence of this parameter tells ORT to distribute this |
- | | | file; delete this parameter from the profile if this file is distributed using other means |
- +----------------------+-------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | maxRevalDurationDays | regex_revalidate.config | The maximum duration for which a purge shall be active. To prevent a build-up of many checks before each request, this is longest duration (in days) for which |
- | | | the system will allow content purges to remain active |
- +----------------------+-------------------------+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
- | regex_revalidate | plugin.config | The configuration to be used for the `regex_revalidate plugin`_ |
- +----------------------+-------------------------+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
- | use_reval_pending | global | Configures Traffic Ops to use a separate ``reval_pending`` flag for each cache server. When this flag is in use :term:`ORT` will check for a new |
- | | | ``regex_revalidate.config`` every 60 seconds in "SYNCDS" mode during the dispersal timer. This will also allow :term:`ORT` to be run in "REVALIDATE" mode, |
- | | | which will check for and clear the ``reval_pending`` flag. This can be set to run via :manpage:`cron(8)` task. Enable with a value of ``1``. |
- +----------------------+-------------------------+--------------------------------------------------+-------------------------------------------------------------------------------------------------------------+
-
-.. versionadded:: 2.1
- ``use_reval_pending`` was unavailable prior to Traffic Ops version 2.1.
-
-
-.. Note:: The :abbr:`TTL (Time To Live)` entered by the administrator in the purge request should be longer than the :abbr:`TTL (Time To Live)` of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited :abbr:`TTL (Time To Live)`, the administrator should consider using `proxy-config-http-cache-guaranteed-min-lifetime <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-gua [...]
+Purging cached content using :abbr:`ATS (Apache Traffic Server)` is not simple; there is no file system from which to delete files and/or directories, and in large caches it can be hard to delete content matching a simple regular expression from the cache. This is why Traffic Control uses the `Regex Revalidate Plugin <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/plugins/regex_revalidate.en.html>`_ to purge content from the cache. The cached content is not actually removed, [...]
.. _Creating-CentOS-Kickstart:
diff --git a/docs/source/admin/traffic_ops/using.rst b/docs/source/admin/traffic_ops/using.rst
index 10c86b9..99fc0a5 100644
--- a/docs/source/admin/traffic_ops/using.rst
+++ b/docs/source/admin/traffic_ops/using.rst
@@ -13,12 +13,6 @@
.. limitations under the License.
..
-.. |graph| image:: images/graph.png
-.. |info| image:: images/info.png
-.. |checkmark| image:: images/good.png
-.. |X| image:: images/bad.png
-.. |clock| image:: images/clock-black.png
-
.. _to-using:
*******************
@@ -38,28 +32,6 @@ The Traffic Ops Menu
The following tabs are available in the menu at the top of the Traffic Ops user interface.
-Parameters
-----------
-Parameters and Profiles can be edited here. Hover over the tab to get the following options:
-
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Option | Description |
-+=============================+=====================================================================================================================================================================================+
-| Global Profile | The table of global parameters. See :ref:`param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| All :term:`Cache Group`\ s | The table of all parameters *that are assigned to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| All Profiles | The table of all parameters *that are assigned to a profile* - this may be slow to pull up, as there can be thousands of parameters. |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Select Profile | Select the parameter list by profile first, then get a table of just the parameters for that profile. |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Export Profile | Profiles can be exported from one Traffic Ops instance to another using 'Select Profile' and under the "Profile Details" dialog for the desired profile |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Import Profile | Profiles can be imported from one Traffic Ops instance to another using the button "Import Profile" after using the "Export Profile" feature |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 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`. |
-+-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
.. index::
Change Log
@@ -82,118 +54,6 @@ Help for Traffic Ops and Traffic Control. Hover over this tab to get the followi
| Logout | Logout from Traffic Ops |
+---------------+---------------------------------------------------------------------+
-
-.. _working-with-profiles:
-
-Parameters and Profiles
-=======================
-Parameters are shared between profiles if the set of ``{ name, config_file, value }`` is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (**Add Parameter** button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the **Misc > Profiles** view - just use the **Add/Copy Profile** button at the bottom of [...]
-
-.. seealso:: :ref:`param-prof` in the *Configuring Traffic Ops* section.
-
-.. _ccr-profile:
-
-Traffic Router Profile
-----------------------
-
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Config_file | Description |
-+=========================================+========================+==================================================================================================================================================+
-| location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| CDN_name | rascal-config.txt | The human readable name of the CDN for this profile. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| CoverageZoneJsonURL | CRConfig.xml | The location (URL) to retrieve the coverage zone map file in JSON format from. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| ecsEnable | CRConfig.json | Boolean value to enable or disable ENDS0 client subnet extensions. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation.polling.url | CRConfig.json | The location (URL) to retrieve the geo database file from. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation.polling.interval | CRConfig.json | How often to refresh the coverage geo location database in ms |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| coveragezone.polling.interval | CRConfig.json | How often to refresh the coverage zone map in ms |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in JSON format from. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| deepcoveragezone.polling.interval | CRConfig.json | How often to refresh the deep coverage zone map in ms |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| deepcoveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the deep coverage zone map file in JSON format from. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| client.steering.forced.diversity | CRConfig.json | Enable the Client Steering Forced Diversity feature (value = "true") to diversify CLIENT_STEERING results by including more unique edge caches |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.admin | CRConfig.json | The DNS Start of Authority admin. Should be a valid support email address for support if DNS is not working correctly. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.retry | CRConfig.json | The value for the retry field the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.refresh | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.NS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on NS records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.SOA | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.AAAA | CRConfig.json | The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.A | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.DNSKEY | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on DNSKEY records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.DS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on DS records. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| api.port | server.xml | The TCP port Traffic Router listens on for API (REST) access. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| api.cache-control.max-age | CRConfig.json | The value of the ``Cache-Control: max-age=`` header in the API responses of Traffic Router. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| api.auth.url | CRConfig.json | The API authentication URL (https://${tmHostname}/api/1.1/user/login); ${tmHostname} is a search and replace token used by Traffic Router to |
-| | | construct the correct URL) |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| consistent.dns.routing | CRConfig.json | Control whether DNS :term:`Delivery Service`\ s use consistent hashing on the edge FQDN to select caches for answers. May improve performance if |
-| | | set to true; defaults to false |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| dnssec.enabled | CRConfig.json | Whether DNSSEC is enabled; this parameter is updated via the DNSSEC administration user interface. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| dnssec.allow.expired.keys | CRConfig.json | Allow Traffic Router to use expired DNSSEC keys to sign zones; default is true. This helps prevent DNSSEC related outages due to failed Traffic |
-| | | Control components or connectivity issues. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| dynamic.cache.primer.enabled | CRConfig.json | Allow Traffic Router to attempt to prime the dynamic zone cache; defaults to true |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| dynamic.cache.primer.limit | CRConfig.json | Limit the number of permutations to prime when dynamic zone cache priming is enabled; defaults to 500 |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| keystore.maintenance.interval | CRConfig.json | The interval in seconds which Traffic Router will check the keystore API for new DNSSEC keys |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| keystore.api.url | CRConfig.json | The keystore API URL (https://${tmHostname}/api/1.1/cdns/name/${cdnName}/dnsseckeys.json; ${tmHostname} and ${cdnName} are search and replace |
-| | | tokens used by Traffic Router to construct the correct URL) |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| keystore.fetch.timeout | CRConfig.json | The timeout in milliseconds for requests to the keystore API |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| keystore.fetch.retries | CRConfig.json | The number of times Traffic Router will attempt to load keys before giving up; defaults to 5 |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| keystore.fetch.wait | CRConfig.json | The number of milliseconds Traffic Router will wait before a retry |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| signaturemanager.expiration.multiplier | CRConfig.json | Multiplier used in conjunction with a zone's maximum TTL to calculate DNSSEC signature durations; defaults to 5 |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| zonemanager.threadpool.scale | CRConfig.json | Multiplier used to determine the number of cores to use for zone signing operations; defaults to 0.75 |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| zonemanager.cache.maintenance.interval | CRConfig.json | The interval in seconds which Traffic Router will check for zones that need to be resigned or if dynamic zones need to be expired from cache |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| zonemanager.dynamic.response.expiration | CRConfig.json | A string (e.g.: 300s) that defines how long a dynamic zone |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNSKEY.generation.multiplier | CRConfig.json | Used to deteremine when new keys need to be regenerated. Keys are regenerated if expiration is less than the generation multiplier * the TTL. If |
-| | | the parameter does not exist, the default is 10. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNSKEY.effective.multiplier | CRConfig.json | Used when creating an effective date for a new key set. New keys are generated with an effective date of old key expiration - (effective |
-| | | multiplier * TTL). Default is 2. |
-+-----------------------------------------+------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
-
.. index::
Invalidate Content
Purge
@@ -234,7 +94,7 @@ The Manage DNSSEC Keys screen also allows a user to perform the following action
Activate/Deactivate DNSSEC for a CDN
------------------------------------
-Fairly straight forward, this button set the **dnssec.enabled** param to either **true** or **false** on the Traffic Router profile for the CDN. The Activate/Deactivate option is only available if DNSSEC keys exist for CDN. In order to active DNSSEC for a CDN a user must first generate keys and then click the **Active DNSSEC** button.
+Fairly straight forward, this button set the :term:`Parameter` with the :ref:`parameter-name` "dnssec.enabled" to have a :ref:`parameter-value` of either "true" or "false" on the Traffic Router :term:`Profile` for the CDN. The Activate/Deactivate option is only available if DNSSEC keys exist for CDN. In order to active DNSSEC for a CDN a user must first generate keys and then click the :guilabel:`Active DNSSEC` button.
Generate Keys
-------------
diff --git a/docs/source/admin/traffic_portal/default_profiles.rst b/docs/source/admin/traffic_portal/default_profiles.rst
deleted file mode 100644
index 42fa2e6..0000000
--- a/docs/source/admin/traffic_portal/default_profiles.rst
+++ /dev/null
@@ -1,46 +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.
-..
-
-.. _default-profiles:
-
-****************
-Default Profiles
-****************
-Traffic Ops has the concept of :ref:`working-with-profiles`, which are an integral component of Traffic Ops. To get started, a set of default Traffic Ops profiles are provided. These can be imported into Traffic Ops, and are required by the Traffic Control components Traffic Router, Traffic Monitor, and Apache Traffic Server (Edge-tier and Mid-tier caches). Download Default Profiles from `here <http://trafficcontrol.apache.org/downloads/profiles/>`_
-
-.. _to-profiles-min-needed:
-
-Minimum Traffic Ops Profiles Needed
-===================================
-
-- :file:`EDGE_ATS_{version}_{platform}_PROFILE.traffic_ops`
-- :file:`MID_ATS_{version}_{platform}_PROFILE.traffic_ops`
-- :file:`TRAFFIC_MONITOR_PROFILE.traffic_ops`
-- :file:`TRAFFIC_ROUTER_PROFILE.traffic_ops`
-- :file:`TRAFFIC_STATS_PROFILE.traffic_ops`
-- :file:`EDGE_GROVE_PROFILE.traffic_ops`
-
-.. note:: Despite that these have the ``.traffic_ops`` extension, they use JSON to store data. If your syntax highlighting doesn't work in some editor or viewer, try changing the extension to ``.json``.
-
-.. warning:: These profiles will likely need to be modified to suit your system. Many of them contain hardware-specific parameters and parameter values.
-
-Steps to Import a Profile
-=========================
-#. Sign into Traffic Portal
-#. Navigate to :menuselection:`Configure --> Profiles`
-#. Click on :menuselection:`More --> Import Profile`
-#. Drag and drop your desired profile into the upload pane
-#. Click :guilabel:`Import`
-#. Continue these steps for each of the `Minimum Traffic Ops Profiles Needed`_.
diff --git a/docs/source/admin/traffic_portal/usingtrafficportal.rst b/docs/source/admin/traffic_portal/usingtrafficportal.rst
index 85c971d..792f002 100644
--- a/docs/source/admin/traffic_portal/usingtrafficportal.rst
+++ b/docs/source/admin/traffic_portal/usingtrafficportal.rst
@@ -99,7 +99,7 @@ A real-time view into the status of each :term:`cache server`. The :menuselectio
.. warning:: Several of these columns may be empty by default - particularly in the :ref:`ciab` environment - and require :ref:`Traffic Ops Extensions <admin-to-ext-script>` to be installed/enabled/configured in order to work.
:Hostname: The (short) hostname of the :term:`cache server`
-:Profile: The name of the :term:`Profile` used by the :term:`cache server`
+:Profile: The :ref:`profile-name` of the :term:`Profile` used by the :term:`cache server`
:Status: The :term:`Status` of the :term:`cache server`
.. seealso:: :ref:`health-proto`
@@ -122,7 +122,7 @@ Cache Stats
-----------
A table showing the results of the periodic :ref:`to-check-ext` that are run. These can be grouped by :term:`Cache Group` and/or :term:`Profile`.
-:Profile: Name of the :term:`Profile` applied to the Edge-tier or Mid-tier :term:`cache server`, or the special name "ALL" indicating that this row is a group of all :term:`cache servers` within a single :term:`Cache Group`
+:Profile: :ref:`profile-name` of the :term:`Profile` applied to the Edge-tier or Mid-tier :term:`cache server`, or the special name "ALL" indicating that this row is a group of all :term:`cache servers` within a single :term:`Cache Group`
:Host: 'ALL' for entries grouped by :term:`Cache Group`, or the hostname of a particular :term:`cache server`
:Cache Group: Name of the :term:`Cache Group` to which this server belongs, or the name of the :term:`Cache Group` that is grouped for entries grouped by :term:`Cache Group`, or the special name "ALL" indicating that this row is an aggregate across all :term:`Cache Groups`
:Healthy: True/False as determined by Traffic Monitor
@@ -277,7 +277,7 @@ A table of all servers (of all kinds) across all :term:`Delivery Services` and C
.. seealso:: :ref:`health-proto`
: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`
+:Profile: The :ref:`profile-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
:Phys Location: The name of the :term:`Physical Location` to which this server belongs
@@ -321,7 +321,7 @@ A table of all :term:`origins`. These are automatically created for the :term:`o
:Coordinate: The name of the geographic coordinate pair that defines the physical location of this :term:`origin server`. :term:`Origins` created for :term:`Delivery Services` automatically will **not** have associated Coordinates. This can be rectified on the details pages for said :term:`origins`
:Cachegroup: The name of the :term:`Cache Group` to which this :term:`origin` belongs, if any.
-:Profile: The name of a :term:`Profile` used by this :term:`origin`.
+:Profile: The :ref:`profile-name` of a :term:`Profile` used by this :term:`origin`.
:term:`Origin` management includes the ability to (where applicable):
@@ -329,17 +329,17 @@ A table of all :term:`origins`. These are automatically created for the :term:`o
- update an existing :term:`origin`
- delete an existing :term:`origin`
-.. _tp-profiles-page:
+.. _tp-configure-profiles:
Profiles
--------
-A table of all :term:`Profile`\ s. From here you can see :term:`Parameter`\ s, servers and :term:`Delivery Service`\ s assigned to each :term:`Profile`. Each entry in the table has these fields:
+A table of all :term:`Profiles`. From here you can see :term:`Parameters`, servers and :term:`Delivery Services` assigned to each :term:`Profile`. Each entry in the table has these fields:
-:Name: The name of the :term:`Profile`
-:Type: The type of this :term:`Profile`, which indicates the kinds of objects to which the :term:`Profile` may be assigned
-:Routing Disabled: For :term:`Profile`\ s applied to :term:`cache server` s (Edge-tier or Mid-tier) this indicates that Traffic Router will refuse to provide routes to these machines
-:Description: A user-defined description of the :term:`Profile`, typically indicating its purpose
-:CDN: The CDN to which this :term:`Profile` is restricted. To use the same :term:`Profile` across multiple CDNs, clone the :term:`Profile` and change the clone's CDN field.
+:Name: The :ref:`profile-name` of the :term:`Profile`
+:Type: The :ref:`profile-type` of this :term:`Profile`, which indicates the kinds of objects to which the :term:`Profile` may be assigned
+:Routing Disabled: The :ref:`profile-routing-disabled` setting of this :term:`Profile`
+:Description: This :term:`Profile`'s :ref:`profile-description`
+:CDN: The :ref:`profile-cdn` to which this :term:`Profile` is restricted. To use the same :term:`Profile` across multiple CDNs, clone the :term:`Profile` and change the clone's :ref:`profile-cdn` field.
:term:`Profile` management includes the ability to (where applicable):
@@ -348,29 +348,29 @@ A table of all :term:`Profile`\ s. From here you can see :term:`Parameter`\ s, s
- delete an existing :term:`Profile`
- clone a :term:`Profile`
- export a :term:`Profile`
-- view :term:`Profile` :term:`Parameter`\ s
-- view :term:`Profile` :term:`Delivery Service`\ s
+- view :term:`Profile` :term:`Parameters`
+- view :term:`Profile` :term:`Delivery Services`
- view :term:`Profile` servers
-.. seealso:: :ref:`working-with-profiles`
+.. _tp-configure-parameters:
Parameters
----------
-This page displays a table of :term:`Parameter`\ s from all :term:`Profile`\ s with the following columns:
+This page displays a table of :term:`Parameters` from all :term:`Profiles` with the following columns:
-:Name: The name of the :term:`Parameter`
-:Config File: The configuration file where this :term:`Parameter` is stored, possibly the special value ``location``, indicating that this :term:`Parameter` actually names the location of a configuration file rather than its contents, or ``package`` to indicate that this :term:`Parameter` specifies a package to be installed rather than anything to do with configuration files
-:Value: The value of the :term:`Parameter`. The meaning of this depends on the value of 'Config File'
-:Secure: When this is 'true', a user requesting to see this :term:`Parameter` will see the value ``********`` instead of its actual value if the user's permission role isn't 'admin'
-:Profiles: The number of :term:`Profile`\ s currently using this :term:`Parameter`
+:Name: The :ref:`parameter-name` of the :term:`Parameter`
+:Config File: The :ref:`parameter-config-file` to which the :term:`Parameter` belongs.
+:Value: The :ref:`parameter-value` of the :term:`Parameter`.
+:Secure: Whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:Profiles: The number of :term:`Profiles` currently using this :term:`Parameter`
:term:`Parameter` management includes the ability to (where applicable):
- create a new :term:`Parameter`
- update an existing :term:`Parameter`
- delete an existing :term:`Parameter`
-- view :term:`Parameter` :term:`Profile`\ s
-- manage assignments of a :term:`Parameter` to one or more :term:`Profile`\ s and/or :term:`Delivery Service`\ s
+- view :term:`Parameter` :term:`Profiles`
+- manage assignments of a :term:`Parameter` to one or more :term:`Profiles` and/or :term:`Delivery Services`
.. _tp-configure-types:
@@ -537,6 +537,8 @@ Invalidate content includes the ability to (where applicable):
- create a new invalidate content job
+.. _tp-tools-generate-iso:
+
Generate ISO
------------
Generates a boot-able system image for any of the servers in the Servers table (or any server for that matter). 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 Operating Systems. The interface is *mostly* self-explanatory, but here is a short explanation of the fields in that form.
diff --git a/docs/source/admin/traffic_router.rst b/docs/source/admin/traffic_router.rst
index 661bad3..3f21242 100644
--- a/docs/source/admin/traffic_router.rst
+++ b/docs/source/admin/traffic_router.rst
@@ -32,9 +32,9 @@ Requirements
Installing Traffic Router
=========================
-#. If no suitable :term:`Profile` exists, create a new :term:`Profile` for Traffic Router via the :guilabel:`+` button on the :ref:`tp-profiles-page` page in Traffic Portal
+#. If no suitable :term:`Profile` exists, create a new :term:`Profile` for Traffic Router via the :guilabel:`+` button on the :ref:`tp-configure-profiles` page in Traffic Portal
- .. warning:: Traffic Ops will *only* recognize a profile as assignable to a Traffic Router if its name starts with the prefix ``ccr-``. The reason for this is a legacy limitation related to the old name for Traffic Router (Comcast Cloud Router), and will (hopefully) be rectified in the future as the old Perl parts of Traffic Ops are re-written in Go.
+ .. warning:: Traffic Ops will *only* recognize a :term:`Profile` as assignable to a Traffic Router if its :ref:`profile-name` starts with the prefix ``ccr-``. The reason for this is a legacy limitation related to the old name for Traffic Router (Comcast Cloud Router), and will (hopefully) be rectified in the future as the old Perl parts of Traffic Ops are re-written in Go.
#. Enter the Traffic Router server into Traffic Portal on the :ref:`tp-configure-servers` page (or via the :ref:`to-api`), assign to it a Traffic Router :term:`Profile`, and ensure that its status is set to ``ONLINE``.
#. Ensure the :abbr:`FQDN (Fully Qualified Domain Name)` of the Traffic Router is resolvable in DNS. This :abbr:`FQDN (Fully Qualified Domain Name)` must be resolvable by the clients expected to use this CDN.
@@ -93,13 +93,13 @@ 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:`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 [...]
+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.
.. _tr-config-files:
-.. table:: Traffic Router Parameters
+.. table:: Traffic Router Configuration File Parameters
+----------------------------+-------------------------------------------+----------------------------------------------------------------------------------+----------------------------------------------------+
- | ConfigFile | Parameter Name | Description | Default Value |
+ | Configuration File | Parameter Name | Description | Default Value |
+============================+===========================================+==================================================================================+====================================================+
| traffic_monitor.properties | traffic_monitor.bootstrap.hosts | Semicolon-delimited Traffic Monitor | N/A |
| | | :abbr:`FQDN (Fully Qualified Domain Name)`\ s with port numbers as necessary | |
@@ -167,6 +167,123 @@ For the most part, the configuration files and :term:`Parameters` used by Traffi
| | | of Tomcat | |
+----------------------------+-------------------------------------------+----------------------------------------------------------------------------------+----------------------------------------------------+
+.. _tr-profile:
+
+The Traffic Router Profile
+--------------------------
+Much of a Traffic Router's configuration can be obtained through the :term:`Parameters` on its :term:`Profile`. The :term:`Parameters` of a Traffic Router's :term:`Profile` that have meaning (others are just ignored) are detailed in the :ref:`tr-profile-parameters`.
+
+.. _tr-profile-parameters:
+
+.. table:: The Parameters of a Traffic Router Profile
+
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | :ref:`parameter-name` | :ref:`parameter-config-file` | :ref:`parameter-value` Description |
+ +=========================================+==============================+=======================================================================================================================================+
+ | location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | CDN_name | rascal-config.txt | The human readable name of the CDN for this :term:`Profile`. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | CoverageZoneJsonURL | CRConfig.xml | The location (URL) where a :term:`Coverage Zone Map` may be found. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | ecsEnable | CRConfig.json | Boolean value to enable or disable ENDS0 client subnet extensions. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | geolocation.polling.url | CRConfig.json | The location (URL) where a geographic IP mapping database may be found. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | geolocation.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for an updated geographic IP mapping database. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | coveragezone.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for an updated :term:`Coverage Zone Map`. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | coveragezone.polling.url | CRConfig.json | The location (URL) where a :term:`Coverage Zone Map` may be found. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | deepcoveragezone.polling.interval | CRConfig.json | How often - in milliseconds - Traffic Router should check for an updated :term:`Deep Coverage Zone Map` |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | deepcoveragezone.polling.url | CRConfig.json | The location (URL) where a :term:`Deep Coverage Zone Map` may be found. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | client.steering.forced.diversity | CRConfig.json | When this :term:`Parameter` exists and is exactly "true", it enables the "Client Steering Forced Diversity" feature to diversify |
+ | | | CLIENT_STEERING results by including more unique :term:`Edge-Tier Cache Servers` in the response to the client's request. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.soa.expire | CRConfig.json | The value for the "expire" field the Traffic Router DNS Server will respond with on :abbr:`SOA (Start of Authority)` records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on :abbr:`SOA (Start of Authority)` records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.soa.admin | CRConfig.json | The DNS Start of Authority administration email address, which clients will be directed to contact for support if DNS is not working |
+ | | | correctly. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.soa.retry | CRConfig.json | The value for the "retry" field the Traffic Router DNS Server will respond with on :abbr:`SOA (Start of Authority)` records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.soa.refresh | CRConfig.json | The value for the "refresh" field the Traffic Router DNS Server will respond with on :abbr:`SOA (Start of Authority)` records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.NS | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on NS records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.SOA | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on :abbr:`SOA (Start of Authority)` records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.AAAA | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on AAAA records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.A | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on A records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.DNSKEY | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on DNSKEY records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tld.ttls.DS | CRConfig.json | The :abbr:`TTL (Time To Live)` the Traffic Router DNS Server will respond with on DS records. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | api.port | server.xml | The TCP port on which Traffic Router servers the :ref:`tr-api`. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | api.cache-control.max-age | CRConfig.json | The value of the ``Cache-Control: max-age=`` HTTP header in the of the :ref:`tr-api`. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | api.auth.url | CRConfig.json | The URL of the authentication endpoint of the :ref:`to-api` (:ref:`to-api-user-login`). The actual |
+ | | | :abbr:`FQDN (Fully Qualified Domain Name)` can be subsituted with ``${tmHostname}`` to have Traffic Router automatically fill it in, |
+ | | | e.g. ``https://${tmHostname}/api/1.1/user/login``. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | consistent.dns.routing | CRConfig.json | Control whether :ref:`DNS-routed <ds-types>` :term:`Delivery Services` use `Consistent Hashing`. May improve performance if set to |
+ | | | "true"; defaults to "false". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | dnssec.enabled | CRConfig.json | Whether DNSSEC is enabled; this parameter is updated via the DNSSEC administration user interface in Traffic Portal. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | dnssec.allow.expired.keys | CRConfig.json | Allow Traffic Router to use expired DNSSEC keys to sign zones; default is "true". This helps prevent DNSSEC related outages due to |
+ | | | failed Traffic Control components or connectivity issues. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | dynamic.cache.primer.enabled | CRConfig.json | Allow Traffic Router to attempt to prime the dynamic zone cache; defaults to "true". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | dynamic.cache.primer.limit | CRConfig.json | Limit the number of permutations to prime when dynamic zone cache priming is enabled; defaults to "500". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | keystore.maintenance.interval | CRConfig.json | The interval in seconds which Traffic Router will check the :ref:`to-api` for new DNSSEC keys. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | keystore.api.url | CRConfig.json | The URL of the DNSSEC key management endpoint of the :ref:`to-api` (:ref:`to-api-cdns-name-name-dnsseckeys`). The actual |
+ | | | :abbr:`FQDN (Fully Qualified Domain Name)` may be substituted with ``${tmHostname}`` to and the name of a CDN may be substituted with |
+ | | | ``${cdnName}`` to have Traffic Router automatically fill them in. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | keystore.fetch.timeout | CRConfig.json | The timeout in milliseconds for requests to the DNSSEC Key management endpoint of the :ref:`to-api` |
+ | | | (:ref:`to-api-cdns-name-name-dnsseckeys`). |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | keystore.fetch.retries | CRConfig.json | The number of times Traffic Router will attempt to load DNSSEC keys before giving up; defaults to "5". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | keystore.fetch.wait | CRConfig.json | The number of milliseconds Traffic Router will wait in between attempts to load DNSSEC keys |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | signaturemanager.expiration.multiplier | CRConfig.json | Multiplier used in conjunction with a zone's maximum :abbr:`TTL (Time To Live)` to calculate DNSSEC signature durations; defaults to |
+ | | | "5". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | zonemanager.threadpool.scale | CRConfig.json | Multiplier used to determine the number of CPU cores to use for zone signing operations; defaults to "0.75". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | zonemanager.cache.maintenance.interval | CRConfig.json | The interval in seconds on which Traffic Router will check for zones that need to be re-signed or if dynamic zones need to be expired |
+ | | | from its cache. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | zonemanager.dynamic.response.expiration | CRConfig.json | A duration (e.g.: "300s") that defines how long a dynamic zone will remain valid before expiring. |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | DNSKEY.generation.multiplier | CRConfig.json | Used to determine when new DNSSEC keys need to be generated. Keys are re-generated if expiration is less than the generation |
+ | | | multiplier multiplied by the :abbr:`TTL (Time To Live)`. If this :term:`Parameter` does not exist, the default is "10". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | DNSKEY.effective.multiplier | CRConfig.json | Used when creating an effective date for a new key set. New keys are generated with an effective date of that is the effective |
+ | | | multiplier multiplied by the :abbr:`TTL (Time To Live)` less than the old key's expiration date. Default is "2". |
+ +-----------------------------------------+------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+.. deprecated:: ATCv4.0
+ The use of "CRConfig.xml" as a :ref:`Parameter "Config File" value <parameter-config-file>` has no known meaning, and its use for configuring Traffic Router is deprecated. All configuration (?) that previously used that value should instead use the equivalent :term:`Parameter` with the :ref:`parameter-config-file` value "CRConfig.json".
.. _consistent-hashing:
@@ -235,7 +352,7 @@ Overview
Operation
---------
-Upon startup or a configuration change, Traffic Router obtains keys from the 'keystore' API in Traffic Ops which returns :abbr:`KSK (Key Signing Key)`\ s and :abbr:`ZSK (Zone Signing Key)`\ s for each :term:`Delivery Service` that is a sub-domain of the CDN's :abbr:`TLD (Top Level Domain)` in addition to the keys for the CDN :abbr:`TLD (Top Level Domain)` itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dat [...]
+Upon startup or a configuration change, Traffic Router obtains keys from the 'keystore' API in Traffic Ops which returns :abbr:`KSK (Key Signing Key)`\ s and :abbr:`ZSK (Zone Signing Key)`\ s for each :term:`Delivery Service` that is a sub-domain of the CDN's :abbr:`TLD (Top Level Domain)` in addition to the keys for the CDN :abbr:`TLD (Top Level Domain)` itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dat [...]
Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each :term:`Delivery Service`'s zone (e.g.: ``demo1.mycdn.ciab.test``) for every valid key that exists, in addition to the CDN :abbr:`TLD (Top Level Domain)`'s zone. A DS record is generated from each zone's :abbr:`KSK (Key Signing Key)` and is placed in the CDN :abbr:`TLD (T [...]
@@ -452,12 +569,14 @@ Deep Caching is a feature that enables clients to be routed to the closest possi
What You Need
-------------
#. Edge cache deployed in "deep" locations and registered in Traffic Ops
-#. A :abbr:`DCZF (Deep Coverage Zone File)` mapping these deep cache hostnames to specific network prefixes (see :ref:`deep-czf` for details)
-#. Deep caching parameters in the Traffic Router Profile (see :ref:`ccr-profile` for details):
+#. A :term:`Deep Coverage Zone File` mapping these deep cache hostnames to specific network prefixes
+#. Deep caching :term:`Parameters` in the Traffic Router :term:`Profile`
- ``deepcoveragezone.polling.interval``
- ``deepcoveragezone.polling.url``
+ .. seealso:: See :ref:`tr-profile` for details.
+
#. Deep Caching enabled on one or more HTTP :term:`Delivery Service`\ s (i.e. 'Deep Caching' field on the :term:`Delivery Service` details page (under :guilabel:`Advanced Options`) set to ``ALWAYS``)
How it Works
@@ -473,11 +592,11 @@ Overview
--------
A Steering :term:`Delivery Service` is a :term:`Delivery Service` that is used to route a client to another :term:`Delivery Service`. The :ref:`Type <ds-types>` of a Steering :term:`Delivery Service` is either STEERING or CLIENT_STEERING. A Steering :term:`Delivery Service` will have target :term:`Delivery Service`\ s configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to [...]
-Special regular expressions - referred to as 'filters' - can also be configured for target :term:`Delivery Service`\ s to pin traffic to a specific :term:`Delivery Service`. For example, if the filter :regexp:`.*/news/.*` for a target called ``target-ds-1`` is created, any requests to Traffic Router with "news" in them will be routed to ``target-ds-1``. This will happen regardless of the configured weights.
+Special regular expressions - referred to as 'filters' - can also be configured for target :term:`Delivery Services` to pin traffic to a specific :term:`Delivery Service`. For example, if the filter :regexp:`.*/news/.*` for a target called ``target-ds-1`` is created, any requests to Traffic Router with "news" in them will be routed to ``target-ds-1``. This will happen regardless of the configured weights.
Some other points of interest
"""""""""""""""""""""""""""""
-- Steering is currently only available for HTTP :term:`Delivery Service`\ s that are a part of the same CDN.
+- Steering is currently only available for HTTP :term:`Delivery Services` that are a part of the same CDN.
- A new role called STEERING has been added to the Traffic Ops database. Only users with the Steering :term:`Role` or higher can modify steering assignments for a :term:`Delivery Service`.
- Traffic Router uses the steering endpoints of the :ref:`to-api` to poll for steering assignments, the assignments are then used when routing traffic.
@@ -485,22 +604,22 @@ A couple simple use-cases for Steering are:
- Migrating traffic from one :term:`Delivery Service` to another over time.
- Trying out new functionality for a subset of traffic with an experimental :term:`Delivery Service`.
-- Load balancing between :term:`Delivery Service`\ s
+- Load balancing between :term:`Delivery Services`
The Difference Between STEERING and CLIENT_STEERING
---------------------------------------------------
-The only difference between the STEERING and CLIENT_STEERING :term:`Delivery Service` :term:`Type`\ s is that CLIENT_STEERING explicitly allows a client to bypass Steering by choosing a destination :term:`Delivery Service`. A client can accomplish this by providing the ``X-TC-Steering-Option`` HTTP header with a value of the ``xml_id`` of the target :term:`Delivery Service` to which they desire to be routed. When Traffic Router receives this header it will route to the requested target : [...]
+The only difference between the STEERING and CLIENT_STEERING :term:`Delivery Service` :term:`Type`\ s is that CLIENT_STEERING explicitly allows a client to bypass Steering by choosing a destination :term:`Delivery Service`. A client can accomplish this by providing the ``X-TC-Steering-Option`` HTTP header with a value of the ``xml_id`` of the target :term:`Delivery Service` to which they desire to be routed. When Traffic Router receives this header it will route to the requested target : [...]
Configuration
-------------
The following needs to be completed for Steering to work correctly:
-#. Two target :term:`Delivery Service`\ s are created in Traffic Ops. They must both be HTTP :term:`Delivery Service`\ s part of the same CDN.
+#. Two target :term:`Delivery Services` are created in Traffic Ops. They must both be HTTP :term:`Delivery Services` part of the same CDN.
#. A :term:`Delivery Service` with type STEERING or CLIENT_STEERING is created in Traffic Portal.
-#. Target :term:`Delivery Service`\ s are assigned to the Steering :term:`Delivery Service` using Traffic Portal.
+#. Target :term:`Delivery Services` are assigned to the Steering :term:`Delivery Service` using Traffic Portal.
#. A user with the role of Steering is created.
-#. The Steering user assigns weights to the target :term:`Delivery Service`\ s.
-#. If desired, the Steering user can create filters for the target :term:`Delivery Service`\ s.
+#. The Steering user assigns weights to the target :term:`Delivery Services`.
+#. If desired, the Steering user can create filters for the target :term:`Delivery Services`.
.. seealso:: For more information see :ref:`steering-qht`.
diff --git a/docs/source/admin/traffic_stats.rst b/docs/source/admin/traffic_stats.rst
index 6d31760..bfe232b 100644
--- a/docs/source/admin/traffic_stats.rst
+++ b/docs/source/admin/traffic_stats.rst
@@ -118,9 +118,9 @@ Traffic Portal uses custom dashboards to display information about individual :t
Configuring Traffic Portal for Traffic Stats
--------------------------------------------
-- The InfluxDB servers need to be added to Traffic Portal with profile = InfluxDB. Make sure to use port 8086 in the configuration.
-- The traffic stats server should be added to Traffic Ops with profile = Traffic Stats.
-- :term:`Parameters` for which stats will be collected are added with the release, but any changes can be made via parameters that are assigned to the Traffic Stats profile.
+- The InfluxDB servers need to be added to Traffic Portal with a :term:`Profile` that has the :ref:`profile-type` InfluxDB. Make sure to use port 8086 in the configuration.
+- The traffic stats server should be added to Traffic Ops with a :term:`Profile` that has the :ref:`profile-type` TRAFFIC_STATS.
+- :term:`Parameters` for which stats will be collected are added with the release, but any changes can be made via :term:`Parameters` that are assigned to the Traffic Stats :term:`Profile`.
Configuring Traffic Portal to use Grafana Dashboards
----------------------------------------------------
diff --git a/docs/source/api/cachegroup_parameterID_parameter.rst b/docs/source/api/cachegroup_parameterID_parameter.rst
index eabeee6..4db7783 100644
--- a/docs/source/api/cachegroup_parameterID_parameter.rst
+++ b/docs/source/api/cachegroup_parameterID_parameter.rst
@@ -25,7 +25,7 @@
``GET``
=======
-Extract identifying information about all cachegroups with a specific parameter
+Extract identifying information about all :term:`Cache Groups` with a specific :term:`Parameter`
:Auth. Required: Yes
:Roles Required: None
@@ -43,10 +43,10 @@ Request Structure
Response Structure
------------------
-:cachegroups: An array of all Cache Groups with an associated parameter identifiable by the ``parameter_id`` request path parameter
+:cachegroups: An array of all :term:`Cache Groups` with an associated :term:`Parameter` identifiable by the ``parameter_id`` request path parameter
- :id: The numeric ID of the Cache Group
- :name: The human-readable name of the Cache Group
+ :id: The integral, unique identifier of the :term:`Cache Group`
+ :name: The human-readable name of the :term:`Cache Group`
.. code-block:: json
:caption: Response Example
diff --git a/docs/source/api/cachegroupparameters.rst b/docs/source/api/cachegroupparameters.rst
index a847175..37dc58d 100644
--- a/docs/source/api/cachegroupparameters.rst
+++ b/docs/source/api/cachegroupparameters.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Extract information about parameters associated with :term:`Cache Group`\ s
+Extract information about :term:`Parameters` associated with :term:`Cache Groups`
:Auth. Required: Yes
:Roles Required: None
@@ -33,10 +33,10 @@ No available parameters
Response Structure
------------------
-:cachegroupParameters: An array of identifying information for parameters assigned to :term:`Cache Group` profiles
+:cachegroupParameters: An array of identifying information for :term:`Parameters` assigned to :term:`Cache Group` :term:`Profiles`
- :parameter: Numeric ID of the parameter
- :last_updated: Date and time of last modification in ISO format
+ :parameter: The :term:`Parameter`'s :ref:`parameter-id`
+ :last_updated: Date and time of last modification in an ISO-like format
:cachegroup: Name of the :term:`Cache Group`
.. code-block:: http
@@ -68,7 +68,7 @@ Response Structure
``POST``
========
-Assign parameter(s) to :term:`Cache Group`\ (s).
+Assign :term:`Parameter`\ (s) to :term:`Cache Group`\ (s).
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -78,8 +78,8 @@ Request Structure
-----------------
The request data can take the form of either a single object or an array of one or more objects.
-:cacheGroupId: Integral, unique identifier for the :term:`Cache Group` to which a parameter is being assigned
-:parameterId: Integral, unique identifier for the Parameter being assigned
+:cacheGroupId: Integral, unique identifier for the :term:`Cache Group` to which a :term:`Parameter` is being assigned
+:parameterId: Integral, unique identifier for the :term:`Parameter` being assigned
.. code-block:: http
:caption: Request Example
@@ -99,8 +99,8 @@ The request data can take the form of either a single object or an array of one
Response Structure
------------------
-:parameter: Numeric ID of the parameter
-:last_updated: Date and time of last modification in ISO format
+:parameter: Integral, unique identifier of the :term:`Parameter`
+:last_updated: Date and time of last modification in an ISO-like format
:cachegroup: Name of the :term:`Cache Group`
.. code-block:: http
diff --git a/docs/source/api/cachegroupparameters_id_parameterID.rst b/docs/source/api/cachegroupparameters_id_parameterID.rst
index 257ec87..918d735 100644
--- a/docs/source/api/cachegroupparameters_id_parameterID.rst
+++ b/docs/source/api/cachegroupparameters_id_parameterID.rst
@@ -21,7 +21,7 @@
``DELETE``
==========
-De-associate a parameter with a :term:`Cache Group`
+De-associate a :term:`Parameter` with a :term:`Cache Group`
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,13 +31,13 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +-------------+-------------------------------------------------------------------------------------------------+
- | Name | Description |
- +=============+=================================================================================================+
- | ID | Unique identifier for the :term:`Cache Group` which will have the parameter association deleted |
- +-------------+-------------------------------------------------------------------------------------------------+
- | parameterID | Unique identifier for the parameter which will be removed from a :term:`Cache Group` |
- +-------------+-------------------------------------------------------------------------------------------------+
+ +-------------+---------------------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +=============+=========================================================================================================+
+ | ID | Unique identifier for the :term:`Cache Group` which will have the :term:`Parameter` association deleted |
+ +-------------+---------------------------------------------------------------------------------------------------------+
+ | parameterID | Unique identifier for the :term:`Parameter` which will be removed from a :term:`Cache Group` |
+ +-------------+---------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/cachegroups_id_parameters.rst b/docs/source/api/cachegroups_id_parameters.rst
index 757d02c..2999af0 100644
--- a/docs/source/api/cachegroups_id_parameters.rst
+++ b/docs/source/api/cachegroups_id_parameters.rst
@@ -18,9 +18,7 @@
*********************************
``cachegroups/{{ID}}/parameters``
*********************************
-Gets all the parameters associated with a :term:`Cache Group`
-
-.. seealso:: :ref:`param-prof`
+Gets all the :term:`Parameters` associated with a :term:`Cache Group`
``GET``
=======
@@ -41,12 +39,12 @@ Request Structure
Response Structure
------------------
-:configFile: Configuration file associated with the parameter
-:id: A numeric, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last updated, in an ISO-like format
-:name: Name of the parameter
-:secure: If ``true``, the parameter value is only visible to "admin"-role users
-:value: Value of the parameter
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value describing whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/cachegroups_id_unassigned_parameters.rst b/docs/source/api/cachegroups_id_unassigned_parameters.rst
index bcf4b6f..75fc8a1 100644
--- a/docs/source/api/cachegroups_id_unassigned_parameters.rst
+++ b/docs/source/api/cachegroups_id_unassigned_parameters.rst
@@ -18,12 +18,11 @@
********************************************
``cachegroups/{{id}}/unassigned_parameters``
********************************************
-Gets all the parameters NOT associated with a specific :term:`Cache Group`
-
-.. seealso:: :ref:`param-prof`
``GET``
=======
+Gets all the :term:`Parameters` *not* associated with a specific :term:`Cache Group`
+
:Auth. Required: Yes
:Roles Required: None
:Response Type: Array
@@ -32,21 +31,21 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------------------+----------+------------------------+
- | Name | Required | Description |
- +==================+==========+========================+
- | ``id`` | yes | :term:`Cache Group` ID |
- +------------------+----------+------------------------+
+ +------------------+----------+---------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+=========================================================+
+ | ``id`` | yes | An integral, unique identifier of a :term:`Cache Group` |
+ +------------------+----------+---------------------------------------------------------+
Response Structure
------------------
-:configFile: Configuration file associated with the parameter
-:id: A numeric, unique identifier for this parameter
-:lastUpdated: The Time / Date this entry was last updated
-:name: Name of the parameter
-:secure: Is the parameter value only visible to admin users
-:value: Value of the parameter
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: json
:caption: Response Example
diff --git a/docs/source/api/cachegroups_parameterID_parameter_available.rst b/docs/source/api/cachegroups_parameterID_parameter_available.rst
index 242a22c..f264613 100644
--- a/docs/source/api/cachegroups_parameterID_parameter_available.rst
+++ b/docs/source/api/cachegroups_parameterID_parameter_available.rst
@@ -25,7 +25,7 @@
``GET``
=======
-Gets a list of :term:`Cache Group`\ s which are available to have a specific parameter assigned to them
+Gets a list of :term:`Cache Groups` which are available to have a specific :term:`Parameter` assigned to them
:Auth. Required: Yes
:Roles Required: None
@@ -38,7 +38,7 @@ Request Structure
+------------------+----------+--------------------------------------------------------------+
| Name | Required | Description |
+==================+==========+==============================================================+
- | ``parameter ID`` | yes | The integral, unique identifier of the parameter of interest |
+ | ``parameter ID`` | yes | The :ref:`parameter-id` of the :term:`Parameter` of interest |
+------------------+----------+--------------------------------------------------------------+
Response Structure
diff --git a/docs/source/api/caches_stats.rst b/docs/source/api/caches_stats.rst
index 1369875..ec84a0c 100644
--- a/docs/source/api/caches_stats.rst
+++ b/docs/source/api/caches_stats.rst
@@ -46,7 +46,7 @@ Response Structure
:hostname: The (short) hostname of the cache
:ip: The IP address of the cache
:kbps: Cache upload speed (to clients) in Kilobits per second
-:profile: The name of the profile in use by this cache
+:profile: The :ref:`profile-name` of the :term:`Profile` in use by this :term:`cache server`
:status: The status of the cache
.. code-block:: http
diff --git a/docs/source/api/cdns_domains.rst b/docs/source/api/cdns_domains.rst
index ec56610..7af0dac 100644
--- a/docs/source/api/cdns_domains.rst
+++ b/docs/source/api/cdns_domains.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Gets a list of domains and their related Traffic Router profiles for all CDNs.
+Gets a list of domains and their related Traffic Router :term:`Profiles` for all CDNs.
:Auth. Required: Yes
:Roles Required: None
@@ -33,11 +33,11 @@ No parameters available.
Response Structure
------------------
-:domainName: The top-level domain (TLD) assigned to this CDN
-:parameterId: The integral, unique identifier for the parameter that sets this TLD on the Traffic Router
+:domainName: The :abbr:`TLD (Top-Level Domain)` assigned to this CDN
+:parameterId: The :ref:`parameter-id` for the :term:`Parameter` that sets this :abbr:`TLD (Top-Level Domain)` on the Traffic Router
:profileDescription: A short, human-readable description of the Traffic Router's profile
-:profileId: The integral, unique identifier for the profile assigned to the Traffic Router responsible for serving ``domainName``
-:profileName: The name of the profile assigned to the Traffic Router responsible for serving ``domainName``
+:profileId: The :ref:`profile-id` of the :term:`Profile` assigned to the Traffic Router responsible for serving ``domainName``
+:profileName: The :ref:`profile-name` of the :term:`Profile` assigned to the Traffic Router responsible for serving ``domainName``
.. code-block:: json
:caption: Response Example
diff --git a/docs/source/api/cdns_name_configs_monitoring.rst b/docs/source/api/cdns_name_configs_monitoring.rst
index 7952d25..82babcc 100644
--- a/docs/source/api/cdns_name_configs_monitoring.rst
+++ b/docs/source/api/cdns_name_configs_monitoring.rst
@@ -69,10 +69,10 @@ Response Structure
:totalTpsThreshold: A threshold amount of transactions per second that this :term:`Delivery Service` is configured to handle
:xmlId: An integral, unique identifier for this Deliver Service (named "xmlId" for legacy reasons)
-:profiles: An array of the profiles in use by the :term:`cache server` s and :term:`Delivery Service`\ s belonging to this CDN
+:profiles: An array of the :term:`Profiles` in use by the :term:`cache servers` and :term:`Delivery Services` belonging to this CDN
- :name: The profile's name
- :parameters: An array of the parameters in this profile that relate to monitoring configuration. This can be ``null`` if the servers using this profile cannot be monitored (e.g. Traffic Routers)
+ :name: The :term:`Profile`'s :ref:`profile-name`
+ :parameters: An array of the :term:`Parameters` in this :term:`Profile` that relate to monitoring configuration. This can be ``null`` if the servers using this :term:`Profile` cannot be monitored (e.g. Traffic Routers)
:health.connection.timeout: A timeout value, in milliseconds, to wait before giving up on a health check request
:health.polling.url: A URL to request for polling health. Substitutions can be made in a shell-like syntax using the properties of an object from the ``"trafficServers"`` array
@@ -81,7 +81,7 @@ Response Structure
:health.threshold.queryTime: The highest allowed length of time for completing health queries (after connection has been established) in milliseconds
:history.count: The number of past events to store; once this number is reached, the oldest event will be forgotten before a new one can be added
- :type: The type of the profile
+ :type: The :ref:`profile-type` of the :term:`Profile`
:trafficMonitors: An array of objects representing each Traffic Monitor that monitors this CDN (this is used by Traffic Monitor's "peer polling" function)
@@ -90,10 +90,10 @@ Response Structure
:ip6: The IPv6 address of this Traffic Monitor - when applicable
:ip: The IP address of this Traffic Monitor
:port: The port on which this Traffic Monitor listens for incoming connections
- :profile: The name of the profile assigned to this Traffic Monitor
+ :profile: The :ref:`profile-name` of the :term:`Profile` assigned to this Traffic Monitor
:status: The status of the server running this Traffic Monitor instance
-:trafficServers: An array of objects that represent the caches being monitored within this CDN
+:trafficServers: An array of objects that represent the :term:`cache servers` being monitored within this CDN
:cacheGroup: The Cache Group to which this cache belongs
:fqdn: A Fully Qualified Domain Name (FQDN) that resolves to the :term:`cache server`'s IP (or IPv6) address
@@ -103,7 +103,7 @@ Response Structure
:ip6: The cache's IPv6 address - when applicable
:ip: The cache's IP address
:port: The port on which the cache listens for incoming connections
- :profile: The name of the profile assigned to this cache
+ :profile: The :ref:`profile-name` of the :term:`Profile` assigned to this :term:`cache server`
:status: The status of the Cache
:type: The type of the cache - should be either ``EDGE`` or ``MID``
diff --git a/docs/source/api/cdns_name_snapshot.rst b/docs/source/api/cdns_name_snapshot.rst
index 58e8b13..e80f901 100644
--- a/docs/source/api/cdns_name_snapshot.rst
+++ b/docs/source/api/cdns_name_snapshot.rst
@@ -115,7 +115,7 @@ Response Structure
:ip6: This Traffic Router's IPv6 address
:location: The name of the Cache Group to which this Traffic Router belongs
:port: The port number on which this Traffic Router listens for incoming HTTP requests
- :profile: The name of the profile used by this Traffic Router
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Router
:status: The health status of this Traffic Router
.. seealso:: :ref:`health-proto`
@@ -136,7 +136,7 @@ Response Structure
:ip: The server's IPv4 address
:locationId: This field is exactly the same as ``cacheGroup`` and only exists for legacy compatibility reasons
:port: The port on which this :term:`cache server` listens for incoming HTTP requests
- :profile: The name of the profile used by the :term:`cache server`
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by the :term:`cache server`
:routingDisabled: An integer representing the boolean concept of whether or not Traffic Routers should route client traffic this :term:`cache server`; one of:
0
@@ -301,9 +301,9 @@ Response Structure
:httpsPort: The port number on which this Traffic Monitor listens for incoming HTTPS requests
:ip6: This Traffic Monitor's IPv6 address
:ip: This Traffic Monitor's IPv4 address
- :location: The name of the Cache Group to which this Traffic Monitor belongs
+ :location: The name of the :term:`Cache Group` to which this Traffic Monitor belongs
:port: The port number on which this Traffic Monitor listens for incoming HTTP requests
- :profile: The name of the profile used by this Traffic Monitor
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Monitor
.. note:: For legacy reasons, this must always start with "RASCAL-".
diff --git a/docs/source/api/cdns_name_snapshot_new.rst b/docs/source/api/cdns_name_snapshot_new.rst
index c866c71..6c80789 100644
--- a/docs/source/api/cdns_name_snapshot_new.rst
+++ b/docs/source/api/cdns_name_snapshot_new.rst
@@ -112,17 +112,17 @@ Response Structure
:httpsPort: The port number on which this Traffic Router listens for incoming HTTPS requests
:ip: This Traffic Router's IPv4 address
:ip6: This Traffic Router's IPv6 address
- :location: The name of the Cache Group to which this Traffic Router belongs
+ :location: The name of the :term:`Cache Group` to which this Traffic Router belongs
:port: The port number on which this Traffic Router listens for incoming HTTP requests
- :profile: The name of the profile used by this Traffic Router
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Router
:status: The health status of this Traffic Router
.. seealso:: :ref:`health-proto`
-:contentServers: An object containing keys which are the (short) hostnames of the Edge-Tier :term:`cache server` s in the CDN; the values corresponding to those keys are routing information for said servers
+:contentServers: An object containing keys which are the (short) hostnames of the :term:`Edge-Tier cache servers` in the CDN; the values corresponding to those keys are routing information for said servers
- :cacheGroup: The name of the Cache Group to which the server belongs
- :deliveryServices: An object containing keys which are the names of :term:`Delivery Service`\ s to which this :term:`cache server` is assigned; the values corresponding to those keys are arrays of FQDNs that resolve to this :term:`cache server`
+ :cacheGroup: The name of the :term:`Cache Group` to which the server belongs
+ :deliveryServices: An object containing keys which are the names of :term:`Delivery Services` to which this :term:`cache server` is assigned; the values corresponding to those keys are arrays of FQDNs that resolve to this :term:`cache server`
.. note:: Only Edge-tier :term:`cache server` s can be assigned to a Delivery SErvice, and therefore this field will only be present when ``type`` is ``"EDGE"``.
@@ -135,7 +135,7 @@ Response Structure
:ip: The server's IPv4 address
:locationId: This field is exactly the same as ``cacheGroup`` and only exists for legacy compatibility reasons
:port: The port on which this :term:`cache server` listens for incoming HTTP requests
- :profile: The name of the profile used by the :term:`cache server`
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by the :term:`cache server`
:routingDisabled: An integer representing the boolean concept of whether or not Traffic Routers should route client traffic this :term:`cache server`; one of:
0
@@ -300,13 +300,10 @@ Response Structure
:httpsPort: The port number on which this Traffic Monitor listens for incoming HTTPS requests
:ip6: This Traffic Monitor's IPv6 address
:ip: This Traffic Monitor's IPv4 address
- :location: The name of the Cache Group to which this Traffic Monitor belongs
+ :location: The name of the :term:`Cache Group` to which this Traffic Monitor belongs
:port: The port number on which this Traffic Monitor listens for incoming HTTP requests
- :profile: The name of the profile used by this Traffic Monitor
-
- .. note:: For legacy reasons, this must always start with "RASCAL-".
-
- :status: The health status of this Traffic Monitor
+ :profile: The :ref:`profile-name` of the :term:`Profile` used by this Traffic Monitor
+ :status: The health status of this Traffic Monitor
.. seealso:: :ref:`health-proto`
diff --git a/docs/source/api/deliveryservices.rst b/docs/source/api/deliveryservices.rst
index c1e589b..bf1309c 100644
--- a/docs/source/api/deliveryservices.rst
+++ b/docs/source/api/deliveryservices.rst
@@ -31,21 +31,21 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=============+==========+=====================================================================================================================================+
- | cdn | no | Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Show only the :term:`Delivery Service` that has this integral, unique identifier |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | logsEnabled | no | Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | profile | no | Return only :term:`Delivery Services` using the :term:`Profile` identified by this integral, unique identifier |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
- | type | no | Return only :term:`Delivery Services` of the :ref:`Delivery Service Type <ds-types>` identified by this integral, unique identifier |
- +-------------+----------+-------------------------------------------------------------------------------------------------------------------------------------+
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=============+==========+============================================================================================================================================+
+ | cdn | no | Show only the :term:`Delivery Services` belonging to the :ref:`ds-cdn` identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Show only the :term:`Delivery Service` that has this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | logsEnabled | no | Show only the :term:`Delivery Services` that have :ref:`ds-logs-enabled` set or not based on this boolean |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | profile | no | Return only :term:`Delivery Services` using the :term:`Profile` that has this :ref:`profile-id` |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Show only the :term:`Delivery Services` belonging to the :term:`Tenant` identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
+ | type | no | Return only :term:`Delivery Services` of the :term:`Delivery Service` :ref:`ds-types` identified by this integral, unique identifier |
+ +-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
Response Structure
------------------
@@ -117,9 +117,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
@@ -273,7 +273,7 @@ Request Structure
.. versionadded:: 1.4
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
.. versionadded:: 1.3
@@ -288,27 +288,20 @@ Request Structure
.. versionadded:: 1.3
-:geoLimit: An integer that defines the :ref:`ds-geo-limit`
-:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`\ [#geolimit]_
-:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`\ [#geolimit]_
-:geoProvider: The :ref:`ds-geo-provider`
-:globalMaxMbps: The :ref:`ds-global-max-mbps`
-:globalMaxTps: The :ref:`ds-global-max-tps`
-:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
-:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
- :type: The type of match performed using ``pattern``.
-
+:geoLimit: An integer that defines the :ref:`ds-geo-limit`
+:geoLimitCountries: A string containing a comma-separated list defining the :ref:`ds-geo-limit-countries`\ [#geolimit]_
+:geoLimitRedirectUrl: A :ref:`ds-geo-limit-redirect-url`\ [#geolimit]_
+:geoProvider: The :ref:`ds-geo-provider`
+:globalMaxMbps: The :ref:`ds-global-max-mbps`
+:globalMaxTps: The :ref:`ds-global-max-tps`
+:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
+:infoUrl: An :ref:`ds-info-url`
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: An optional field containing the :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: An optional field containing the :ref:`ds-longdesc3` of this :term:`Delivery Service`
:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
:maxOriginConnections: The :ref:`ds-max-origin-connections`
@@ -320,7 +313,7 @@ Request Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileId: An optional :ref:`profile-id` of a :ref:`ds-profile` with which this :term:`Delivery Service` shall be associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
@@ -437,14 +430,14 @@ Response Structure
:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
:id: An integral, unique identifier for this :term:`Delivery Service`
:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
+:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
:pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
:setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
@@ -461,9 +454,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
diff --git a/docs/source/api/deliveryservices_id.rst b/docs/source/api/deliveryservices_id.rst
index 3704143..31c713c 100644
--- a/docs/source/api/deliveryservices_id.rst
+++ b/docs/source/api/deliveryservices_id.rst
@@ -41,7 +41,7 @@ Request Structure
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
| logsEnabled | no | If true, return only :term:`Delivery Services` with logging enabled, otherwise return only :term:`Delivery Services` with logging disabled |
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
- | profile | no | Return only :term:`Delivery Services` using the profile identified by this integral, unique identifier |
+ | profile | no | Return only :term:`Delivery Services` using the :term:`Profile` with this :ref:`profile-id` |
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
| tenant | no | Show only the :term:`Delivery Services` belonging to the tenant identified by this integral, unique identifier |
+-------------+----------+--------------------------------------------------------------------------------------------------------------------------------------------+
@@ -105,14 +105,14 @@ Response Structure
:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
:id: An integral, unique identifier for this :term:`Delivery Service`
:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
+:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
:pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
:setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
@@ -129,9 +129,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
@@ -308,19 +308,12 @@ Request Structure
:globalMaxTps: The :ref:`ds-global-max-tps`
:httpBypassFqdn: A :ref:`ds-http-bypass-fqdn`
:infoUrl: An :ref:`ds-info-url`
-:initialDispersion: The :ref:`ds-initial-dispersion`
-:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
-:lastUpdated: The date and time at which this :term:`Delivery Service` was last updated, in :rfc:`3339` format
-:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
-:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
-:longDesc1: The :ref:`ds-longdesc2` of this :term:`Delivery Service`
-:longDesc2: The :ref:`ds-longdesc3` of this :term:`Delivery Service`
-:matchList: The :term:`Delivery Service`'s :ref:`ds-matchlist`
-
- :pattern: A regular expression - the use of this pattern is dependent on the ``type`` field (backslashes are escaped)
- :setNumber: An integer that provides explicit ordering of :ref:`ds-matchlist` items - this is used as a priority ranking by Traffic Router, and is not guaranteed to correspond to the ordering of items in the array.
- :type: The type of match performed using ``pattern``.
-
+:initialDispersion: The :ref:`ds-initial-dispersion`
+:ipv6RoutingEnabled: A boolean that defines the :ref:`ds-ipv6-routing` setting on this :term:`Delivery Service`
+:logsEnabled: A boolean that defines the :ref:`ds-logs-enabled` setting on this :term:`Delivery Service`
+:longDesc: The :ref:`ds-longdesc` of this :term:`Delivery Service`
+:longDesc1: An optional field containing the :ref:`ds-longdesc2` of this :term:`Delivery Service`
+:longDesc2: An optional field containing the :ref:`ds-longdesc3` of this :term:`Delivery Service`
:maxDnsAnswers: The :ref:`ds-max-dns-answers` allowed for this :term:`Delivery Service`
:maxOriginConnections: The :ref:`ds-max-origin-connections`
@@ -332,13 +325,14 @@ Request Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileId: An optional :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` will be associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
:regexRemap: A :ref:`ds-regex-remap`
:regionalGeoBlocking: A boolean defining the :ref:`ds-regionalgeo` setting on this :term:`Delivery Service`
:remapText: :ref:`ds-raw-remap`
+:routingName: The :ref:`ds-routing-name` of this :term:`Delivery Service`
:signed: ``true`` if and only if ``signingAlgorithm`` is not ``null``, ``false`` otherwise
:signingAlgorithm: Either a :ref:`ds-signing-algorithm` or ``null`` to indicate URL/URI signing is not implemented on this :term:`Delivery Service`
@@ -357,7 +351,6 @@ Request Structure
.. versionadded:: 1.3
-:type: The :ref:`ds-types` of this :term:`Delivery Service`
:typeId: The integral, unique identifier of the :ref:`ds-types` of this :term:`Delivery Service`
:xmlId: This :term:`Delivery Service`'s :ref:`ds-xmlid`
@@ -437,11 +430,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+---------------------------------------------------------------------------------+
- | Name | Description |
- +======+=================================================================================+
- | ID | The integral, unique identifier of the :term:`Delivery Service` to be retrieved |
- +------+---------------------------------------------------------------------------------+
+ +------+-------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+===============================================================================+
+ | ID | The integral, unique identifier of the :term:`Delivery Service` to be deleted |
+ +------+-------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/deliveryservices_id_safe.rst b/docs/source/api/deliveryservices_id_safe.rst
index 9ef2345..ad56197 100644
--- a/docs/source/api/deliveryservices_id_safe.rst
+++ b/docs/source/api/deliveryservices_id_safe.rst
@@ -135,9 +135,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
diff --git a/docs/source/api/deliveryservices_id_servers.rst b/docs/source/api/deliveryservices_id_servers.rst
index 11500c8..7b72440 100644
--- a/docs/source/api/deliveryservices_id_servers.rst
+++ b/docs/source/api/deliveryservices_id_servers.rst
@@ -71,9 +71,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status (will be empty if not offline)
:physLocation: The name of the physical location at which the server resides
:physLocationId: An integral, unique identifier for the physical location at which the server resides
-:profile: The name of the profile assigned to this server
-:profileDesc: A description of the profile assigned to this server
-:profileId: An integral, unique identifier for the profile assigned to this server
+:profile: The :ref:`profile-name` of the :term:`Profile` assigned to this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` assigned to this server
+:profileId: The :ref:`profile-id` of the :term:`Profile` assigned to this server
:rack: A string indicating "rack" location
:routerHostName: The human-readable name of the router
:routerPortName: The human-readable name of the router port
diff --git a/docs/source/api/deliveryservices_id_servers_eligible.rst b/docs/source/api/deliveryservices_id_servers_eligible.rst
index 7cf42d5..5380eb8 100644
--- a/docs/source/api/deliveryservices_id_servers_eligible.rst
+++ b/docs/source/api/deliveryservices_id_servers_eligible.rst
@@ -72,9 +72,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status (will be empty if not offline)
:physLocation: The name of the physical location at which the server resides
:physLocationId: An integral, unique identifier for the physical location at which the server resides
-:profile: The name of the profile assigned to this server
-:profileDesc: A description of the profile assigned to this server
-:profileId: An integral, unique identifier for the profile assigned to this server
+:profile: The :ref:`profile-name` of the :term:`Profile` assigned to this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` assigned to this server
+:profileId: The :ref:`profile-id` of the :term:`Profile` assigned to this server
:rack: A string indicating "rack" location
:routerHostName: The human-readable name of the router
:routerPortName: The human-readable name of the router port
diff --git a/docs/source/api/deliveryservices_id_unassigned_servers.rst b/docs/source/api/deliveryservices_id_unassigned_servers.rst
index fe390a3..2b55f53 100644
--- a/docs/source/api/deliveryservices_id_unassigned_servers.rst
+++ b/docs/source/api/deliveryservices_id_unassigned_servers.rst
@@ -69,9 +69,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The physical location name
:physLocationId: The physical location id
-:profile: The assigned profile name
-:profileDesc: The assigned profile description
-:profileId: The assigned profile Id
+:profile: The :ref:`profile-name` of the :term:`Profile` assigned to this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` assigned to this server
+:profileId: The :ref:`profile-id` of the :term:`Profile` assigned to this server
:rack: A string indicating rack location
:routerHostName: The human readable name of the router
:routerPortName: The human readable name of the router port
diff --git a/docs/source/api/origins.rst b/docs/source/api/origins.rst
index ece78f9..bbd93db 100644
--- a/docs/source/api/origins.rst
+++ b/docs/source/api/origins.rst
@@ -32,26 +32,26 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+=====================================================================================================================================================================+
- | cachegroup | no | Return only :term:`origin`\ s within the :term:`Cache Group` identified by this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | coordinate | no | Return only :term:`origin`\ s located at the geographic coordinates identified by this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | deliveryservice | no | Return only :term:`origin`\ s that belong to the :term:`Delivery Service` identified by this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | id | no | Return only the :term:`origin` that has this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | name | no | Return only :term:`origin`\ s by this name |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | profileId | no | Return only :term:`origin`\ s which use the :term:`Profile` identified by this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | primary | no | If ``true``, return only :term:`origin`\ s which are the the primary :term:`origin` of the :term:`Delivery Service` to which they belong - if ``false`` return only |
- | | | :term:`origin`\ s which are *not* the primary :term:`origin` of the :term:`Delivery Service` to which they belong |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | tenant | no | Return only :term:`origin`\ s belonging to the tenant identified by this integral, unique identifier |
- +-----------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================================================================================================================================+
+ | cachegroup | no | Return only :term:`origins` within the :term:`Cache Group` identified by this integral, unique identifier |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | coordinate | no | Return only :term:`origins` located at the geographic coordinates identified by this integral, unique identifier |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | deliveryservice | no | Return only :term:`origins` that belong to the :term:`Delivery Service` identified by this integral, unique identifier |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | id | no | Return only the :term:`origin` that has this integral, unique identifier |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | name | no | Return only :term:`origins` by this name |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | profileId | no | Return only :term:`origins` which use the :term:`Profile` that has this :ref:`profile-id` |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | primary | no | If ``true``, return only :term:`origins` which are the the primary :term:`origin` of the :term:`Delivery Service` to which they belong - if ``false`` return only |
+ | | | :term:`origins` which are *not* the primary :term:`origin` of the :term:`Delivery Service` to which they belong |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | tenant | no | Return only :term:`origins` belonging to the tenant identified by this integral, unique identifier |
+ +-----------------+----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+
.. note:: Several fields of origin definitions which are filterable by Query Parameters are allowed to be ``null``. ``null`` values in these fields will be filtered *out* appropriately by such Query Parameters, but do note that ``null`` is not a valid value accepted by any of these Query Parameters, and attempting to pass it will result in an error.
@@ -80,8 +80,8 @@ Response Structure
:lastUpdated: The date and time at which this :term:`origin` was last modified
:name: The name of the :term:`origin`
:port: The TCP port on which the :term:`origin` listens
-:profile: The name of the :term:`Profile` used by this :term:`origin`
-:profileId: An integral, unique identifier for the :term:`Profile` used by this :term:`origin`
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this :term:`origin`
+:profileId: The :ref:`profile-id` of the :term:`Profile` used by this :term:`origin`
:protocol: The protocol used by this origin - will be one of 'http' or 'https'
:tenant: The name of the :term:`Tenant` that owns this :term:`origin`
:tenantId: An integral, unique identifier for the :term:`Tenant` that owns this :term:`origin`
@@ -149,7 +149,7 @@ Request Structure
:name: A human-friendly name of the :term:`Origin`
:port: An optional port number on which the :term:`origin` listens for incoming TCP connections
-:profileId: An optional, integral, unique identifier for a :term:`Profile` that the new :term:`origin` shall use
+:profileId: An optional :ref:`profile-id` ofa :term:`Profile` that shall be used by this :term:`origin`
:protocol: The protocol used by the origin - must be one of 'http' or 'https'
:tenantId: An optional\ [1]_, integral, unique identifier for the :term:`Tenant` which shall own the new :term:`origin`
@@ -191,8 +191,8 @@ Response Structure
:lastUpdated: The date and time at which this :term:`origin` was last modified
:name: The name of the :term:`origin`
:port: The TCP port on which the :term:`origin` listens
-:profile: The name of the :term:`Profile` used by this :term:`origin`
-:profileId: An integral, unique identifier for the :term:`Profile` used by this :term:`origin`
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this :term:`origin`
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this :term:`origin`
:protocol: The protocol used by this origin - will be one of 'http' or 'https'
:tenant: The name of the :term:`Tenant` that owns this :term:`origin`
:tenantId: An integral, unique identifier for the :term:`Tenant` that owns this :term:`origin`
@@ -267,7 +267,7 @@ Request Structure
:isPrimary: An optional boolean which, if ``true`` will set this :term:`origin` as the 'primary' origin served by the :term:`Delivery Service` identified by ``deliveryServiceID``
:name: A human-friendly name of the :term:`Origin`
:port: An optional port number on which the :term:`origin` listens for incoming TCP connections
-:profileId: An optional, integral, unique identifier for a :term:`Profile` that the new :term:`origin` shall use
+:profileId: An optional :ref:`profile-id` of the :term:`Profile` that shall be used by this :term:`origin`
:protocol: The protocol used by the :term:`origin` - must be one of 'http' or 'https'
:tenantId: An optional\ [1]_, integral, unique identifier for the :term:`Tenant` which shall own the new :term:`origin`
@@ -309,8 +309,8 @@ Response Structure
:lastUpdated: The date and time at which this :term:`origin` was last modified
:name: The name of the :term:`origin`
:port: The TCP port on which the :term:`origin` listens
-:profile: The name of the :term:`Profile` used by this :term:`origin`
-:profileId: An integral, unique identifier for the :term:`Profile` used by this :term:`origin`
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this :term:`origin`
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this :term:`origin`
:protocol: The protocol used by this origin - will be one of 'http' or 'https'
:tenant: The name of the :term:`Tenant` that owns this :term:`origin`
:tenantId: An integral, unique identifier for the :term:`Tenant` that owns this :term:`origin`
diff --git a/docs/source/api/osversions.rst b/docs/source/api/osversions.rst
index 4a53a83..1025b6d 100644
--- a/docs/source/api/osversions.rst
+++ b/docs/source/api/osversions.rst
@@ -18,7 +18,7 @@
**************
``osversions``
**************
-.. seealso:: :ref:`generate-iso`
+.. seealso:: :ref:`tp-tools-generate-iso`
``GET``
=======
@@ -34,7 +34,7 @@ No parameters available.
Response Structure
------------------
-This endpoint has no constant keys in its ``response``. Instead, each key in the ``response`` object is the name of an OS, and the value is a string that names the directory where the ISO source can be found. These directories sit under `/var/www/files/` on the Traffic Ops host machine by default, or at the location defined by the ``kickstart.files.location`` parameter, if it is defined.
+This endpoint has no constant keys in its ``response``. Instead, each key in the ``response`` object is the name of an OS, and the value is a string that names the directory where the ISO source can be found. These directories sit under `/var/www/files/` on the Traffic Ops host machine by default, or at the location defined by the ``kickstart.files.location`` :term:`Parameter` of the Traffic Ops server's :term:`Profile`, if it is defined.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/parameterprofile.rst b/docs/source/api/parameterprofile.rst
index 1505abe..8583578 100644
--- a/docs/source/api/parameterprofile.rst
+++ b/docs/source/api/parameterprofile.rst
@@ -23,7 +23,7 @@
``POST``
========
-Create one or more parameter/profile assignments.
+Create one or more :term:`Parameter`/:term:`Profile` assignments.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,9 +31,9 @@ Create one or more parameter/profile assignments.
Request Structure
-----------------
-:paramId: The integral, unique identifier for the parameter to be assigned to the profiles identified within the ``profileIds`` array
-:profileIds: An array of integral, unique identifiers for profiles to which the parameter identified by ``paramId`` shall be assigned
-:replace: An optional boolean (default: false) which, if ``true``, will cause any conflicting profile/parameter assignments to be overridden.
+:paramId: The :ref:`parameter-id` of the :term:`Parameter` to be assigned to the :term:`Profiles` identified within the ``profileIds`` array
+:profileIds: An array of :term:`Profile` :ref:`IDs <profile-id>` to which the :term:`Parameter` identified by ``paramId`` shall be assigned
+:replace: An optional boolean (default: false) which, if ``true``, will cause any conflicting :term:`Profile`/:term:`Parameter` assignments to be overridden.
.. code-block:: http
:caption: Request Example
@@ -53,9 +53,9 @@ Request Structure
Response Structure
------------------
-:paramId: The integral, unique identifier for the parameter which has been assigned to the profiles identified within the ``profileIds`` array
-:profileIds: An array of integral, unique identifiers for profiles to which the parameter identified by ``paramId`` has been assigned
-:replace: An optional boolean (default: false) which, if ``true``, caused any conflicting profile/parameter assignments to be overridden.
+:paramId: The :ref:`parameter-id` of the :term:`Parameter` which has been assigned to the :term:`Profiles` identified within the ``profileIds`` array
+:profileIds: An array of :term:`Profile` :ref:`IDs <profile-id>` to which the :term:`Parameter` identified by ``paramId`` has been assigned
+:replace: An optional boolean (default: false) which, if ``true``, caused any conflicting :term:`Profile`/:term:`Parameter` assignments to be overridden.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/parameters.rst b/docs/source/api/parameters.rst
index 68717f1..33257cd 100644
--- a/docs/source/api/parameters.rst
+++ b/docs/source/api/parameters.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Gets all parameters configured in Traffic Ops
+Gets all :term:`Parameters` configured in Traffic Ops
:Auth. Required: Yes
:Roles Required: None
@@ -31,15 +31,15 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +============+==========+===================================================+
- | id | no | Filter parameters by integral, unique identifier |
- +------------+----------+---------------------------------------------------+
- | name | no | Filter parameters by name |
- +------------+----------+---------------------------------------------------+
- | configFile | no | Filter parameters by configuration file |
- +------------+----------+---------------------------------------------------+
+ +------------+----------+-----------------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+===========================================================+
+ | id | no | Filter :term:`Parameters` by :ref:`parameter-id` |
+ +------------+----------+-----------------------------------------------------------+
+ | name | no | Filter :term:`Parameters` by :ref:`parameter-name` |
+ +------------+----------+-----------------------------------------------------------+
+ | configFile | no | Filter :term:`Parameters` by :ref:`parameter-config-file` |
+ +------------+----------+-----------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -52,13 +52,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
@@ -92,7 +92,7 @@ Response Structure
``POST``
========
-Creates one or more new parameters.
+Creates one or more new :term:`Parameters`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -100,14 +100,14 @@ Creates one or more new parameters.
Request Structure
-----------------
-The request body may be in one of two formats, a single parameter object or an array of parameter objects. Each parameter object shall have the following keys:
+The request body may be in one of two formats, a single :term:`Parameter` object or an array of :term:`Parameter` objects. Each :term:`Parameter` object shall have the following keys:
-.. caution:: At the time of this writing, there is a bug in the Go rewrite of this endpoint such that the "array format" will not be accepted by the server. Watch `GitHub issue #3093 <https://github.com/apache/trafficcontrol/issues/3093>`_ for further developments
+.. caution:: At the time of this writing, there is a bug in the Go rewrite of this endpoint such that the "array format" will not be accepted by the server. Watch :issue:`3093` for further developments
-:name: Parameter name
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:secure: A boolean value which, when ``true`` will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example - Single Object Format
@@ -153,13 +153,13 @@ The request body may be in one of two formats, a single parameter object or an a
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter - should be ``null`` immediately after parameter creation
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example - Single Object Format
diff --git a/docs/source/api/parameters_id.rst b/docs/source/api/parameters_id.rst
index 00a1da4..426c1dd 100644
--- a/docs/source/api/parameters_id.rst
+++ b/docs/source/api/parameters_id.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Gets details about a specific parameter
+Gets details about a specific :term:`Parameter`
.. deprecated:: 1.1
Use the ``id`` query parameter of the :ref:`to-api-parameters` endpoint instead
@@ -37,7 +37,7 @@ Request Structure
+------+------------------------------------------------------------------------+
| Name | Description |
+======+========================================================================+
- | ID | The integral, unique identifier of the parameter which will be deleted |
+ | ID | The :ref:`parameter-id` of the :term:`Parameter` which will be deleted |
+------+------------------------------------------------------------------------+
.. code-block:: http
@@ -51,13 +51,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
@@ -91,7 +91,7 @@ Response Structure
``PUT``
=======
-Replaces a parameter.
+Replaces a :term:`Parameter`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -104,13 +104,13 @@ Request Structure
+------+------------------------------------------------------------------------+
| Name | Description |
+======+========================================================================+
- | ID | The integral, unique identifier of the parameter which will be deleted |
+ | ID | The :ref:`parameter-id` of the :term:`Parameter` which will be deleted |
+------+------------------------------------------------------------------------+
-:name: Parameter name
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:secure: A boolean value which, when ``true`` will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example
@@ -132,13 +132,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
@@ -173,7 +173,7 @@ Response Structure
``DELETE``
==========
-Deletes the specified parameter. If, however, the parameter is associated with one or more profiles, deletion will fail.
+Deletes the specified :term:`Parameter`. If, however, the :term:`Parameter` is associated with one or more :term:`Profiles`, deletion will fail.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -186,7 +186,7 @@ Request Structure
+------+------------------------------------------------------------------------+
| Name | Description |
+======+========================================================================+
- | ID | The integral, unique identifier of the parameter which will be deleted |
+ | ID | The :ref:`parameter-id` of the :term:`Parameter` which will be deleted |
+------+------------------------------------------------------------------------+
.. code-block:: http
diff --git a/docs/source/api/parameters_id_profiles.rst b/docs/source/api/parameters_id_profiles.rst
index 314c5a8..4d512fb 100644
--- a/docs/source/api/parameters_id_profiles.rst
+++ b/docs/source/api/parameters_id_profiles.rst
@@ -23,7 +23,7 @@
``GET``
=======
-Retrieves all profiles assigned to the parameter.
+Retrieves all :term:`Profiles` assigned to a specific :term:`Parameter`.
:Auth. Required: Yes
:Roles Required: None
@@ -33,11 +33,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+--------------------------------------------------------------------------------------------+
- | Name | Description |
- +======+============================================================================================+
- | ID | An integral, unique identifier that specifies for which parameter shall profiles be listed |
- +------+--------------------------------------------------------------------------------------------+
+ +------+---------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+=============================================================================================+
+ | ID | The :ref:`parameter-id` of the :term:`Parameter` for which :term:`Profiles` shall be listed |
+ +------+---------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Structure
@@ -50,18 +50,12 @@ Request Structure
Response Structure
------------------
-:description: A description of profile
-:id: An integral, unique identifier for this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: Profile name
-:routingDisabled: An integer that defines whether or not Traffic Routers will route to servers using these profiles - can only be one of:
-
- 0
- Traffic Routers will route traffic to these servers normally
- 1
- Traffic Routers will ignore these servers, and not route traffic to them
-
-:type: The profile's type
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/parameters_id_unassigned_profiles.rst b/docs/source/api/parameters_id_unassigned_profiles.rst
index 60f0123..aacdd37 100644
--- a/docs/source/api/parameters_id_unassigned_profiles.rst
+++ b/docs/source/api/parameters_id_unassigned_profiles.rst
@@ -22,7 +22,7 @@
``GET``
=======
-Retrieves all profiles to which the specified parameter is NOT assigned to the parameter.
+Retrieves all :term:`Profiles` to which the specified :term:`Parameter` is *not* assigned.
:Auth. Required: Yes
:Roles Required: None
@@ -32,11 +32,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+-------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +======+=======================================================================================================+
- | ID | An integral, unique identifier that specifies for which parameter unassigned profiles shall be listed |
- +------+-------------------------------------------------------------------------------------------------------+
+ +------+--------------------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+========================================================================================================+
+ | ID | The :ref:`parameter-id` of the :term:`Parameter` for which unassigned :term:`Profiles` shall be listed |
+ +------+--------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -49,18 +49,12 @@ Request Structure
Response Structure
------------------
-:description: A description of profile
-:id: An integral, unique identifier for this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: Profile name
-:routingDisabled: An integer that defines whether or not Traffic Routers will route to servers using these profiles - can only be one of:
-
- 0
- Traffic Routers will route traffic to these servers normally
- 1
- Traffic Routers will ignore these servers, and not route traffic to them
-
-:type: The profile's type
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/parameters_profile_name.rst b/docs/source/api/parameters_profile_name.rst
index b58158a..262efb6 100644
--- a/docs/source/api/parameters_profile_name.rst
+++ b/docs/source/api/parameters_profile_name.rst
@@ -23,7 +23,7 @@
``GET``
=======
-Gets details about a specific profile's parameters
+Gets details about a specific :term:`Profile`'s :term:`Parameters`
:Auth. Required: Yes
:Roles Required: None
@@ -33,11 +33,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+-------------------------------------------------------------+
- | Name | Description |
- +======+=============================================================+
- | name | The name of the profile for which parameters will be listed |
- +------+-------------------------------------------------------------+
+ +------+--------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+============================================================================================+
+ | name | The :ref:`profile-name` of the :term:`Profile` for which :term:`Parameters` will be listed |
+ +------+--------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -50,13 +50,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/parameters_validate.rst b/docs/source/api/parameters_validate.rst
index e7ebb8c..c3dd0d3 100644
--- a/docs/source/api/parameters_validate.rst
+++ b/docs/source/api/parameters_validate.rst
@@ -19,11 +19,11 @@
``parameters/validate``
***********************
.. deprecated:: 1.1
- To check for the existence of a parameter with specific name, value etc., use the query parameters of the :ref:`to-api-parameters` endpoint instead.
+ To check for the existence of a :term:`Parameter` with a specific :ref:`parameter-name`, :ref:`parameter-value` etc., use the query parameters of the :ref:`to-api-parameters` endpoint instead.
``POST``
========
-Returns a successful response and message if a parameter matching the one in the payload exists, and an error response and message if no such parameter is found.
+Returns a successful response and message if a :term:`Parameter` matching the one in the payload exists, and an error response and message if no such :term:`Parameter` is found.
:Auth. Required: Yes
:Roles Required: None
@@ -31,10 +31,10 @@ Returns a successful response and message if a parameter matching the one in the
Request Structure
-----------------
-:name: Parameter name
-:configFile: The *base* filename of the configuration file to which this parameter belongs e.g. "foo" not "/path/to/foo"
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example
@@ -56,13 +56,11 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example - Parameter Found
@@ -119,4 +117,4 @@ Response Structure
}
]}
-.. note:: This endpoint returns a client-side error response when the parameter was not found - as such any API tools that wish to use this endpoint should be aware that a client-side error response code may not actually mean that an error occurred. However, neither can it be said that a ``400`` response code means that the parameter wasn't found; that response code is also returned in the event of _true_ client-side errors e.g. a malformed JSON payload in the request.
+.. note:: This endpoint returns a client-side error response when the parameter was not found - as such any API tools that wish to use this endpoint should be aware that a client-side error response code may not actually mean that an error occurred. However, neither can it be said that a ``400`` response code means that the :term:`Parameter` wasn't found; that response code is also returned in the event of _true_ client-side errors e.g. a malformed JSON payload in the request.
diff --git a/docs/source/api/profileparameter.rst b/docs/source/api/profileparameter.rst
index 88c1afd..908885b 100644
--- a/docs/source/api/profileparameter.rst
+++ b/docs/source/api/profileparameter.rst
@@ -18,12 +18,11 @@
********************
``profileparameter``
********************
-.. deprecated:: 1.1
- Use :ref:`to-api-profileparameters` instead.
+.. seealso:: :ref:`to-api-profileparameters`.
``POST``
========
-Create one or more profile/parameter assignments.
+Create one or more :term:`Profile`/:term:`Parameter` assignments.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,9 +30,9 @@ Create one or more profile/parameter assignments.
Request Structure
-----------------
-:paramIds: An array of integral, unique identifiers for parameters which shall be assigned to the profile identified by ``profileId``
-:profileId: The integral, unique identifier of a profile to which parameters will be assigned
-:replace: An optional boolean (default: false) which, if ``true``, will cause any conflicting profile/parameter assignments to be overridden.
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameters` identified within the ``parameterIds`` array will be assigned
+:paramIds: An array of :term:`Parameter` :ref:`IDs <parameter-id>` which shall be assigned to the :term:`Profile` identified by ``profileId``
+:replace: An optional boolean (default: false) which, if ``true``, will cause any conflicting :term:`Profile`/:term:`Parameter` assignments to be overridden.
.. code-block:: http
:caption: Request Example
@@ -53,9 +52,9 @@ Request Structure
Response Structure
------------------
-:paramIds: An array of integral, unique identifiers for parameters which have been assigned to the profile identified by ``profileId``
-:profileId: The integral, unique identifier of a profile to which parameters have been assigned
-:replace: An optional boolean (default: false) which, if ``true``, caused any conflicting profile/parameter assignments to be overridden.
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameters` identified within the ``parameterIds`` array are assigned
+:paramIds: An array of :term:`Parameter` :ref:`IDs <parameter-id>` which have been assigned to the :term:`Profile` identified by ``profileId``
+:replace: An optional boolean (default: false) which, if ``true``, indicates that any conflicting :term:`Profile`/:term:`Parameter` assignments have been overridden.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profileparameters.rst b/docs/source/api/profileparameters.rst
index 348f5ae..949c8a7 100644
--- a/docs/source/api/profileparameters.rst
+++ b/docs/source/api/profileparameters.rst
@@ -22,9 +22,9 @@
``GET``
=======
.. deprecated:: 1.1
- To get the profiles associated with a particular parameter, use the ``param`` query parameter of :ref:`to-api-profiles` instead. To see the parameters associated with a particular profile, refer to the ``params`` key in the response of a ``GET`` request to :ref:`to-api-profiles-id` instead.
+ To get the :term:`Profiles` associated with a particular :term:`Parameter`, use the ``param`` query parameter of :ref:`to-api-profiles` instead. To see the :term:`Parameters` associated with a particular :term:`Profile`, refer to the ``params`` key in the response of a ``GET`` request to :ref:`to-api-profiles-id` instead.
-Retrieves all parameter/profile assignments.
+Retrieves all :term:`Parameter`/:term:`Profile` assignments.
:Auth. Required: Yes
:Roles Required: None
@@ -36,9 +36,9 @@ No parameters available
Response Structure
------------------
-:lastUpdated: The date and time at which this profile/parameter association was last modified
-:parameter: An integral, unique identifier for a parameter assigned to ``profile``
-:profile: The name of the profile to which the parameter identified by ``parameter`` is assigned
+:lastUpdated: The date and time at which this :term:`Profile`/:term:`Parameter` association was last modified, in an ISO-like format
+:parameter: The :ref:`parameter-id` of a :term:`Parameter` assigned to ``profile``
+:profile: The :ref:`profile-name` of the :term:`Profile` to which the :term:`Parameter` identified by ``parameter`` is assigned
.. code-block:: http
:caption: Response Structure
@@ -72,7 +72,7 @@ Response Structure
``POST``
========
-Associate parameter to profile.
+Associate a :term:`Parameter` to a :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -83,14 +83,14 @@ Request Structure
This endpoint accepts two formats for the request payload:
Single Object Format
- For assigning a single parameter to a single profile
+ For assigning a single :term:`Parameter` to a single :term:`Profile`
Array Format
- For making multiple assignments of parameters to profiles simultaneously
+ For making multiple assignments of :term:`Parameters` to :term:`Profiles` simultaneously
Single Object Format
""""""""""""""""""""
-:parameterId: The integral, unique identifier of a parameter to assign to some profile
-:profileId: The integral, unique identifier of the profile to which the parameter identified by ``parameterId`` will be assigned
+:parameterId: The :ref:`parameter-id` of a :term:`Parameter` to assign to some :term:`Profile`
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameter` identified by ``parameterId`` will be assigned
.. code-block:: http
:caption: Request Example - Single Object Format
@@ -110,10 +110,10 @@ Single Object Format
Array Format
""""""""""""
-.. caution:: Array format is broken as of the time of this writing. Follow `GitHub Issue #3103 <https://github.com/apache/trafficcontrol/issues/3103>`_ for further developments.
+.. caution:: Array format is broken as of the time of this writing. Follow :issue:`3103` for further developments.
-:parameterId: The integral, unique identifier of a parameter to assign to some profile
-:profileId: The integral, unique identifier of the profile to which the parameter identified by ``parameterId`` will be assigned
+:parameterId: The :ref:`parameter-id` of a :term:`Parameter` to assign to some :term:`Profile`
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameter` identified by ``parameterId`` will be assigned
.. code-block:: http
:caption: Request Example - Array Format
@@ -137,11 +137,11 @@ Array Format
Response Structure
------------------
-:lastUpdated: The date and time at which the profile/parameter assignment was last modified, in ISO format
-:parameter: Name of the parameter which is assigned to ``profile``
-:parameterId: The integral, unique identifier of the assigned parameter
-:profile: Name of the profile to which the parameter is assigned
-:profileId: The integral, unique identifier of the profile to which the parameter identified by ``parameterId`` is assigned
+:lastUpdated: The date and time at which the :term:`Profile`/:term:`Parameter` assignment was last modified, in an ISO-like format
+:parameter: :ref:`parameter-name` of the :term:`Parameter` which is assigned to ``profile``
+:parameterId: The :ref:`parameter-id` of the assigned :term:`Parameter`
+:profile: :ref:`profile-name` of the :term:`Profile` to which the :term:`Parameter` is assigned
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameter` identified by ``parameterId`` is assigned
.. code-block:: http
:caption: Response Example - Single Object Format
diff --git a/docs/source/api/profileparameters_profileID_parameterID.rst b/docs/source/api/profileparameters_profileID_parameterID.rst
index 47628f9..28abfe0 100644
--- a/docs/source/api/profileparameters_profileID_parameterID.rst
+++ b/docs/source/api/profileparameters_profileID_parameterID.rst
@@ -21,7 +21,7 @@
``DELETE``
==========
-Deletes a profile/parameter association.
+Deletes a :term:`Profile`/:term:`Parameter` association.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,13 +31,13 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +-------------+----------------------------------------------------------------------------------------------------------------------+
- | Name | Description |
- +=============+======================================================================================================================+
- | profileID | The integral, unique identifier of the profile from which a parameter shall be removed |
- +-------------+----------------------------------------------------------------------------------------------------------------------+
- | parameterID | The integral, unique identifier of the parameter which shall be removed from the profile identified by ``profileID`` |
- +-------------+----------------------------------------------------------------------------------------------------------------------+
+ +-------------+------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +=============+==============================================================================================================================+
+ | profileID | The :ref:`profile-id` of the :term:`Profile` from which a :term:`Parameter` shall be removed |
+ +-------------+------------------------------------------------------------------------------------------------------------------------------+
+ | parameterID | The :ref:`parameter-id` of the :term:`Parameter` which shall be removed from the :term:`Profile` identified by ``profileID`` |
+ +-------------+------------------------------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/profiles.rst b/docs/source/api/profiles.rst
index ace4bb8..042028b 100644
--- a/docs/source/api/profiles.rst
+++ b/docs/source/api/profiles.rst
@@ -29,17 +29,17 @@ Request Structure
-----------------
.. table:: Request Query Parameters
- +-------+----------+------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +=======+==========+================================================================================================+
- | cdn | no | Used to filter profiles by the integral, unique identifier of the CDN to which they belong |
- +-------+----------+------------------------------------------------------------------------------------------------+
- | id | no | Filters profiles by integral, unique identifier |
- +-------+----------+------------------------------------------------------------------------------------------------+
- | name | no | Filters profiles by name |
- +-------+----------+------------------------------------------------------------------------------------------------+
- | param | no | Used to filter profiles by the integral, unique identifier of a parameter associated with them |
- +-------+----------+------------------------------------------------------------------------------------------------+
+ +-------+----------+--------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=======+==========+========================================================================================================+
+ | cdn | no | Used to filter :term:`Profiles` by the integral, unique identifier of the CDN to which they belong |
+ +-------+----------+--------------------------------------------------------------------------------------------------------+
+ | id | no | Filters :term:`Profiles` by :ref:`profile-id` |
+ +-------+----------+--------------------------------------------------------------------------------------------------------+
+ | name | no | Filters :term:`Profiles` by :ref:`profile-name` |
+ +-------+----------+--------------------------------------------------------------------------------------------------------+
+ | param | no | Used to filter :term:`Profiles` by the :ref:`parameter-id` of a :term:`Parameter` associated with them |
+ +-------+----------+--------------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -52,14 +52,14 @@ Request Structure
Response Structure
------------------
-:cdn: The integral, unique identifier of the CDN to which this profile belongs
-:cdnName: The CDN name
-:description: A description of the profile
-:id: The integral, unique identifier of this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: The name of the profile
-:routingDisabled: A boolean which, if ``true`` will disable Traffic Router's routing to servers using this profile
-:type: The name of the 'type' of the profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:cdnName: The name of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
@@ -91,7 +91,7 @@ Response Structure
``POST``
========
-Creates a new profile.
+Creates a new :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -99,11 +99,11 @@ Creates a new profile.
Request Structure
-----------------
-:name: Name of the new profile
-:description: A description of the new profile
-:cdn: The integral, unique identifier of the CDN to which the profile shall be assigned
-:type: The type of the profile
-:routingDisabled: A boolean which, if ``true``, will prevent the Traffic Router from directing traffic to any servers assigned this profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` shall belong
+:description: The :term:`Profile`'s :ref:`profile-description`
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Request Example
@@ -126,14 +126,14 @@ Request Structure
Response Structure
------------------
-:cdn: The integral, unique identifier of the CDN to which this profile belongs
-:cdnName: The CDN name
-:description: A description of the profile
-:id: The integral, unique identifier of this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: The name of the profile
-:routingDisabled: A boolean which, if ``true`` will disable Traffic Router's routing to servers using this profile
-:type: The name of the 'type' of the profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:cdnName: The name of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profiles_id.rst b/docs/source/api/profiles_id.rst
index 6cca196..4a91223 100644
--- a/docs/source/api/profiles_id.rst
+++ b/docs/source/api/profiles_id.rst
@@ -32,11 +32,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +-----------+----------------------------------------------------------------+
- | Parameter | Description |
- +===========+================================================================+
- | id | The integral, unique identifier of the profile to be retrieved |
- +-----------+----------------------------------------------------------------+
+ +-----------+--------------------------------------------------------------+
+ | Parameter | Description |
+ +===========+==============================================================+
+ | id | The :ref:`profile-id` of the :term:`Profile` to be retrieved |
+ +-----------+--------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -49,24 +49,24 @@ Request Structure
Response Structure
------------------
-:cdn: The integral, unique identifier of the CDN to which this profile belongs
-:cdnName: The CDN name
-:description: A description of the profile
-:id: The integral, unique identifier of this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: The name of the profile
-:params: An array of parameters in use by this profile
-
- :configFile: The *base* filename to which this parameter belongs
- :id: An integral, unique identifier for this parameter
- :lastUpdated: The date and time at which this parameter was last modified in ISO format
- :name: The parameter name
- :profiles: An array of profile names that use this parameter
- :secure: When ``true``, the parameter value is visible only to "admin"-role users
- :value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
-
-:routingDisabled: A boolean which, if ``true`` will disable Traffic Router's routing to servers using this profile
-:type: The name of the 'type' of the profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:cdnName: The name of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:params: An array of :term:`Parameters` in use by this :term:`Profile`
+
+ :configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+ :id: The :term:`Parameter`'s :ref:`parameter-id`
+ :lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+ :name: :ref:`parameter-name` of the :term:`Parameter`
+ :profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+ :secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+ :value: The :term:`Parameter`'s :ref:`parameter-value`
+
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
@@ -119,7 +119,7 @@ Response Structure
``PUT``
=======
-Replaces the specified profile with the one in the response payload
+Replaces the specified :term:`Profile` with the one in the request payload
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -129,21 +129,20 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+---------------------------------------------------------------+
- | Name | Description |
- +======+===============================================================+
- | ID | The integral, unique identifier of the profile being modified |
- +------+---------------------------------------------------------------+
+ +------+-------------------------------------------------------------+
+ | Name | Description |
+ +======+=============================================================+
+ | ID | The :ref:`profile-id` of the :term:`Profile` being modified |
+ +------+-------------------------------------------------------------+
-:name: New of the name profile
-:description: A new description of the new profile
-:cdn: The integral, unique identifier of the CDN to which the profile shall be assigned
-:type: The type of the profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` will belong
+:description: The :term:`Profile`'s new :ref:`profile-description`
+:name: The :term:`Profile`'s new :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s new :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s new :ref:`profile-type`
.. warning:: Changing this will likely break something, be **VERY** careful when modifying this value
-:routingDisabled: A boolean which, if ``true``, will prevent the Traffic Router from directing traffic to any servers assigned this profile
-
.. code-block:: http
:caption: Request Example
@@ -165,14 +164,14 @@ Request Structure
Response Structure
------------------
-:cdn: The integral, unique identifier of the CDN to which this profile belongs
-:cdnName: The CDN name
-:description: A description of the profile
-:id: The integral, unique identifier of this profile
-:lastUpdated: The date and time at which this profile was last updated
-:name: The name of the profile
-:routingDisabled: A boolean which, if ``true`` will disable Traffic Router's routing to servers using this profile
-:type: The name of the 'type' of the profile
+:cdn: The integral, unique identifier of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:cdnName: The name of the :ref:`profile-cdn` to which this :term:`Profile` belongs
+:description: The :term:`Profile`'s :ref:`profile-description`
+:id: The :term:`Profile`'s :ref:`profile-id`
+:lastUpdated: The date and time at which this :term:`Profile` was last updated, in an ISO-like format
+:name: The :term:`Profile`'s :ref:`profile-name`
+:routingDisabled: The :term:`Profile`'s :ref:`profile-routing-disabled` setting
+:type: The :term:`Profile`'s :ref:`profile-type`
.. code-block:: http
:caption: Response Example
@@ -209,7 +208,7 @@ Response Structure
``DELETE``
==========
-Allows user to delete a profile.
+Allows user to delete a :term:`Profile`.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -219,11 +218,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+--------------------------------------------------------------+
- | Name | Description |
- +======+==============================================================+
- | ID | The integral, unique identifier of the profile being deleted |
- +------+--------------------------------------------------------------+
+ +------+------------------------------------------------------------+
+ | Name | Description |
+ +======+============================================================+
+ | ID | The :ref:`profile-id` of the :term:`Profile` being deleted |
+ +------+------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
diff --git a/docs/source/api/profiles_id_parameters.rst b/docs/source/api/profiles_id_parameters.rst
index 033c783..e7cd0f1 100644
--- a/docs/source/api/profiles_id_parameters.rst
+++ b/docs/source/api/profiles_id_parameters.rst
@@ -24,7 +24,7 @@
.. deprecated:: 1.1
Refer to the ``params`` key in the response of :ref:`to-api-profiles-id` instead
-Retrieves all parameters assigned to the profile.
+Retrieves all :term:`Parameters` assigned to the :term:`Profile`.
:Auth. Required: Yes
:Roles Required: None
@@ -34,11 +34,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+------------------------------------------------------------------------------------+
- | Name | Description |
- +======+====================================================================================+
- | ID | An integral, unique identifier for the profile for which parameters will be listed |
- +------+------------------------------------------------------------------------------------+
+ +------+------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+==========================================================================================+
+ | ID | The :ref:`profile-id` of the :term:`Profile` for which :term:`Parameters` will be listed |
+ +------+------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -51,13 +51,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
@@ -114,7 +114,7 @@ Response Structure
.. deprecated:: 1.1
Use :ref:`to-api-profiles-name-name-parameters` instead
-Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter is already associated with the profile, keep the association.
+Associates :term:`Parameters` to a :term:`Profile`. If the :term:`Parameter` does not exist, creates it and associates it to the :term:`Profile`. If the :term:`Parameter` already exists, associates it to the :term:`Profile`. If the :term:`Parameter` is already associated with the :term:`Profile`, keep the association.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -124,27 +124,27 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+-------------------------------------------------------------------------------------+
- | Name | Description |
- +======+=====================================================================================+
- | ID | An integral, unique identifier for the profile to which parameters will be assigned |
- +------+-------------------------------------------------------------------------------------+
+ +------+-------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+===========================================================================================+
+ | ID | The :ref:`profile-id` of the :term:`Profile` to which :term:`Parameters` will be assigned |
+ +------+-------------------------------------------------------------------------------------------+
This endpoint accepts two formats for the request payload:
Single Object Format
- For assigning a single parameter to a single profile
+ For assigning a single :term:`Parameter` to a single :term:`Profile`
Parameter Array Format
- For making multiple assignments of parameters to profiles simultaneously
+ For making multiple assignments of :term:`Parameters` to :term:`Profiles` simultaneously
-.. warning:: Most API endpoints dealing with parameters treat ``secure`` as a boolean value, whereas this endpoint takes the legacy approach of treating it as an integer. Be careful when passing data back and forth, as boolean values will **not** be accepted by this endpoint!
+.. warning:: Most API endpoints dealing with :term:`Parameters` treat :ref:`parameter-secure` as a boolean value, whereas this endpoint takes the legacy approach of treating it as an integer. Be careful when passing data back and forth, as boolean values will **not** be accepted by this endpoint!
Single Parameter Format
"""""""""""""""""""""""
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:name: Parameter name
-:secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example - Single Parameter Format
@@ -167,10 +167,10 @@ Single Parameter Format
Parameter Array Format
""""""""""""""""""""""
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:name: Parameter name
-:secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example - Parameter Array Format
@@ -198,15 +198,15 @@ Parameter Array Format
Response Structure
------------------
-:parameters: An array of objects representing the parameters which have been assigned
+:parameters: An array of objects representing the :term:`Parameters` which have been assigned
- :configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
- :name: Parameter name
- :secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
- :value: Parameter value
+ :configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+ :name: :ref:`parameter-name` of the :term:`Parameter`
+ :secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+ :value: The :term:`Parameter`'s :ref:`parameter-value`
-:profileId: The integral, unique identifier for the profile to which the parameter(s) have been assigned
-:profileName: Name of the profile to which the parameter(s) have been assigned
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameter`\ (s) have been assigned
+:profileName: :ref:`profile-name` of the :term:`Profile` to which the :term:`Parameter`\ (s) have been assigned
.. code-block:: http
:caption: Response Example - Single Parameter Format
diff --git a/docs/source/api/profiles_id_unassigned_parameters.rst b/docs/source/api/profiles_id_unassigned_parameters.rst
index b992b38..8266d9c 100644
--- a/docs/source/api/profiles_id_unassigned_parameters.rst
+++ b/docs/source/api/profiles_id_unassigned_parameters.rst
@@ -22,7 +22,7 @@
``GET``
=======
-Retrieves all parameters NOT assigned to the specified profile.
+Retrieves all :term:`Parameters` *not* assigned to the specified :term:`Profile`.
:Auth. Required: Yes
:Roles Required: None
@@ -32,11 +32,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+-----------------------------------------------------------------------------------------------+
- | Name | Description |
- +======+===============================================================================================+
- | ID | The integral, unique identifier of the profile for which unassigned parameters will be listed |
- +------+-----------------------------------------------------------------------------------------------+
+ +------+-----------------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+=====================================================================================================+
+ | ID | The :ref:`profile-id` of the :term:`Profile` for which unassigned :term:`Parameters` will be listed |
+ +------+-----------------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -49,13 +49,13 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profiles_name_name_copy_copy.rst b/docs/source/api/profiles_name_name_copy_copy.rst
index 7431d2b..8a3d363 100644
--- a/docs/source/api/profiles_name_name_copy_copy.rst
+++ b/docs/source/api/profiles_name_name_copy_copy.rst
@@ -21,7 +21,7 @@
``POST``
========
-Copy profile to a new profile. The new profile name must not exist.
+Copy :term:`Profile` to a new :term:`Profile`. The new :term:`Profile`'s :ref:`profile-name` must not already exist.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -31,13 +31,13 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+------------------------------------------------------+
- | Name | Description |
- +======+======================================================+
- | name | The name of the new profile |
- +------+------------------------------------------------------+
- | copy | The name of profile from which the copy will be made |
- +------+------------------------------------------------------+
+ +------+-----------------------------------------------------------------------------+
+ | Name | Description |
+ +======+=============================================================================+
+ | name | The :ref:`profile-name` of the new :term:`Profile` |
+ +------+-----------------------------------------------------------------------------+
+ | copy | The :ref:`profile-name` of :term:`Profile` from which the copy will be made |
+ +------+-----------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -50,11 +50,11 @@ Request Structure
Response Structure
------------------
-:description: The description of the new profile
-:id: An integral, unique identifier for the new profile
-:idCopyFrom: The integral, unique identifier for the profile from which the copy was made
-:name: The name of the new profile
-:profileCopyFrom: The name of the profile from which the copy was made
+:description: The new :term:`Profile`'s :ref:`profile-description`
+:id: The :ref:`profile-id` of the new :term:`Profile`
+:idCopyFrom: The :ref:`profile-id` of the :term:`Profile` from which the copy was made
+:name: The :ref:`profile-name` of the new :term:`Profile`
+:profileCopyFrom: The :ref:`profile-name` of the :term:`Profile` from which the copy was made
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profiles_name_name_parameters.rst b/docs/source/api/profiles_name_name_parameters.rst
index a1072a4..6000269 100644
--- a/docs/source/api/profiles_name_name_parameters.rst
+++ b/docs/source/api/profiles_name_name_parameters.rst
@@ -21,7 +21,7 @@
``GET``
=======
-Retrieves all parameters associated with a given profile
+Retrieves all :term:`Parameters` associated with a given :term:`Profile`
:Auth. Required: Yes
:Roles Required: None
@@ -31,11 +31,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+-------------------------------------------------------------+
- | Name | Description |
- +======+=============================================================+
- | name | The name of the profile for which parameters will be listed |
- +------+-------------------------------------------------------------+
+ +------+--------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+============================================================================================+
+ | name | The :ref:`profile-name` of the :term:`Profile` for which :term:`Parameters` will be listed |
+ +------+--------------------------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -48,15 +48,16 @@ Request Structure
Response Structure
------------------
-:configFile: The *base* filename to which this parameter belongs
-:id: An integral, unique identifier for this parameter
-:lastUpdated: The date and time at which this parameter was last modified in ISO format
-:name: The parameter name
-:profiles: An array of profile names that use this parameter
-:secure: When ``true``, the parameter value is visible only to "admin"-role users
-:value: The parameter value - if ``secure`` is true and the user does not have the "admin" role this will be obfuscated (at the time of this writing the obfuscation value is defined to be ``"********"``) but **not** missing
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:id: The :term:`Parameter`'s :ref:`parameter-id`
+:lastUpdated: The date and time at which this :term:`Parameter` was last updated, in an ISO-like format
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:profiles: An array of :term:`Profile` :ref:`Names <profile-name>` that use this :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
-**Response Example** ::
+.. code-block:: http
+ :caption: Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
@@ -107,7 +108,7 @@ Response Structure
``POST``
========
-Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter is already associated with the profile, keep the association.
+Associates :term:`Parameters` to a :term:`Profile`. If the :term:`Parameter` does not exist, creates it and associates it to the :term:`Profile`. If the :term:`Parameter` already exists, associates it to the :term:`Profile`. If the :term:`Parameter` is already associated with the :term:`Profile`, keep the association.
:Auth. Required: Yes
:Roles Required: "admin" or "operations"
@@ -117,11 +118,11 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +------+--------------------------------------------------------------+
- | Name | Description |
- +======+==============================================================+
- | name | The name of the profile to which parameters will be assigned |
- +------+--------------------------------------------------------------+
+ +------+---------------------------------------------------------------------------------------------+
+ | Name | Description |
+ +======+=============================================================================================+
+ | name | The :ref:`profile-name` of the :term:`Profile` to which :term:`Parameters` will be assigned |
+ +------+---------------------------------------------------------------------------------------------+
This endpoint accepts two formats for the request payload:
@@ -134,10 +135,10 @@ Parameter Array Format
Single Parameter Format
"""""""""""""""""""""""
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:name: Parameter name
-:secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example - Single Parameter Format
@@ -159,10 +160,10 @@ Single Parameter Format
Parameter Array Format
""""""""""""""""""""""
-:configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
-:name: Parameter name
-:secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
-:value: Parameter value
+:configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+:name: :ref:`parameter-name` of the :term:`Parameter`
+:secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+:value: The :term:`Parameter`'s :ref:`parameter-value`
.. code-block:: http
:caption: Request Example - Parameter Array Format
@@ -190,15 +191,15 @@ Parameter Array Format
Response Structure
------------------
-:parameters: An array of objects representing the parameters which have been assigned
+:parameters: An array of objects representing the :term:`Parameters` which have been assigned
- :configFile: The *base* filename of the configuration file to which this parameter shall belong e.g. "foo" not "/path/to/foo"
- :name: Parameter name
- :secure: An integer which, when any number other than ``0``, will prohibit users who do not have the "admin" role from viewing the parameter's ``value`` (at the time of this writing the obfuscation value is defined to be ``"********"``)
- :value: Parameter value
+ :configFile: The :term:`Parameter`'s :ref:`parameter-config-file`
+ :name: :ref:`parameter-name` of the :term:`Parameter`
+ :secure: A boolean value that describes whether or not the :term:`Parameter` is :ref:`parameter-secure`
+ :value: The :term:`Parameter`'s :ref:`parameter-value`
-:profileId: The integral, unique identifier for the profile to which the parameter(s) have been assigned
-:profileName: Name of the profile to which the parameter(s) have been assigned
+:profileId: The :ref:`profile-id` of the :term:`Profile` to which the :term:`Parameter`\ (s) have been assigned
+:profileName: :ref:`profile-name` of the :term:`Profile` to which the :term:`Parameter`\ (s) have been assigned
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profiles_profile_configfiles_ats_filename.rst b/docs/source/api/profiles_profile_configfiles_ats_filename.rst
index 69548fb..b5ef810 100644
--- a/docs/source/api/profiles_profile_configfiles_ats_filename.rst
+++ b/docs/source/api/profiles_profile_configfiles_ats_filename.rst
@@ -33,13 +33,13 @@ Request Structure
-----------------
.. table:: Request Path Parameters
- +-----------+-------------------+--------------------------------------------------------------+
- | Parameter | Type | Description |
- +===========+===================+==============================================================+
- | profile | string or integer | Either the name or integral, unique, identifier of a profile |
- +-----------+-------------------+--------------------------------------------------------------+
- | filename | string | The name of a configuration file used by ``profile`` |
- +-----------+-------------------+--------------------------------------------------------------+
+ +-----------+-------------------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===========+===================+==========================================================================+
+ | profile | string or integer | Either the :ref:`profile-name` or :ref:`profile-id` of a :term:`Profile` |
+ +-----------+-------------------+--------------------------------------------------------------------------+
+ | filename | string | The name of a configuration file used by ``profile`` |
+ +-----------+-------------------+--------------------------------------------------------------------------+
.. code-block:: http
:caption: Request Example
@@ -52,7 +52,7 @@ Request Structure
Response Structure
------------------
-.. note:: If the file identified by ``filename`` doesn't exist at the profile, a JSON response will be returned and the ``alerts`` array will contain a ``"level": "error"`` node which suggests other scopes to check for the configuration file.
+.. note:: If the file identified by ``filename`` doesn't exist at the :term:`Profile`, a JSON response will be returned and the ``alerts`` array will contain a ``"level": "error"`` node which suggests other scopes to check for the configuration file.
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/profiles_trimmed.rst b/docs/source/api/profiles_trimmed.rst
index 92ef4d0..4dcc96f 100644
--- a/docs/source/api/profiles_trimmed.rst
+++ b/docs/source/api/profiles_trimmed.rst
@@ -31,7 +31,7 @@ No parameters available
Response Structure
------------------
-:name: The name of the profile
+:name: The :ref:`profile-name` of the :term:`Profile`
.. code-block:: http
:caption: Response Example
diff --git a/docs/source/api/servers.rst b/docs/source/api/servers.rst
index 614c85f..cae3c90 100644
--- a/docs/source/api/servers.rst
+++ b/docs/source/api/servers.rst
@@ -42,7 +42,7 @@ Request Structure
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
| id | no | Return only the server with this integral, unique identifier |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
- | profileId | no | Return only those servers that are using the profile identified by this integral, unique identifier |
+ | profileId | no | Return only those servers that are using the :term:`Profile` that has this :ref:`profile-id` |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
| status | no | Return only those servers with this status - see :ref:`health-proto` |
+------------+----------+-------------------------------------------------------------------------------------------------------------------+
@@ -92,9 +92,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The name of the physical location where the server resides
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profile: The name of the profile this server uses
-:profileDesc: A description of the profile this server uses
-:profileId: An integral, unique identifier for the profile used by this server
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: A string indicating "server rack" location
:routerHostName: The human-readable name of the router responsible for reaching this server
@@ -216,7 +216,7 @@ Request Structure
:mgmtIpGateway: An optional IPv4 address of a gateway used by some network interface on the server used for 'management'
:mgmtIpNetmask: An optional IPv4 subnet mask used by some network interface on the server used for 'management'
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profileId: An integral, unique identifier for the profile used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` that shall be used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: An optional string indicating "server rack" location
:routerHostName: An optional string containing the human-readable name of the router responsible for reaching this server
@@ -311,9 +311,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The name of the physical location where the server resides
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profile: The name of the profile this server uses
-:profileDesc: A description of the profile this server uses
-:profileId: An integral, unique identifier for the profile used by this server
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: A string indicating "server rack" location
:routerHostName: The human-readable name of the router responsible for reaching this server
diff --git a/docs/source/api/servers_hostname_name_details.rst b/docs/source/api/servers_hostname_name_details.rst
index ee8e2aa..9578818 100644
--- a/docs/source/api/servers_hostname_name_details.rst
+++ b/docs/source/api/servers_hostname_name_details.rst
@@ -67,8 +67,8 @@ Response Structure
:ipNetmask: The IPv4 subnet mask used by ``interfaceName``
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The name of the physical location where the server resides
-:profile: The name of the profile this server uses
-:profileDesc: A description of the profile this server uses
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` used by this server
:rack: A string indicating "server rack" location
:routerHostName: The human-readable name of the router responsible for reaching this server
:routerPortName: The human-readable name of the port used by the router responsible for reaching this server
diff --git a/docs/source/api/servers_id.rst b/docs/source/api/servers_id.rst
index e298ad5..ad98e56 100644
--- a/docs/source/api/servers_id.rst
+++ b/docs/source/api/servers_id.rst
@@ -83,9 +83,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The name of the physical location where the server resides
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profile: The name of the profile this server uses
-:profileDesc: A description of the profile this server uses
-:profileId: An integral, unique identifier for the profile used by this server
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: A string indicating "server rack" location
:routerHostName: The human-readable name of the router responsible for reaching this server
@@ -215,7 +215,7 @@ Request Structure
:mgmtIpGateway: An optional IPv4 address of a gateway used by some network interface on the server used for 'management'
:mgmtIpNetmask: An optional IPv4 subnet mask used by some network interface on the server used for 'management'
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profileId: An integral, unique identifier for the profile used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` that shall be used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: An optional string indicating "server rack" location
:routerHostName: An optional string containing the human-readable name of the router responsible for reaching this server
@@ -310,9 +310,9 @@ Response Structure
:offlineReason: A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status
:physLocation: The name of the physical location where the server resides
:physLocationId: An integral, unique identifier for the physical location where the server resides
-:profile: The name of the profile this server uses
-:profileDesc: A description of the profile this server uses
-:profileId: An integral, unique identifier for the profile used by this server
+:profile: The :ref:`profile-name` of the :term:`Profile` used by this server
+:profileDesc: A :ref:`profile-description` of the :term:`Profile` used by this server
+:profileId: The :ref:`profile-id` the :term:`Profile` used by this server
:revalPending: A boolean value which, if ``true`` indicates that this server has pending content invalidation/revalidation
:rack: A string indicating "server rack" location
:routerHostName: The human-readable name of the router responsible for reaching this server
diff --git a/docs/source/api/servers_id_deliveryservices.rst b/docs/source/api/servers_id_deliveryservices.rst
index 4a96d36..fa4d1b3 100644
--- a/docs/source/api/servers_id_deliveryservices.rst
+++ b/docs/source/api/servers_id_deliveryservices.rst
@@ -67,7 +67,7 @@ Response Structure
.. versionadded:: 1.4
-:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
+:deepCachingType: The :ref:`ds-deep-caching` setting for this :term:`Delivery Service`
.. versionadded:: 1.3
@@ -116,9 +116,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
diff --git a/docs/source/api/servers_server_configfiles_ats.rst b/docs/source/api/servers_server_configfiles_ats.rst
index 913bfbc..50af45a 100644
--- a/docs/source/api/servers_server_configfiles_ats.rst
+++ b/docs/source/api/servers_server_configfiles_ats.rst
@@ -45,8 +45,8 @@ Response Structure
:cdnId: The integral, unique, identifier of the CDN to which ``server`` is assigned
:cdnName: The name of the CDN to which ``server`` is assigned
- :profileId: The integral, unique, identifier of the profile used by ``server``
- :profileName: The name of the profile used by ``server``
+ :profileName: The :ref:`profile-name` of the :term:`Profile` used by this server
+ :profileId: The :ref:`profile-id` the :term:`Profile` used by this server
:serverId: An integral, unique, identifier for ``server``
:serverIpv4: IPv4 address of the server
:serverTcpPort: The port number on which ``server`` listens for incoming TCP connections
@@ -63,7 +63,7 @@ Response Structure
"cdns"
The file is used by all caches in the CDN
"profiles"
- The file is used by all servers with the same profile
+ The file is used by all servers with the same :term:`Profile`
"servers"
The most specific grouping of servers which use this file is simply a collection of distinct servers
diff --git a/docs/source/api/system_info.rst b/docs/source/api/system_info.rst
index 60512d9..d4b37ff 100644
--- a/docs/source/api/system_info.rst
+++ b/docs/source/api/system_info.rst
@@ -33,7 +33,7 @@ Response Structure
------------------
:parameters: An object containing information about the Traffic Ops server
- .. note:: These are all the parameters in the ``GLOBAL`` profile, so the keys below are merely those present by default required for Traffic Control to operate
+ .. note:: These are all the :term:`Parameters` in :ref:`the-global-profile`, so the keys below are merely those present by default required for Traffic Control to operate
:default_geo_miss_latitude: The default latitude used when geographic lookup of an IP address fails
:default_geo_miss_longitude: The default longitude used when geographic lookup of an IP address fails
diff --git a/docs/source/api/users_id_deliveryservices.rst b/docs/source/api/users_id_deliveryservices.rst
index f9e3c1e..34cb3fc 100644
--- a/docs/source/api/users_id_deliveryservices.rst
+++ b/docs/source/api/users_id_deliveryservices.rst
@@ -119,9 +119,9 @@ Response Structure
:multiSiteOrigin: A boolean that defines the use of :ref:`ds-multi-site-origin` by this :term:`Delivery Service`
:orgServerFqdn: The :ref:`ds-origin-url`
:originShield: A :ref:`ds-origin-shield` string
-:profileDescription: The description of the :term:`Delivery Service`'s :ref:`ds-profile`, if any
-:profileId: The integral, unique identifier for :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
-:profileName: The name of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated, if any
+:profileDescription: The :ref:`profile-description` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileId: The :ref:`profile-id` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
+:profileName: The :ref:`profile-name` of the :ref:`ds-profile` with which this :term:`Delivery Service` is associated
:protocol: An integral, unique identifier that corresponds to the :ref:`ds-protocol` used by this :term:`Delivery Service`
:qstringIgnore: An integral, unique identifier that corresponds to the :ref:`ds-qstring-handling` setting on this :term:`Delivery Service`
:rangeRequestHandling: An integral, unique identifier that corresponds to the :ref:`ds-range-request-handling` setting on this :term:`Delivery Service`
diff --git a/docs/source/development/documentation_guidelines.rst b/docs/source/development/documentation_guidelines.rst
index fbcb013..d1a776b 100644
--- a/docs/source/development/documentation_guidelines.rst
+++ b/docs/source/development/documentation_guidelines.rst
@@ -189,7 +189,7 @@ Documenting API Routes
----------------------
Follow all of the formatting conventions in `Formatting`_. Maintain the structural format of the API documentation as outlined in the :ref:`to-api` section. API routes that have variable paths e.g. :ref:`to-api-profiles-id` should use `mustache templates <https://mustache.github.io/mustache.5.html>`_ **not** the Mojolicious-specific ``:param`` syntax. This keeps the templates generic, familiar, and reflects the inability of a request path to contain procedural instructions or program log [...]
-When documenting an API route, be sure to include *all* methods, request/response JSON payload fields, path parameters, and query parameters, whether they are optional or not. When describing a field in a JSON payload, remember that JSON does not have "hashes" it has "objects" or even "maps". When documenting path parameters such as profile ID in :ref:`to-api-profiles-id`, consider that the endpoint path cannot be formed without defining **all** path parameters, and so to label them as " [...]
+When documenting an API route, be sure to include *all* methods, request/response JSON payload fields, path parameters, and query parameters, whether they are optional or not. When describing a field in a JSON payload, remember that JSON does not have "hashes" it has "objects" or even "maps". When documenting path parameters such as :term:`Profile` :ref:`profile-id` in :ref:`to-api-profiles-id`, consider that the endpoint path cannot be formed without defining **all** path parameters, an [...]
The "Response Example" must **always** exist. "TODO" is **not** an acceptable Response Example for new endpoints. The "Request Example" must only exist if the request requires data in the body (most commonly this will be for ``PATCH``, ``POST`` and ``PUT`` methods). It is, however, strongly advised that a request example be given if the endpoint takes Query Parameters or Path Parameters, and it is required if the Response Example is a response to a request that used a query or path param [...]
diff --git a/docs/source/development/traffic_router/traffic_router_api.rst b/docs/source/development/traffic_router/traffic_router_api.rst
index bbf0378..5efabb4 100644
--- a/docs/source/development/traffic_router/traffic_router_api.rst
+++ b/docs/source/development/traffic_router/traffic_router_api.rst
@@ -18,7 +18,7 @@
******************
Traffic Router API
******************
-By default, Traffic Router serves its API via HTTP (not HTTPS) on port 3333. This can be configured in :file:`/opt/traffic_router/conf/server.xml` or by setting a :term:`Parameter` named ``api.port`` with ``configFile`` ``server.xml`` on the Traffic Router's :term:`Profile`.
+By default, Traffic Router serves its API via HTTP (not HTTPS) on port 3333. This can be configured in :file:`/opt/traffic_router/conf/server.xml` or by setting a :term:`Parameter` with the :ref:`parameter-name` "api.port", and the :ref:`parameter-config-file` "server.xml" on the Traffic Router's :term:`Profile`.
Traffic Router API endpoints only respond to ``GET`` requests.
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
index c5cc845..97f99c4 100644
--- a/docs/source/glossary.rst
+++ b/docs/source/glossary.rst
@@ -245,11 +245,15 @@ Glossary
The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
ORT
- The "Operational Readiness Test" script that stitches the configuration configured in Traffic Portal and generated by Traffic Ops into the :term:`cache server`\ s. See :ref:`traffic-ops-ort` for more information.
+ The "Operational Readiness Test" script that stitches the configuration configured in Traffic Portal and generated by Traffic Ops into the :term:`cache servers`.
+
+ .. seealso:: See :ref:`traffic-ops-ort` for a Python implementation of ORT that is (theoretically) compatible with the one actually provided in Apache Traffic Control releases.
Parameter
Parameters
- Typically refers to a line in a configuration file, but in practice can represent any arbitrary configuration option
+ Typically refers to a line in a configuration file, but in practice can represent any arbitrary configuration option.
+
+ .. seealso:: The :ref:`profiles-and-parameters` overview section.
parent
parents
@@ -261,75 +265,11 @@ Glossary
Profile
Profiles
- A :dfn:`Profile` is, most generally, a group of :term:`Parameter`\ s that will be applied to a server. :dfn:`Profiles` are typically re-used by all Edge-Tier :term:`cache server`\ s within a CDN or :term:`Cache Group`. A :dfn:`Profile` will, in addition to configuration :term:`Parameter`\ s, define the CDN to which a server belongs and the "Type" of the profile - which determines some behaviors of Traffic Control components. The allowed "Types" of :dfn:`Profiles` are **not** the same a [...]
-
- UNK_PROFILE
- A catch-all type that can be assigned to anything without imbuing it with any special meaning or behavior
- TR_PROFILE
- A Traffic Router Profile.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``CCR_`` or ``TR_``. 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!
-
- TM_PROFILE
- A Traffic Monitor Profile.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``RASCAL_`` or ``TM_``. 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!
-
- TS_PROFILE
- A Traffic Stats Profile
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* be ``TRAFFIC_STATS``. 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!
-
- TP_PROFILE
- A Traffic Portal Profile
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``TRAFFIC_PORTAL``. 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!
-
- INFLUXDB_PROFILE
- A Profile used with `InfluxDB <https://www.influxdata.com/>`_, which is used by Traffic Stats.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``INFLUXDB``. 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!
-
- RIAK_PROFILE
- A Profile used for each `Riak <http://basho.com/products/riak-kv/>`_ server in a Traffic Stats cluster.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``RIAK``. 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!
-
- SPLUNK_PROFILE
-
- A Profile meant to be used with `Splunk <https://www.splunk.com/>`_ servers.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``SPLUNK``. 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!
-
- ORG_PROFILE
- Origin Profile.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``MSO``, or contain either ``ORG`` or ``ORIGIN`` anywhere in the name. 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!
-
- KAFKA_PROFILE
- A Profile for `Kafka <https://kafka.apache.org/>`_ servers.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``KAFKA``. 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!
-
- LOGSTASH_PROFILE
- A Profile for `Logstash <https://www.elastic.co/products/logstash>`_ servers.
-
- .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``LOGSTASH_``. 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!
-
- ES_PROFILE
- A Profile for `ElasticSearch <https://www.elastic.co/products/elasticsearch>`_ servers.
-
- .. 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).
-
- .. 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!
-
+ A :dfn:`Profile` is, most generally, a group of :term:`Parameters` that will be applied to a server. :dfn:`Profiles` are typically re-used by all :term:`Edge-Tier cache servers` within a CDN or :term:`Cache Group`. A :dfn:`Profile` will, in addition to configuration :term:`Parameters`, define the CDN to which a server belongs and the :ref:`"Type" <profile-type>` of the Profile - which determines some behaviors of Traffic Control components. The allowed :ref:`"Types" <profile-type>` of [...]
.. 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 [...]
+ .. seealso:: The :ref:`profiles-and-parameters` overview section.
Queue
Queue Updates
@@ -342,7 +282,7 @@ Glossary
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*.
+ .. warning:: Updates to :term:`Parameters` with certain :ref:`parameter-config-file` 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
@@ -438,6 +378,8 @@ Glossary
Snapshot
Snapshots
+ CDN Snapshot
+ CDN Snapshots
Previously called a "CRConfig" or "CRConfig.json" (and still called such in many places), this is a rather large set of routing information generated from a CDN's configuration and topology.
Status
diff --git a/docs/source/overview/delivery_services.rst b/docs/source/overview/delivery_services.rst
index aed58c1..c49b4e1 100644
--- a/docs/source/overview/delivery_services.rst
+++ b/docs/source/overview/delivery_services.rst
@@ -518,7 +518,7 @@ An experimental feature that allows administrators to list additional forward pr
Profile
-------
-Either the name of a :term:`Profile` used by this Delivery Service, or an integral, unique identifier for said :term:`Profile`.
+Either the :ref:`profile-name` of a :term:`Profile` used by this Delivery Service, or the :ref:`profile-id` of said :term:`Profile`.
.. table:: Aliases
diff --git a/docs/source/overview/index.rst b/docs/source/overview/index.rst
index bdb5393..f8e94a8 100644
--- a/docs/source/overview/index.rst
+++ b/docs/source/overview/index.rst
@@ -13,18 +13,13 @@
.. limitations under the License.
..
+************************
Traffic Control Overview
************************
Introduces the Traffic Control architecture, components, and their integration.
.. toctree::
:maxdepth: 2
+ :glob:
- introduction.rst
- traffic_ops
- traffic_portal
- traffic_router
- traffic_monitor
- traffic_stats
- traffic_vault
- delivery_services
+ *
diff --git a/docs/source/overview/profiles_and_parameters.rst b/docs/source/overview/profiles_and_parameters.rst
new file mode 100644
index 0000000..bb739a6
--- /dev/null
+++ b/docs/source/overview/profiles_and_parameters.rst
@@ -0,0 +1,651 @@
+..
+.. 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.
+..
+
+.. _Apache Traffic Server configuration files: https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/index.en.html
+
+.. _profiles-and-parameters:
+
+***********************
+Profiles and Parameters
+***********************
+:dfn:`Profiles` are a collection of configuration options, defined partially by the Profile's Type_ (not to be confused with the more general ":term:`Type`" used by many other things in Traffic Control) and partially by the :dfn:`Parameters` set on them. Mainly, Profiles and Parameters are used to configure :term:`cache servers`, but they can also be used to configure parts of (nearly) any Traffic Control component, and can even be linked with more abstract concepts like :ref:`Delivery S [...]
+
+.. _profiles:
+
+Profiles
+========
+
+Properties
+----------
+Profile objects as represented in e.g. the :ref:`to-api` or in the :ref:`Traffic Portal Profiles view <tp-configure-profiles>` have several properties that describe their general operation. In certain contexts, the Parameters_ assigned to a Profile (and/or the integral, unique identifiers thereof) may appear as properties of the Profile, but that will not appear in this section as a description of Parameters_ is provided in the section of that name.
+
+.. _profile-cdn:
+
+CDN
+"""
+A Profile is restricted to operate within a single CDN. Often, "CDN" (or "cdn") refers to the integral, unique identifier of the CDN, but occasionally it refers to the *name* of said CDN. It may also appear as e.g. ``cdnId`` or ``cdnName`` in :ref:`to-api` payloads and responses. A Profile may only be assigned to a server, :term:`Delivery Service`, or :term:`Cache Group` within the same CDN as the Profile itself.
+
+.. _profile-description:
+
+Description
+"""""""""""
+Profiles may have a description provided by the creating user (or Traffic Control itself in the case of the `Default Profiles`_). The :ref:`to-api` does not enforce length requirements on the description (though Traffic Portal does), and so it's possible for Profiles to have empty descriptions, though it is strongly recommended that Profiles have meaningful descriptions.
+
+.. _profile-id:
+
+ID
+""
+An integral, unique identifier for the Profile.
+
+.. _profile-name:
+
+Name
+""""
+Ostensibly this is simply the Profile's name. However, the name of a Profile has drastic consequences for how Traffic Control treats it. Particularly, the name of a Profile is heavily conflated with its Type_. These relationships are discussed further in the Type_ section, on a Type-by-Type basis.
+
+.. _profile-routing-disabled:
+
+Routing Disabled
+""""""""""""""""
+This property can - and in fact *must* - exist on a Profile of any Type_, but it only has any meaning on a Profile that has a name matching the constraints placed on the names of ATS_PROFILE-`Type`_ Profiles. This means that it will also have meaning on Profiles of Type_ UNK_PROFILE that for whatever reason have names beginning with ``EDGE`` or ``MID``. When this field is defined as ``1`` (may be displayed as ``true`` in e.g. Traffic Portal), Traffic Router will not be informed of any :t [...]
+
+.. _profile-type:
+
+Type
+""""
+A Profile's :dfn:`Type` determines how its configured Parameters_ are treated by various components, and often even determine how the object using the Profile is treated (particularly when it is a server). Unlike the more general ":term:`Type`" employed by Traffic Control, the allowed Types of Profiles are set in stone, and they are as follows.
+
+.. danger:: Nearly all of these 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 that matters [...]
+
+ATS_PROFILE
+ A Profile that can be used with either an Edge-tier or Mid-tier :term:`cache server` (but not both, in general). This is the only Profile type that will ultimately pass its Parameters_ on to :term:`ORT` in the form of generated configuration files. For this reason, it can make use of the :ref:`ort-special-strings` in the values of some of its Parameters_.
+
+ .. 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!
+
+DS_PROFILE
+ A Profile that, rather than applying to a server, is instead :ref:`used by a Delivery Service <ds-profile>`.
+
+ES_PROFILE
+ A Profile for `ElasticSearch <https://www.elastic.co/products/elasticsearch>`_ servers. This has no known special meaning to any component of Traffic Control, but if ElasticSearch is in use the use of this Profile Type is suggested regardless.
+
+ .. 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!
+
+GROVE_PROFILE
+ A Profile for use with the experimental Grove HTTP caching proxy.
+
+INFLUXDB_PROFILE
+ A Profile used with `InfluxDB <https://www.influxdata.com/>`_, which is used by Traffic Stats.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``INFLUXDB``. 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!
+
+KAFKA_PROFILE
+ A Profile for `Kafka <https://kafka.apache.org/>`_ servers. This has no known special meaning to any component of Traffic Control, but if Kafka is in use the use of this Profile Type is suggested regardless.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``KAFKA``. 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!
+
+LOGSTASH_PROFILE
+ A Profile for `Logstash <https://www.elastic.co/products/logstash>`_ servers. This has no known special meaning to any component of Traffic Control, but if Logstash is in use the use of this Profile Type is suggested regardless.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``LOGSTASH_``. 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!
+
+ORG_PROFILE
+ A Profile that may be used by either :term:`origin servers` or :term:`origins` (no, they aren't the same thing).
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``MSO``, or contain either ``ORG`` or ``ORIGIN`` anywhere in the name. 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!
+
+RIAK_PROFILE
+ A Profile used for each `Riak <http://basho.com/products/riak-kv/>`_ server in a Traffic Stats cluster.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``RIAK``. 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!
+
+SPLUNK_PROFILE
+ A Profile meant to be used with `Splunk <https://www.splunk.com/>`_ servers. This has no known special meaning to any component of Traffic Control, but if Splunk is in use the use of this Profile Type is suggested regardless.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``SPLUNK``. 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!
+
+TM_PROFILE
+ A Traffic Monitor Profile.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``RASCAL_`` or ``TM_``. 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!
+
+TP_PROFILE
+ A Traffic Portal Profile. This has no known special meaning to any Traffic Control component(s) (not even Traffic Portal itself), but its use is suggested for the profiles used by any and all Traffic Portal servers anyway.
+
+TR_PROFILE
+ A Traffic Router Profile.
+
+ .. warning:: For legacy reasons, the names of Profiles of this type *must* begin with ``CCR_`` or ``TR_``. 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!
+
+ .. seealso:: :ref:`tr-profile`
+
+TS_PROFILE
+ A Traffic Stats Profile.
+
+ .. caution:: For legacy reasons, the names of Profiles of this type *must* be ``TRAFFIC_STATS``. 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! Furthermore, because Profile names must be unique, this means that only one TS_PROFILE-Type Profile can exist at a time.
+
+UNK_PROFILE
+ A catch-all type that can be assigned to anything without imbuing it with any special meaning or behavior.
+
+.. tip:: A Profile of the wrong type assigned to a Traffic Control component *will* (in general) cause it to function incorrectly, regardless of the Parameters_ assigned to it.
+
+.. _default-profiles:
+
+Default Profiles
+----------------
+Traffic Control comes with some pre-installed Profiles for its basic components, but users are free to define their own as needed. Additionally, these default Profiles can be modified or even removed completely. One of these Profiles is `The GLOBAL Profile`_, which has a dedicated section.
+
+INFLUXDB
+ A Profile used by InfluxDB servers that store Traffic Stats information. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+RIAK_ALL
+ This Profile is used by Traffic Vault, which is, generally speaking, the only instance in Traffic Control as it can store keys for an arbitrary number of CDNs. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+TRAFFIC_ANALYTICS
+ A default Profile that was intended for use with the now-unplanned "Traffic Analytics" :abbr:`ATC (Apache Traffic Control)` component. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+TRAFFIC_OPS
+ A Profile used by the Traffic Ops server itself. It's suggested that any and all "mirrors" of Traffic Ops for a given Traffic Control instance be recorded separately and all assigned to this Profile for record-keeping purposes. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+TRAFFIC_OPS_DB
+ A Profile used by the PostgreSQL database server that stores all of the data needed by Traffic Ops. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+TRAFFIC_PORTAL
+ A Profile used by Traffic Portal servers. This profile name has no known special meaning to any Traffic Control components (not even Traffic Portal itself), but its use is suggested for Traffic Portal servers anyway. It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+TRAFFIC_STATS
+ This is the **only** Profile used by Traffic Stats (though InfluxDB servers have their own Profile(s)). It has a Type_ of UNK_PROFILE and is assigned to the special "ALL" CDN_.
+
+In addition to these Profiles, each release of Apache Traffic Control is accompanied by a set of suggested Profiles suitable for import in the :ref:`tp-configure-profiles` view of Traffic Portal. They may be found on `the Profiles Downloads Index page <http://trafficcontrol.apache.org/downloads/profiles/>`_. These Profiles are typically built from production Profiles by a company using Traffic Control, and as such are typically highly specific to the hardware and network infrastructure a [...]
+
+Administrators may alternatively wish to consult the Profiles and Parameters_ available in the :ref:`ciab` environment, as they might be more familiar with them. Furthermore, those Profiles are built with a minimum running Traffic Control system in mind, and thus may be easier to look through. The Profiles and their associated Parameters_ may be found within the :atc-file:`infrastructure/cdn-in-a-box/traffic_ops_data/profiles/` directory.
+
+.. _the-global-profile:
+
+The GLOBAL Profile
+------------------
+There is a special Profile of Type_ UNK_PROFILE that holds global configuration information - its :ref:`profile-name` is "GLOBAL", its Type_ is UNK_PROFILE and it is assigned to the special "ALL" CDN_. The Parameters_ that may be configured on this Profile are laid out in the :ref:`global-profile-parameters` Table.
+
+.. _global-profile-parameters:
+.. table:: Global Profile Parameters
+
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | :ref:`parameter-name` | `Config File`_ | Value_ |
+ +==========================+=========================+=======================================================================================================================================+
+ | tm.url | global | The URL at which this Traffic Ops instance services requests. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.rev_proxy.url | global | Not required. The URL where a caching proxy for configuration files generated by Traffic Ops may be found. Requires a minimum |
+ | | | :term:`ORT` version of 2.1. When configured, :term:`ORT` will request configuration files via this |
+ | | | :abbr:`FQDN (Fully Qualified Domain Name)`, which should be set up as a reverse proxy to the Traffic Ops server(s). The suggested |
+ | | | cache lifetime for these files is 3 minutes or less. This setting allows for greater scalability of a CDN maintained by Traffic Ops |
+ | | | by caching configuration files of profile and CDN scope, as generating these is a very computationally expensive process. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops" - this will appear in the comment headers of generated configuration files. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.infourl | global | This is the "for more information go here" URL, which used to be visible in the "About" page of the now-deprecated Traffic Ops UI. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.logourl | global | This is the URL of the logo for Traffic Ops and can be relative if the logo is under :file:`traffic_ops/app/public`. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.instance_name | global | The name of the Traffic Ops instance - typically to distinguish instances when multiple are active. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | tm.traffic_mon_fwd_proxy | global | When collecting stats from Traffic Monitor, Traffic Ops will use this forward proxy instead of the actual Traffic Monitor host. |
+ | | | Setting this :ref:`Parameter <parameters>` can significantly lighten the load on the Traffic Monitor system and it is therefore |
+ | | | recommended that this be set on a production system. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | use_reval_pending | global | When this Parameter is present and its Value_ is exactly "1", Traffic Ops will separately keep track of :term:`cache servers`' |
+ | | | updates and pending content invalidation jobs. This behavior should be enabled by default, and disabling it, while still possible, is |
+ | | | **EXTREMELY DISCOURAGED**. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | use_tenancy | global | This :ref:`Parameter <parameters>`, when it exists and has a Value_ of exactly "1" enables the use :term:`Tenants` in Traffic |
+ | | | Control. This should be enabled by default, and while disabling this is still possible, it is **EXTREMELY DISCOURAGED**. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | geolocation.polling.url | CRConfig.json | The location of a geographic IP mapping database for Traffic Router instances to use. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | geolocation6.polling.url | CRConfig.json | The location of a geographic IPv6 mapping database for Traffic Router instances to use. |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | maxmind.default.override | CRConfig.json | The destination geographic coordinates to use for client location when the geographic IP mapping database returns a default location |
+ | | | that matches the country code. This parameter can be specified multiple times with different values to support default overrides for |
+ | | | multiple countries. The reason for the name "maxmind" is because the default geographic IP mapping database used by Traffic Control |
+ | | | is MaxMind's GeoIP2 database. The format of this :ref:`Parameter <parameters>`'s Value_ is: |
+ | | | :file:`{Country Code};{Latitude},{Longitude}`, e.g. ``US;37.751,-97.822`` |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+ | maxRevalDurationDays | regex_revalidate.config | This :ref:`Parameter <parameters>` sets the maximum duration, in days, for which a content invalidation job may run. This is |
+ | | | **extremely** important, as there is currently no way to delete a content invalidation job once it has been created. Furthermore, |
+ | | | while there is no restriction placed on creating multiple Parameters_ with this :ref:`parameter-name` and `Config File`_ - |
+ | | | potentially with differing :ref:`Values <parameter-value>` - this is **EXTREMELY DISCOURAGED as any** :ref:`Parameter <parameters>` |
+ | | | **that has both that** :ref:`parameter-name` **and** `Config File`_ **might be used when generating any given** |
+ | | | `regex_revalidate.config`_ **file for any given** :term:`cache server` **and whenever such** Parameters_ **exist, the actual maximum |
+ | | | duration for content invalidation jobs is undefined, and CAN and WILL differ from server to server, and configuration file to |
+ | | | configuration file.** |
+ +--------------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+
+.. note:: Since the Traffic Ops UI has been removed, the tm.logourl has no real meaning, and in fact most Traffic Ops distributions neither set this :ref:`Parameter <parameters>`, nor provide a logo.
+
+Some of these Parameters_ have the `Config File`_ value global_, while others have `CRConfig.json`_. This is not a typo, and the distinction is that those that use global_ are typically configuration options relating to Traffic Control as a whole or to Traffic Ops itself, whereas `CRConfig.json`_ is used by configuration options that are set globally, but pertain mainly to routing and are thus communicated to Traffic Routers through :term:`CDN Snapshots` (which historically were called " [...]
+When a :ref:`Parameter <parameters>` has a `Config File`_ value that *isn't* one of global_ or `CRConfig.json`_, it refers to the global configuration of said `Config File`_ across all servers that use it across all CDNs configured in Traffic Control. This can be used to easily apply extremely common configuration to a great many servers in one place.
+
+.. _parameters:
+
+Parameters
+==========
+A :dfn:`Parameter` is usually a way to set a line in a configuration file that will appear on the servers using Profiles_ that have said Parameter. More generally, though, a Parameter merely describes some kind of configuration for some aspect of some thing. There are many Parameters that *must* exist for Traffic Control to work properly, such as those on `The GLOBAL Profile`_ or the `Default Profiles`_. Some Traffic Control components can be associated with Profiles_ that only have a fe [...]
+
+Properties
+----------
+When represented in Traffic Portal (in the :ref:`tp-configure-parameters` view) or in :ref:`to-api` request and/or response payloads, a Parameter has several properties that define it. In some of these contexts, the Profiles_ to which a Parameter is assigned (and/or the integral, unique identifiers thereof) are represented as a property of the Parameter. However, an explanation of this "property" is not provided here, as the Profiles_ section exists for the purpose of explaining those.
+
+.. _parameter-config-file:
+
+Config File
+"""""""""""
+This (usually) names the configuration file to which the Parameter belongs. Note that it is only the *name of* the file and **not** the *full path to* the file - e.g. ``remap.config`` not ``/opt/trafficserver/etc/trafficserver/remap.config``. To define the full path to any given configuration file, Traffic Ops relies on a reserved :ref:`parameter-name` value: :ref:`"location" <parameter-name-location>`.
+
+.. seealso:: This section is only meant to cover the special handling of Parameters assigned to specific Config File values. It is **not** meant to be a primer on Apache Traffic Server configuration files, nor is it intended to be exhaustive of the manners in which said files may be manipulated by Traffic Control. For more information, consult the documentation for `Apache Traffic Server configuration files`_.
+
+Certain Config Files are handled specially by Traffic Ops's configuration file generation. Specifically, the format of the configuration is tailored to be correct when the syntax of a configuration file is known. However, these configuration files **must** have :ref:`"location" <parameter-name-location>` Parameters on the :ref:`Profile <profiles>` of servers, or they will not be generated. The Config File values that are special in this way are detailed within this section. When a `Confi [...]
+
+12M_facts
+'''''''''
+This legacy file is generated entirely from a :ref:`Profile <profiles>`'s metadata, and cannot be affected by Parameters.
+
+.. tip:: This Config File serves an unknown and likely historical purpose, so most users/administrators/developers don't need to worry about it.
+
+50-ats.rules
+''''''''''''
+Parameters have no meaning when assigned to this Config File (except :ref:`"location" <parameter-name-location>`), but it *is* affected by Parameters that are on the same :ref:`Profile <profiles>` with the Config File ``storage.config`` - **NOT this Config File**. For each letter in the special "Drive Letters" Parameter, a line will be added of the form :file:`KERNEL=="{Prefix}{Letter}", OWNER="ats"` where ``Prefix`` is the Value_ of the Parameter with the :ref:`parameter-name` "Drive Pr [...]
+
+.. tip:: This Config File serves an unknown and likely historical purpose, so most users/administrators/developers don't need to worry about it.
+
+astats.config
+'''''''''''''
+This configuration file will be generated with a line for each Parameter with this Config File value on the :term:`cache server`'s :ref:`Profile <profiles>` in the form :file:`{Name}={Value}` where ``Name`` is the Parameter's :ref:`parameter-name` with trailing characters that match :regexp:`__\\d+$` stripped, and ``Value`` is its Value_.
+
+bg_fetch.config
+'''''''''''''''
+This configuration file always generates static contents besides the header, and cannot be affected by any Parameters (besides its :ref:`"location" <parameter-name-location>` Parameter).
+
+.. seealso:: For an explanation of the contents of this file, consult `the Background Fetch Apache Traffic Server plugin's official documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/plugins/background_fetch.en.html>`_.
+
+cache.config
+''''''''''''
+This configuration is built entirely from :term:`Delivery Service` configuration, and cannot be affected by Parameters.
+
+.. seealso:: `The Apache Traffic Server cache.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/cache.config.en.html>`_
+
+:file:`cacheurl{anything}.config`
+'''''''''''''''''''''''''''''''''
+Config Files that match this pattern - where ``anything`` is a string of zero or more characters - can only be generated by providing a :ref:`location <parameter-name-location>` and their contents will be fully determined by properties of :term:`Delivery Services`.
+
+.. seealso:: `The official documentation for the Cache URL Apache Traffic Server plugin <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/plugins/cacheurl.en.html>`_.
+
+.. deprecated:: ATCv3.0
+ This configuration file is only used by Apache Traffic Server version 6.x, whose use is deprecated both by that project and Traffic Control. These Config Files will have no special meaning at some point in the future.
+
+chkconfig
+'''''''''
+This actually isn't a configuration file at all, kind of. Specifically, it is a valid configuration file for the legacy `chkconfig utility <https://linux.die.net/man/8/chkconfig>`_ - but it is never written to disk on any :term:`cache server`. Though all Traffic Control-supported systems are now using :manpage:`systemd(8)`, :term:`ORT` still uses ``chkconfig``-style configuration to set the status of services on its host system(s). This means that any Parameter with this Config File valu [...]
+
+CRConfig.json
+'''''''''''''
+In general, the term "CRConfig" refers to :term:`CDN Snapshots`, which historically were called "CRConfig Snapshots" or simply "the CRConfig". Parameters with this Config File should be only be on either `The GLOBAL Profile`_ where they will affect global routing configuration, or on a Traffic Router's :ref:`Profile <profiles>` where they will affect routing configuration for that Traffic Router only.
+
+.. seealso:: For the available configuration Parameters for a Traffic Router Profile, see :ref:`tr-profile`.
+
+drop_qstring.config
+'''''''''''''''''''
+This configuration file will be generated with a single line that is exactly: :regexp:`/([^?]+) \$s://\$t/\$1\n` **unless** a Parameter exists on the :ref:`Profile <profiles>` with this Config File value, and the :ref:`parameter-name` "content". In the latter case, the contents of the file will be exactly the Parameter's Value_ (with terminating newline appended).
+
+global
+''''''
+In general, this Config File isn't actually handled specially by Traffic Ops when generating server configuration files. However, this is the Config File value typically used for Parameters assigned to `The GLOBAL Profile`_ for truly "global" configuration options, and it is suggested that this precedent be maintained - i.e. don't create Parameters with this Config File.
+
+:file:`hdr_rw_{anything}.config`
+''''''''''''''''''''''''''''''''
+Config Files that match this pattern - where ``anything`` is zero or more characters - are written specially by Traffic Ops to accommodate the :ref:`ds-dscp` setting of :term:`Delivery Services`.
+
+.. tip:: The ``anything`` in those file names is typically a :term:`Delivery Service`'s :ref:`ds-xmlid` - though the inability to affect the file's contents is utterly independent of whether or not a :term:`Delivery Service` with that :ref:`ds-xmlid` actually exists.
+
+.. seealso:: For information on the contents of files like this, consult `the Header Rewrite Apache Traffic Server plugin's documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/plugins/header_rewrite.en.html#rewriting-rules>`_
+
+hosting.config
+''''''''''''''
+This configuration file is mainly generated based on the assignments of :term:`cache servers` to :term:`Delivery Services` and the :term:`Cache Group` hierarchy, but there are a couple of Parameter :ref:`Names <parameter-name>` that can affect it when assigned to this Config File. When a Parameter assigned to the ``storage.config`` Config File - **NOT this Config File** - with the :ref:`parameter-name` "RAM_Drive_Prefix" *exists*, it will cause lines to be generated in this configuration [...]
+
+.. caution:: If a Parameter with Config File ``storage.config`` and :ref:`parameter-name` "RAM_Drive_Prefix" does *not* exist on a :ref:`Profile <profiles>`, then the :term:`cache servers` using that :ref:`Profile <profiles>` will **be incapable of serving traffic for** :term:`Delivery Services` **of the aforementioned** :ref:`Types <ds-types>`, **even when a** :ref:`"location" <parameter-name-location>` **Parameter exists**.
+
+.. seealso:: For an explanation of the syntax of this configuration file, refer to `the Apache Traffic Server hosting.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/hosting.config.en.html>`_.
+
+ip_allow.config
+'''''''''''''''
+This configuration file is mostly generated from various server data, but can be affected by a Parameter that has a :ref:`parameter-name` of "purge_allow_ip", which will cause the insertion of a line with :file:`src_ip={VALUE} action=ip_allow method=ALL` where ``VALUE`` is the Parameter's Value_. Additionally, Parameters with :ref:`Names <parameter-name>` like :file:`coalesce_{masklen|number}_v{4|6}` cause Traffic Ops to generate coalesced IP ranges in different ways. In the case that `` [...]
+
+.. impl-detail:: At the time of this writing, coalescence is implemented through the `the NetAddr\:\:IP Perl library <http://search.cpan.org/~miker/NetAddr-IP-4.078/IP.pm>`_.
+
+.. seealso:: `The Apache Traffic Server ip_allow.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/ip_allow.config.en.html>`_ explains the syntax and meaning of lines in that file.
+
+logging.config
+''''''''''''''
+This configuration file can only be affect by Parameters with specific :ref:`Names <parameter-name>`. Specifically, for each Parameter assigned to this Config File on the :ref:`Profile <profiles>` used by the :term:`cache server` with the name :file:`LogFormat{N}.Name` where ``N`` is either the empty string or a natural number on the interval [1,9] the text in :ref:`logging.config-format-snippet` will be inserted. In that snippet, ``NAME`` is the Value_ of the Parameter with the :ref:`pa [...]
+
+.. _logging.config-format-snippet:
+
+.. code-block:: text
+ :caption: Log Format Snippet
+
+ NAME = format {
+ Format = 'FORMAT '
+ }
+
+.. tip:: The order in which these Parameters are considered is exactly the numerical ordering implied by ``N`` (starting with it being empty). However, each section is generated for all values of ``N`` before moving on to the next.
+
+Furthermore, for a given value of ``N`` - as before restricted to either the empty string or a natural number on the interval [1,9] -, if a Parameter exists on the :term:`cache server`'s :ref:`Profile <profiles>` having this Config File value with the :ref:`parameter-name` :file:`LogFilter{N}.Name`, a line of the format :file:`{NAME} = filter.{TYPE}.('{FILTER}')` will be inserted, where ``NAME`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Name`, ``TY [...]
+
+.. note:: When, for a given value of ``N``, a Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Name` exists, but a Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Type` does *not* exist, the value of ``TYPE`` will be ``accept``.
+
+Finally, for a given value of ``N``, if a Parameter exists on the :term:`cache server`'s :ref:`Profile <profiles>` having this Config File value with the :ref:`parameter-name` :file:`LogObject{N}.Filename`, the text in :ref:`logging.config-object-snippet` will be inserted. In that snippet, ``TYPE`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Type`
+
+.. _logging.config-object-snippet:
+
+.. code-block:: text
+ :caption: Log Object Snippet
+
+ log.TYPE {
+ Format = FORMAT,
+ Filename = 'FILENAME',
+
+.. note:: When, for a given value of ``N`` a Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Filename` exists, but a Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Type` does *not* exist, the value of ``TYPE`` in :ref:`logging.config-object-snippet` will be ``ascii``.
+
+At this point, if the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Type` is **exactly** ``pipe``, a line of the format :file:`\ \ Filters = { FILTERS }` will be inserted where ``FILTERS`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Filters`, followed by a line containing only a closing "curly brace" (:kbd:`}`) - *if and* **only** *if said Parameter is* **not** *empty*. If, however, the Value_ of the Parameter with the :r [...]
+
+.. _logging.config-object-not-pipe-snippet:
+
+.. code-block:: text
+ :caption: Log Object (not a "pipe") Snippet
+
+ RollingEnabled = ROLLING,
+ RollingIntervalSec = INTERVAL,
+ RollingOffsetHr = OFFSET,
+ RollingSizeMb = SIZE
+ }
+
+In this snippet, ``ROLLING`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.RollingEnabled`, ``INTERVAL`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.RollingIntervalSec`, ``OFFSET`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.RollingOffsetHr`, and ``SIZE`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.SizeMb` - all still having the same value [...]
+
+.. warning:: The contents of these fields are not validated by Traffic Control - handle with care!
+
+.. seealso:: `The Apache Traffic Server documentation for the logging.config configuration file <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/logging.config.en.html>`_
+
+logging.yaml
+''''''''''''
+This is a YAML-format configuration file used by :term:`cache servers` that use Apache Traffic Server version 8 or higher - for lower versions, users/administrators/developers should instead be configuring ``logging.config``. This configuration always starts with (after the header) the single line: :literal:`format:\ `. Afterward, for every Parameter assigned to this Config File with a :ref:`parameter-name` like :file:`LogFormat{N}.Name` where ``N`` is either the empty string or a natura [...]
+
+.. _logging.yaml-format-snippet:
+
+.. code-block:: yaml
+ :caption: Log Format Snippet
+
+ - name: NAME
+ format: 'FORMAT'
+
+.. tip:: The order in which these Parameters are considered is exactly the numerical ordering implied by ``N`` (starting with it being empty). However, each section is generated for all values of ``N`` before moving on to the next.
+
+After this, a single line containing only ``filters:`` is inserted. Then, for each Parameter on the :term:`cache server`'s :ref:`Profile <profiles>` with a :ref:`parameter-name` like :file:`LogFilter{N}.Name` where ``N`` is either the empty string or a natural number on the interval [1,9], the YAML fragment in :ref:`logging.yaml-filter-snippet` will be inserted. In that snippet, ``NAME`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Name`, ``TYPE`` is [...]
+
+.. _logging.yaml-filter-snippet:
+
+.. code-block:: yaml
+ :caption: Log Filter Snippet
+
+ - name: NAME
+ action: TYPE
+ condition: FILTER
+
+.. note:: When, for a given value of ``N``, a Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Name` exists, but a Parameter with the :ref:`parameter-name` :file:`LogFilter{N}.Type` does *not* exist, the value of ``TYPE`` in :ref:`logging.yaml-filter-snippet` will be ``accept``.
+
+At this point, a single line containing only ``logs:`` is inserted. Finally, for each Parameter on the :term:`cache server`'s :ref:`Profile <profiles>` assigned to this Config File with a :ref:`parameter-name` like :file:`LogObject{N}.Filename` where ``N`` is once again either an empty string or a natural number on the interval [1,9] the YAML fragment in :ref:`logging.yaml-object-snippet` will be inserted. In this snippet, for a given value of ``N`` ``TYPE`` is the Value_ of the Paramete [...]
+
+.. _logging.yaml-object-snippet:
+
+.. code-block:: yaml
+ :caption: Log Object Snippet
+
+ - mode: TYPE
+ filename: FILENAME
+ format: FORMAT
+ ROLLING_OR_FILTERS
+
+.. note:: When, for a given value of ``N`` a Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Filename` exists, but a Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Type` does *not* exist, the value of ``TYPE`` in :ref:`logging.yaml-object-snippet` will be ``ascii``.
+
+``ROLLING_OR_FILTERS`` will be one of two YAML fragments based on the Value_ of the Parameter with the name :file:`LogObject{N}.Type`. In particular, if it is exactly ``pipe``, then ``ROLLING_OR_FILTERS`` will be :file:`filters: [{FILTERS}]` where ``FILTERS`` is the Value_ of the Parameter assigned to this Config File with the :ref:`parameter-name` :file:`LogObject{N}.Filters` for the same value of ``N``. If, however, the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogO [...]
+
+.. _logging.yaml-object-not-pipe-snippet:
+
+.. code-block:: yaml
+ :caption: Log Object (not a "pipe") Snippet
+
+ rolling_enabled: ROLLING
+ rolling_interval_sec: INTERVAL
+ rolling_offset_hr: OFFSET
+ rolling_size_mb: SIZE
+
+
+.. seealso:: For an explanation of YAML syntax, refer to the `official specification thereof <https://yaml.org/>`_. For an explanation of the syntax of a valid Apache Traffic Server ``logging.yaml`` configuration file, refer to `that project's dedicated documentation <https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/files/logging.yaml.en.html>`_.
+
+logs_xml.config
+'''''''''''''''
+This configuration file is somewhat more complex than most Config Files, in that it generates XML document tree segments\ [#xml-caveat]_ for each Parameter on the :term:`cache server`'s :ref:`Profile <profiles>` rather than simply a plain-text line. Specifically, up to ten of the document fragment shown in :ref:`logs_xml-format-snippet` will be inserted, one for each Parameter with this Config File value on the :term:`cache server`'s :ref:`Profile <profiles>` that has a :ref:`parameter-n [...]
+
+.. _logs_xml-format-snippet:
+
+.. code-block:: text
+ :caption: LogFormat Snippet
+
+ <LogFormat>
+ <Name = "NAME"/>
+ <Format = "FORMAT"/>
+ </LogFormat>
+
+.. tip:: The order in which these Parameters are considered is exactly the numerical ordering implied by ``N`` (starting with it being empty).
+
+Furthermore, for a given value of ``N``, if a Parameter exists on the :term:`cache server`'s :ref:`Profile <profiles>` having this Config File value with the :ref:`parameter-name` :file:`LogObject{N}.Filename`, the document fragment shown in :ref:`logs_xml-object-snippet` will be inserted. In that snippet, ``OBJ_FORMAT`` is the Value_ of the Parameter with the :ref:`parameter-name` :file:`LogObject{N}.Format`, ``FILENAME`` is the Value_ of the Parameter with the :ref:`parameter-name` :fi [...]
+
+.. _logs_xml-object-snippet:
+
+.. code-block:: text
+ :caption: LogObject Snippet
+
+ <LogObject>
+ <Format = "OBJ_FORMAT"/>
+ <Filename = "FILENAME"/>
+ <RollingEnabled = ROLLING/>
+ <RollingInterval = INTERVAL/>
+ <RollingOffsetHr = OFFSET/>
+ <RollingSizeMb = SIZE/>
+ <Header = "HEADER"/>
+ </LogObject>
+
+.. warning:: The contents of these fields are not validated by Traffic Control - handle with care!
+
+.. seealso:: The `Apache Traffic Control documentation on the logs_xml.config configuration file <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/logs_xml.config.en.html>`_
+
+.. deprecated:: ATCv3.0
+
+ This file is only used by Apache Traffic Server version 6.x. The use of Apache Traffic Server version < 7.1 has been deprecated, and will not be supported in the future. Developers are encouraged to instead configure the `logging.config`_ configuration file.
+
+package
+'''''''
+This is a special, reserved Config File that isn't a file at all. When a Parameter's Config File is ``package``, then its name is interpreted as the name of a package. :term:`ORT` on the server using the :ref:`Profile <profiles>` that has this Parameter will attempt to install a package by that name, interpreting the Parameter's Value_ as a version string if it is not empty. The package manager used will be :manpage:`yum(8)`, regardless of system (though the Python version of :term:`ORT` [...]
+
+The current implementation of :term:`ORT` will expect Parameters to exist on a :term:`cache server`'s :ref:`Profile <profiles>` with the :ref:`Names <parameter-name>` ``astats_over_http`` and ``trafficserver`` before being run the first time, as both of these are required for a :term:`cache server` to operate within a Traffic Control CDN. It is possible to install these outside of :term:`ORT` - and indeed even outside of :manpage:`yum(8)` - but such configuration is not officially supported.
+
+packages
+''''''''
+This Config File is reserved, and is used by :term:`ORT` to pull bulk information about all of the Parameters with Config File values of package_. It doesn't actually correspond to any configuration file.
+
+parent.config
+'''''''''''''
+This configuration file is generated entirely from :term:`Cache Group` relationships, as well as :term:`Delivery Service` configuration. This file *can* be affected by Parameters on the server's :ref:`Profile <Profiles>` if and only if its :ref:`parameter-name` is one of the following:
+
+- ``algorithm``
+- ``qstring``
+- ``psel.qstring_handling``
+- ``not_a_parent`` - unlike the other Parameters listed (which have a 1:1 correspondence with Apache Traffic Server configuration options), this Parameter affects the generation of :term:`parent` relationships between :term:`cache servers`. When a Parameter with this :ref:`parameter-name` and Config File exists on a :ref:`Profile <profiles>` used by a :term:`cache server`, it will not be added as a :term:`parent` of any other :term:`cache server`, regardless of :term:`Cache Group` hierar [...]
+
+Additionally, :term:`Delivery Service` :ref:`Profiles <ds-profile>` can have special Parameters with the :ref:`parameter-name` "mso.parent_retry" to :ref:`multi-site-origin-qht`.
+
+.. seealso:: To see how the :ref:`Values <parameter-value>` of these Parameters are interpreted, refer to the `Apache Traffic Server documentation on the parent.config configuration file <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/parent.config.en.html>`_
+
+plugin.config
+'''''''''''''
+For each Parameter with this Config File value on the same :ref:`Profile <profiles>`, a line in the resulting configuration file is produced in the format :file:`{NAME} {VALUE}` where ``NAME`` is the Parameter's :ref:`parameter-name` with trailing characters matching the regular expression :regexp:`__\\d+$` stripped out and ``VALUE`` is the Parameter's Value_.
+
+.. caution:: In order for Parameters for Config Files relating to Apache Traffic Server plugins - e.g. `regex_revalidate.config`_ - to have any effect, a Parameter must exist with this Config File value to instruct Apache Traffic Server to load the plugin. Typically, this is more easily achieved by assigning these Parameters to `The GLOBAL Profile`_ than on a server-by-server basis.
+
+.. seealso:: `The Apache Traffic server documentation on the plugin.config configuration file <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/plugin.config.en.html>`_ explains what Value_ and :ref:`parameter-name` a Parameter should have to be valid.
+
+rascal.properties
+'''''''''''''''''
+This Config File is meant to be on Parameters assigned to either Traffic Monitor Profiles_ or :term:`cache server` Profiles_. Its allowed :ref:`Parameter Names <parameter-name>` are all configuration options for Traffic Monitor. The :ref:`Names <parameter-name>` with meaning are as follows.
+
+health.threshold.loadavg
+ The Value_ of this Parameter sets the "load average" above which the associated :ref:`Profile <profiles>`'s :term:`cache server` will be considered "unhealthy".
+
+ .. seealso:: :ref:`health-proto`
+
+ .. seealso:: The definition of a "load average" can be found in the documentation for the Linux/Unix command :manpage:`uptime(1)`.
+
+ .. caution:: If more than one Parameter with this :ref:`parameter-name` and Config File exist on the same :ref:`Profile <profiles>` with different :ref:`Values <parameter-value>`, the actual Value_ used by any given Traffic Monitor instance is undefined (though it will be the Value_ of one of those Parameters).
+
+health.threshold.availableBandwidthInKbps
+ The Value_ of this Parameter sets the amount of bandwidth (in kilobits per second) that Traffic Control will try to keep available on the :term:`cache server`. For example a Value_ of ">1500000" indicates that the :term:`cache server` will be marked "unhealthy" if its available remaining bandwidth on the network interface used by the caching proxy falls below 1.5Gbps.
+
+ .. seealso:: :ref:`health-proto`
+
+ .. caution:: If more than one Parameter with this :ref:`parameter-name` and Config File exist on the same :ref:`Profile <profiles>` with different :ref:`Values <parameter-value>`, the actual Value_ used by any given Traffic Monitor instance is undefined (though it will be the Value_ of one of those Parameters).
+
+records.config
+''''''''''''''
+For each Parameter with this Config File value on the same :ref:`Profile <profiles>`, a line in the resulting configuration file is produced in the format :file:`{NAME} {VALUE}` where ``NAME`` is the Parameter's :ref:`parameter-name` with trailing characters matching the regular expression :regexp:`__\\d+$` stripped out and ``VALUE`` is the Parameter's Value_.
+
+.. seealso:: `The Apache Traffic Server records.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/records.config.en.html>`_
+
+:file:`regex_remap_{anything}.config`
+''''''''''''''''''''''''''''''''''''''''''''
+Config Files matching this pattern - where ``anything`` is zero or more characters - are generated entirely from :term:`Delivery Service` configuration, which cannot be affected by any Parameters (except :ref:`"location" <parameter-name-location>`).
+
+.. seealso:: For the syntax of configuration files for the "Regex Remap" plugin, see `the Regex Remap plugin's official documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/plugins/regex_remap.en.html>`_. For instructions on how to enable a plugin, consult, the `plugin.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/plugin.config.en.html>`_.
+
+regex_revalidate.config
+'''''''''''''''''''''''
+This configuration file can only be affected by the special ``maxRevalDurationDays``, which is discussed in the `The GLOBAL Profile`_ section.
+
+.. seealso:: For the syntax of configuration files for the "Regex Revalidate" plugin, see `the Regex Revalidate plugin's official documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/plugins/regex_revalidate.en.html#revalidation-rules>`_. For instructions on how to enable a plugin, consult, the `plugin.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/plugin.config.en.html>`_.
+
+remap.config
+''''''''''''
+This configuration file can only be affected by one Parameter on a :ref:`Profile <profiles>` assigned to a :term:`Delivery Service`. Then, for every Parameter assigned to that :ref:`Profile <profiles>` that has the Config File value "cachekey.config" - **NOT this Config File** -, a parameter will be added to the line for that :term:`Delivery Service` like so: :file:`pparam=--{Name}={Value}` where ``Name`` is the Parameter's :ref:`parameter-name`, and ``Value`` is its Value_.
+
+.. seealso:: For an explanation of the syntax of this configuration file, refer to `the Apache Traffic Server remap.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/remap.config.en.html>`_.
+
+:file:`set_dscp_{anything}.config`
+''''''''''''''''''''''''''''''''''
+Configuration files matching this pattern - where ``anything`` is a string of zero or more characters is generated entirely from a :ref:`"location" <parameter-name-location>` Parameter.
+
+.. tip:: ``anything`` in that Config File name only has meaning if it is a natural number - specifically, one of each value of :ref:`ds-dscp` on every :term:`Delivery Service` to which the :term:`cache server` using the :ref:`Profile <profiles>` on which the Parameter(s) exist(s).
+
+ssl_multicert.config
+''''''''''''''''''''
+This configuration file is generated from the SSL keys of :term:`Delivery Services`, and is unaffected by any Parameters (except :ref:`"location" <parameter-name-location>`)
+
+.. seealso:: `The official ssl_multicert.config documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/ssl_multicert.config.en.html>`_
+
+storage.config
+''''''''''''''
+This configuration file can only be affected by a handful of Parameters. If a Parameter with the :ref:`parameter-name` "Drive Prefix" exists the generated configuration file will have a line inserted in the format :file:`{PREFIX}{LETTER} volume=1` for each letter in the comma-delimited list that is the Value_ of the Parameter on the same :ref:`Profile <profiles>` with the :ref:`parameter-name` "Drive Letters", where ``PREFIX`` is the Value_ of the Parameter with the :ref:`parameter-name` [...]
+
+.. seealso:: `The Apache Traffic Server storage.config file documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/storage.config.en.html>`_.
+
+traffic_stats.config
+''''''''''''''''''''
+This Config File value is only handled specially when the :ref:`Profile <profiles>` to which it is assigned is of the special TRAFFIC_STATS Type_. In that case, the :ref:`parameter-name` of any Parameters with this Config File is restrained to one of "CacheStats" or "DsStats". When it is "Cache Stats", the Value_ is interpreted specially based on whether or not it starts with "ats.". If it does, then what follows must be the name of one of `the core Apache Traffic Server statistics <http [...]
+
+When the Parameter :ref:`parameter-name` is "DSStats", the allowed :ref:`Values <parameter-value>` are:
+
+- kbps
+- status_4xx
+- status_5xx
+- tps_2xx
+- tps_3xx
+- tps_4xx
+- tps_5xx
+- tps_total
+
+.. seealso:: For more information on the statistics gathered by Traffic Stats, see :ref:`ts-admin`. For information about how these statics are gathered, consult the only known documentation of the "astats_over_http" Apache Traffic Server plugin: :atc-file:`traffic_server/plugins/astats_over_http/README.md`.
+
+sysctl.config
+'''''''''''''
+For each Parameter with this Config File value on the same :ref:`Profile <profiles>`, a line in the resulting configuration file is produced in the format :file:`{NAME} = {VALUE}` where ``NAME`` is the Parameter's :ref:`parameter-name` with trailing characters matching the regular expression :regexp:`__\\d+$` stripped out and ``VALUE`` is the Parameter's Value_.
+
+:file:`uri_signing_{anything}.config`
+'''''''''''''''''''''''''''''''''''''
+Config Files matching this pattern - where ``anything`` is zero or more characters - are generated entirely from the URI Signing Keys configured on a :term:`Delivery Service` through either the :ref:`to-api` or the :ref:`tp-services-delivery-service` view in Traffic Portal.
+
+.. seealso:: `The draft RFC for uri_signing <https://tools.ietf.org/html/draft-ietf-cdni-uri-signing-16>`_ - note, however that the current implementation of uri_signing uses Draft 12 of that RFC document, **NOT** the latest.
+
+:file:`url_sig_{anything}.config`
+'''''''''''''''''''''''''''''''''
+Config Files that match this pattern - where ``anything`` is zero or more characters - are mostly generated using the URL Signature Keys as configured either through the :ref:`to-api` or the :ref:`tp-services-delivery-service` view in Traffic Portal. However, if no such keys have been configured, they may be provided by fall-back Parameters. In this case, for each Parameter on assigned to this Config File on the same :ref:`Profile <profiles>` a line is inserted into the resulting configu [...]
+
+.. seealso:: `The Apache Trafficserver documentation for the url_sig plugin <https://docs.trafficserver.apache.org/en/8.0.x/admin-guide/plugins/url_sig.en.html>`_.
+
+volume.config
+'''''''''''''
+This Config File is peculiar in that it depends only on the existence of Parameters, and not each Parameter's actual Value_. The Parameters that affect the generated configuration file are the Parameters with the :ref:`Names <parameter-name>` "Drive Prefix", "RAM Drive Prefix", and "SSD Drive Prefix". Each of these Parameters must be assigned to the ``storage.config`` Config File - **NOT this Config File** - and, of course, be on the same :ref:`Profile <profiles>`. The contents of the ge [...]
+
+.. seealso:: `The Apache Traffic Server volume.config file documentation <https://docs.trafficserver.apache.org/en/7.1.x/admin-guide/files/volume.config.en.html>`_.
+
+.. _parameter-id:
+
+ID
+""
+An integral, unique identifier for a Parameter. Note that Parameters must have a unique combination of `Config File`_, :ref:`parameter-name`, and Value_, and so those should be used for identifying a unique Parameter whenever possible.
+
+.. impl-detail:: If two Profiles_ have been assigned Parameters that have the same values for `Config File`_, :ref:`parameter-name`, and Value_ then Traffic Ops actually only stores one Parameter object and merely *links* it to both Profiles_. This can be seen by inspecting the Parameters' IDs, as they will be the same. There are many cases where a user or developer must rely on this implementation detail, but both are encouraged to do so only when absolutely necessary.
+
+.. _parameter-name:
+
+Name
+""""
+The Name of a Parameter has different meanings depending on the type of any and all Profiles_ to which it is assigned, as well as the `Config File`_ to which the Parameter belongs, but most generally it is used in `Apache Traffic Server configuration files`_ as the name of a configuration option in a name/value pair. Traffic Ops interprets the Name and Value_ of a Parameter in intelligent ways depending on the type of object to which the :ref:`Profile <Profiles>` using the Parameter is a [...]
+
+.. _parameter-name-location:
+
+location
+ The Value_ of this Parameter is to be interpreted as a path under which the configuration file specified by `Config File`_ shall be found (or written, if not found). Any configuration file that is to exist on a server must have an associated "location" Parameter, even if the contents of the file cannot be affected by Parameters.
+
+ .. caution:: If a single :ref:`Profile <profiles>` has multiple "location" Parameters for the same `Config File`_ with different :ref:`Values <parameter-value>`, the actual location of the generated configuration file is undefined (but will be one of those Parameters' :ref:`Values <parameter-value>`).
+
+header
+ If the :ref:`Profile <profiles>` containing this Parameter is assigned to a server, **and** if the `Config File`_ is not one of the special values that Traffic Ops uses to determine special syntax formatting, then the Value_ of this Parameter will be used instead of the typical Traffic Ops header - *unless* it is the special string "none", in which case no header will be inserted at all.
+
+ .. caution:: If a single :ref:`Profile <profiles>` has multiple "header" Parameters for the same `Config File`_ with different :ref:`Values <parameter-value>`, the actual header is undefined (but will be one of those Parameters' :ref:`Values <parameter-value>`).
+
+.. _parameter-secure:
+
+Secure
+""""""
+When this is 'true', a user requesting to see this Parameter will see the value ``********`` instead of its actual value if the user's permission :term:`Role` isn't 'admin'.
+
+.. _parameter-value:
+
+Value
+"""""
+In general, a Parameter's :dfn:`Value` can be anything, and in the vast majority of cases the Value is *in no way validated by Traffic Control*. Usually, though, the Value has a special meaning depending on the values of the Parameter's `Config File`_ and/or :ref:`parameter-name`.
+
+.. [#xml-caveat] The contents of this file are not valid XML, but are rather XML-like so developers writing procedures that will consume and parse it should be aware of this, and note the actual syntax as specified in the `Apache Traffic Server documentation for logs_xml.config <https://docs.trafficserver.apache.org/en/6.2.x/admin-guide/files/logs_xml.config.en.html>`_
+.. [#logs-format] This Value_ may safely contain double quotes (:kbd:`"`) as they will be backslash-escaped in the generated output.
+.. [#logs-filter] This Value_ may safely contain backslashes (:kbd:`\\`) and single quotes (:kbd:`'`), as they will be backslash-escaped in the generated output.