added draft tests page, to be expanded upon
authorelijah <elijah@riseup.net>
Tue, 11 Nov 2014 20:54:54 +0000 (12:54 -0800)
committerelijah <elijah@riseup.net>
Tue, 11 Nov 2014 20:54:54 +0000 (12:54 -0800)
docs/platform/tests.md [new file with mode: 0644]

diff --git a/docs/platform/tests.md b/docs/platform/tests.md
new file mode 100644 (file)
index 0000000..eeefa0e
--- /dev/null
@@ -0,0 +1,28 @@
+@title = 'Tests and Monitoring'
+@summary = 'Testing and monitoring your infrastructure.'
+@toc = true
+
+## Tests
+
+At any time, you can run troubleshooting tests on the nodes of your provider infrastructure to check to see if things seem to be working correctly. If there is a problem, these tests should help you narrow down precisely where the problem is.
+
+To run tests on FILTER node list:
+
+    leap test run FILTER
+
+Alternately, you can run test on all nodes (probably only useful if you have pinned the environment):
+
+    leap test
+
+## Monitoring
+
+If you have a node with the 'monitor' service, then this node will regularly poll every node to ask for the status of various health checks. These health checks include the checks run with `leap test`, plus many others.
+
+You can log into the monitoring web interface via XXXX. The username and password are found in the secrets.json file in your provider directory.
+
+TODO:
+
+* add how to set up monitoring. just need to add 'monitor' service? what is it compatible with?
+* add url
+* add username/password
+* add how to write your own `leap test` tests and/or nagios tests