stack-monitor: README added
[slapos.git] / stack / monitor / README.txt
1 * This stack has for purpose to know if all promises, services, custom monitoring scripts went/are ok.
2
3 * If you want to use the monitoring stack:
4
5 1/ In the software.cfg of your Software Release, extends the stack
6 2/ In the template that will be copied for the buildout in the instance folder (instance.cfg ?), you have to add these parts:
7   certificate-authority
8   ca-nginx
9   directory
10   deploy-monitor-script
11   deploy-rss-script
12   cron
13   cron-entry-monitor
14   cron-entry-rss
15   make-rss
16   nginx-service
17   slap-parameters
18
19 * If you want to add a custom monitoring script, you can write it (in whatever language you wish) and save it in YOUR_INSTANCE_FOLDER/etc/monitor.
20 The only thing to know, is that if your script successfully passed, do not return or print nothing. If there is a problem, you can print the explanation on stdout or stderr
21
22 * Here are 2 promises that you can add to your instance buildout, to see if it is working (one is ok, not the other) :
23 [google-promise]
24 recipe = slapos.cookbook:check_url_available
25 path = $${directory:promise}/google
26 url = http://www.google.com
27 dash_path = ${dash:location}/bin/dash
28 curl_path = ${curl:location}/bin/curl
29
30 [failing-promise]
31 recipe = slapos.cookbook:check_url_available
32 path = $${directory:promise}/fail
33 url = http://127.0.0.2
34 dash_path = ${dash:location}/bin/dash
35 curl_path = ${curl:location}/bin/curl