dangogh commented on a change in pull request #2965: Config compare test
URL: https://github.com/apache/trafficcontrol/pull/2965#discussion_r229458777
##########
File path: docs/source/tools/compare.rst
##########
@@ -104,3 +104,27 @@ The genConfigRoutes.py script will output list of unique
API routes (relative to
./genConfigRoutes.py https://trafficopsA.example.test
https://trafficopsB.example.test username:password | ./compare
\... assuming the proper environment variables have been set for ``compare``.
+
+Usage with Docker
+=================
+A Dockerfile is provided to run tests on a pair of instances given the
configuration environment variables necessary. This will generate configuration
file routes using ``genConfigRoutes.py``, and add them to whatever is already
contained in ``traffic_ops/testing/compare/testroutes.txt``, then run the
``compare`` tool on the final API route list. Build artifacts (i.e. anything
output files created by the `compare` tool) are placed in the `/artifacts/`
directory on the container. To retrieve these results, the use of a volume is
recommended. The build context *must* be at the root of the Traffic Control
repository, as the tools have dependencies on the Traffic Control clients. In
order to use the container, the following environment variables must be defined
for the container at runtime:
+
+TO_URL
+ The URL of the reference Traffic Ops instance
+TO_USER
+ The username to authenticate with the reference Traffic Ops instance
+TO_PASSWD
+ The password to authenticate with the reference Traffic Ops instance
Review comment:
everywhere else, this is `TO_PASSWORD` -- should keep that consistent to
reduce confusion
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
