[GitHub] [trafficcontrol] dangogh commented on a change in pull request #3585: Initial contribution of Ansible-based lab deployment efforts

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

dangogh commented on a change in pull request #3585: Initial contribution of Ansible-based lab deployment efforts
URL: https://github.com/apache/trafficcontrol/pull/3585#discussion_r296021236
 
 

 ##########
 File path: infrastructure/ansible/dynamic.inventory/README.md
 ##########
 @@ -0,0 +1,44 @@
+<!--
+    Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you 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.
+-->
+# Ansible Dynamic Inventory
+
+This python script uses the Traffic Ops Python Native Client to expose much of the TO dataset as an ansible inventory on demand as Ansible patterns.
+
+## Requirements
+You will need to ensure the Traffic Ops Python Native Client is available to the python env shared by Ansible.
+
+Due to limitations in the way parameters are passed in Ansible Dynamic Inventory scripts, the following environment variables must be defined:
+```bash
+export TO_USERNAME=<my.to.username>
 
 Review comment:
   it's actually `TO_USER` and not `TO_USERNAME`. 

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services