added draft tests page, to be expanded upon
[leap_doc.git] / docs / platform / tests.md
1 @title = 'Tests and Monitoring'
2 @summary = 'Testing and monitoring your infrastructure.'
3 @toc = true
4
5 ## Tests
6
7 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.
8
9 To run tests on FILTER node list:
10
11     leap test run FILTER
12
13 Alternately, you can run test on all nodes (probably only useful if you have pinned the environment):
14
15     leap test
16
17 ## Monitoring
18
19 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.
20
21 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.
22
23 TODO:
24
25 * add how to set up monitoring. just need to add 'monitor' service? what is it compatible with?
26 * add url
27 * add username/password
28 * add how to write your own `leap test` tests and/or nagios tests