ocket8888 commented on a change in pull request #4933:
URL: https://github.com/apache/trafficcontrol/pull/4933#discussion_r473253507
##########
File path: docs/source/admin/traffic_ops.rst
##########
@@ -399,6 +399,10 @@ This file deals with the configuration parameters of
running Traffic Ops itself.
:db_query_timeout_seconds: An optional field specifying a timeout on
database *transactions* (not actually single queries in most cases) within API
route handlers. Effectively this is a timeout on a single handler's ability to
interact with the Traffic Ops Database. Default if not specified is the value
of `DefaultDBQueryTimeoutSecs
<https://godoc.org/github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/config#pkg-constants>`_.
:idle_timeout: An optional timeout in seconds for idle client
connections to Traffic Ops. If set to zero, the value of ``read_timeout`` will
be used instead. If both are zero, then the value of ``read_header_timeout``
will be used. If all three fields are zero, there is no timeout and connections
will be kept alive indefinitely - **not** recommended. Default if not specified
is zero.
:insecure: An optional boolean which, if set to ``true`` will cause
Traffic Ops to skip verification of client certificates whenever
necessary/possible. If set to ``false``, the normal verification behavior is
exhibited. Default if not specified is ``false``.
+
+ .. deprecated:: 4.2
Review comment:
This should be 5.0 - "4.2" was created as a part of our automatic
version incrementing system, but it will never actually exist. The next planned
release is 5.0.
##########
File path: docs/source/admin/traffic_ops.rst
##########
@@ -443,6 +447,8 @@ This file deals with the configuration parameters of
running Traffic Ops itself.
:disabled_routes: A list of API route IDs to disable. Requests
matching these routes will receive a 503 response. To find the route ID for a
given path you would like to disable, run ``./traffic_ops_golang`` using the
:option:`--api-routes` option to view all the route information, including
route IDs and paths.
: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.
+ :tls_config: An optional stanza for TLS configuration. The values of
which can be found here: https://golang.org/pkg/crypto/tls/#Config
Review comment:
To link to a GoDoc, use our custom `:godoc:` role. In this case, it'd be:
```rst
The values of which conform to the :godoc:`crypto/tls.Config` structure.
```
That creates an automatic link.
##########
File path: traffic_ops/traffic_ops_golang/config/config.go
##########
@@ -99,8 +100,9 @@ type ConfigTrafficOpsGolang struct {
RiakPort *uint `json:"riak_port"`
WhitelistedOAuthUrls []string
`json:"whitelisted_oauth_urls"`
OAuthClientSecret string
`json:"oauth_client_secret"`
- RoutingBlacklist `json:"routing_blacklist"`
- SupportedDSMetrics []string `json:"supported_ds_metrics"`
+ RoutingBlacklist
`json:"routing_blacklist"`
+ SupportedDSMetrics []string
`json:"supported_ds_metrics"`
+ TLSConfig *tls.Config `json:"tls_config"`
Review comment:
This file needs to be `go fmt`-ed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
