documentation

playbooks/roles/locust/tasks/main.yml

@@ -12,14 +12,23 @@
 # Tasks for role locust
 # 
 # Overview:
-# 
+#  - Expects a load-tests repo that declares locust.io as a requirement
+#  - Installs load-tests repo using standard edx service roles
+#  - configures locust with defaults in supervisor
 #
 # Dependencies:
-#
+#  - edx-service role
+#  - load tests repo with locust tests in it.
 # 
 # Example play:
 #
-#
+#   # To run: ansible-playbook locust.yml -i "locustmaster.m.sandbox.edx.org," -e "LOCUST_LOADTEST_DIR='locust/lms'" -e "LOCUST_TARGET_HOST='https://courses-loadtest.edx.org'" -e "@/Users/derf/workspace/sandbox-secure/ansible/vars/developer-sandbox.yml"
+#   - name: Deploy Locust
+#     hosts: all
+#     sudo: True
+#     gather_facts: True
+#     roles:
+#       - locust
 
 - name: install application requirements
   pip: >