This is an automated email from the ASF dual-hosted git repository.
mattjackson 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 814c0bb Atstccfg doc update (#4887)
814c0bb is described below
commit 814c0bb20a6024e56f157c8826894b2789f0290f
Author: ocket8888 <[email protected]>
AuthorDate: Thu Aug 6 12:10:41 2020 -0600
Atstccfg doc update (#4887)
* Updated docs for atstccfg to account for new command-line option-argument
* Fixed bad formatting on cdn.conf configuration value
* Fixed broken links due to using ref instead of term
---
docs/source/admin/traffic_ops.rst | 3 ++-
docs/source/api/v3/cdns_name_snapshot.rst | 2 +-
docs/source/api/v3/cdns_name_snapshot_new.rst | 2 +-
docs/source/tools/atstccfg.rst | 25 ++++++++++++++++++++++---
traffic_ops_ort/atstccfg/README.md | 11 ++++++++---
5 files changed, 34 insertions(+), 9 deletions(-)
diff --git a/docs/source/admin/traffic_ops.rst
b/docs/source/admin/traffic_ops.rst
index 7a54f41..9ae357b 100644
--- a/docs/source/admin/traffic_ops.rst
+++ b/docs/source/admin/traffic_ops.rst
@@ -444,8 +444,9 @@ This file deals with the configuration parameters of
running Traffic Ops itself.
:ignore_unknown_routes: If ``false`` (default) return an error
and prevent startup if unknown route IDs are found. Otherwise, log a warning
and continue startup.
:use_ims:
+
.. versionadded:: 5.0
- This is an optional boolean value to enable the handling of the
"If-Modified-Since" HTTP request header. Default: false
+ This is an optional boolean value to enable the handling of the
"If-Modified-Since" HTTP request header. Default: false
Example cdn.conf
''''''''''''''''
diff --git a/docs/source/api/v3/cdns_name_snapshot.rst
b/docs/source/api/v3/cdns_name_snapshot.rst
index a2bdd01..ab197a9 100644
--- a/docs/source/api/v3/cdns_name_snapshot.rst
+++ b/docs/source/api/v3/cdns_name_snapshot.rst
@@ -120,7 +120,7 @@ Response Structure
: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: A string that is the :ref:`cache-group-name` of the
:term:`Cache Group` to which the server belongs
- :capabilities: An array of this :ref:`Cache Server`'s :term:`Server
Capabilities`. If the Cache Server has no Server Capabilities, this field is
omitted.
+ :capabilities: An array of this :term:`Cache Server`'s
:term:`Server Capabilities`. If the Cache Server has no Server Capabilities,
this field is omitted.
: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 :abbr:`FQDNs (Fully Qualified
Domain Names)` that resolve to this :term:`cache server`
.. note:: Only :term:`Edge-tier cache servers` can be assigned
to a :term:`Delivery Service`, and therefore this field will only be present
when ``type`` is ``"EDGE"``.
diff --git a/docs/source/api/v3/cdns_name_snapshot_new.rst
b/docs/source/api/v3/cdns_name_snapshot_new.rst
index 049cbde..e256407 100644
--- a/docs/source/api/v3/cdns_name_snapshot_new.rst
+++ b/docs/source/api/v3/cdns_name_snapshot_new.rst
@@ -119,7 +119,7 @@ Response Structure
: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: A string that is the :ref:`cache-group-name` of the
:term:`Cache Group` to which the server belongs
- :capabilities: An array of this :ref:`Cache Server`'s :term:`Server
Capabilities`. If the Cache Server has no Server Capabilities, this field is
omitted.
+ :capabilities: An array of this :term:`Cache Server`'s
:term:`Server Capabilities`. If the Cache Server has no Server Capabilities,
this field is omitted.
: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 :abbr:`FQDNs (Fully Qualified
Domain Names)` that resolve to this :term:`cache server`
.. note:: Only :term:`Edge-tier cache servers` can be assigned
to a :term:`Delivery Service`, and therefore this field will only be present
when ``type`` is ``"EDGE"``.
diff --git a/docs/source/tools/atstccfg.rst b/docs/source/tools/atstccfg.rst
index dc41248..09debcc 100644
--- a/docs/source/tools/atstccfg.rst
+++ b/docs/source/tools/atstccfg.rst
@@ -31,9 +31,9 @@ Usage
- ``atstccfg -h``
- ``atstccfg -v``
- ``atstccfg -l``
-- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [-y] -n
CACHE_NAME``
-- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] -n
CACHE_NAME -d DATA``
-- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] -n
CACHE_NAME -a REVAL_STATUS -q QUEUE_STATUS``
+- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [-y] [--dir
TSROOT] -n CACHE_NAME``
+- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [--dir
TSROOT] -n CACHE_NAME -d DATA``
+- ``atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r
N] [-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [--dir
TSROOT] -n CACHE_NAME -a REVAL_STATUS -q QUEUE_STATUS``
When called using the fourth form, :program:`atstccfg` provides its normal
output. This is the entirety of all configuration files necessary for the
server, all provided at once. The output is in :mimetype:`mixed/multipart`
format, defined by :rfc:`1521`. Each chunk of the message comes with the
proprietary ``Path`` header, which specifies the exact location on disk of the
file whose contents are contained in that chunk.
@@ -71,6 +71,25 @@ Options
update-status
Retrieves information about the current update status using
:ref:`to-api-servers-hostname-update_status`. The response is in the same
format as the responses for that endpoint's GET method handler - except that
that endpoint returns an array and this :program:`atstccfg` call signature
returns a single one of those elements. Which one is chosen is arbitrary (hence
undefined behavior when more than one server with the same hostname exists).
+.. option:: --dir TSROOT
+
+ Specifies a directory path in which to place Traffic Server
configuration
+ files, in the event that "location" :term:`Parameters` are not found for
+ them. If this is not given and location :term:`Parameters` are not
found for
+ required files, then :program:`atstccfg` will exit with an error.
+
+ The files that :program:`atstccfg` considers "required" for these
purposes
+ are:
+
+ - cache.config
+ - hosting.config
+ - parent.config
+ - plugin.config
+ - records.config
+ - remap.config
+ - storage.config
+ - volume.config
+
.. option:: -h, --help
Print usage information and exit.
diff --git a/traffic_ops_ort/atstccfg/README.md
b/traffic_ops_ort/atstccfg/README.md
index af13ca4..21e3d14 100644
--- a/traffic_ops_ort/atstccfg/README.md
+++ b/traffic_ops_ort/atstccfg/README.md
@@ -27,9 +27,9 @@ atstccfg is a tool for generating configuration files
server-side on ATC cache s
atstccfg -h
atstccfg -v
atstccfg -l
-atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [-y] -n
CACHE_NAME
-atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] -n CACHE_NAME
-d DATA
-atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] -n CACHE_NAME
-a REVAL_STATUS -q QUEUE_STATUS
+atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [-y] [--dir
TSROOT] -n CACHE_NAME
+atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [--dir TSROOT]
-n CACHE_NAME -d DATA
+atstccfg [-e ERROR_LOCATION] [-i INFO_LOCATION] [-p] [-P TO_PASSWORD] [-r N]
[-s] [-t TIMEOUT] [-u TO_URL] [-U TO_USER] [-w WARNING_LOCATION] [--dir TSROOT]
-n CACHE_NAME -a REVAL_STATUS -q QUEUE_STATUS
```
The available options are:
```
@@ -47,6 +47,11 @@ The available options are:
disables normal output. Valid values are update-status, packages,
chkconfig,
system-info, and statuses. Output is in JSON-encoded format. For specifics,
refer to the official documentation.
+--dir string
+ Specifies a directory path in which to place Trafficserver configuration
+ files in the event that "location" Parameters aren't found for them. If
this
+ is not given and location Parameters aren't found for required files,
+ atstccfg will exit with an error.
-h, --help
Print usage information and exit.
-i, --log-location-info string
