[GitHub] [trafficcontrol] srijeet0406 commented on a diff in pull request #6754: Convert Traffic Ops into a Service Oriented architecture(SOA) product

[GitBox <gi...@apache.org>]

srijeet0406 commented on code in PR #6754:
URL: https://github.com/apache/trafficcontrol/pull/6754#discussion_r859953356


##########
docs/source/admin/traffic_ops.rst:
##########
@@ -586,6 +590,29 @@ This file sets authentication options for connections to Riak when used as the T
 
 .. impl-detail:: The name of this file is derived from the current database used in the implementation of Traffic Vault - `Riak KV <https://riak.com/products/riak-kv/index.html>`_.
 
+.. _backends.conf:
+
+backends.conf
+"""""""""""""
+This file deals with the configuration parameters of running Traffic Ops as a reverse proxy for certain endpoints that need to be served externally by other backend services. It is a JSON-format set of options and their respective values. `traffic_ops_golang`_ will use whatever file is specified (if any) by its :option:`--backendcfg` option. The keys of the file are described below.
+
+:routes: This is an array of options to configure Traffic Ops to forward requests of specified types to the appropriate backends.
+
+	:path:              The endpoint that will be served by the backend, for example, `api/4.0/foo`.
+	:method:            The HTTP method for the above mentioned path, for example, `GET` or `PUT`.
+	:routeId:           The integral identifier for the new route being added.
+	:hosts:             An array of the hosts and ports where the request (if matched) needs to be forwarded to, for example, `cdn-foo-backend-service-host:9090`.
+	:insecure:          A boolean specifying whether or not to enable `InsecureSkipVerify`. This is an optional parameter, defaulting to `false` when not present.
+	:permissions:       An array of permissions(strings) specifying the permissions required by the user to use this API route.

Review Comment:
   Yeah, that's how the permissions model works on our normal routes as well.



-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org