x/surveil
Code Issues Proposed changes

Merge "Documentation: Added host configuration tutorial"

Browse Source
This commit is contained in:
Jenkins 2015-05-15 19:00:17 +00:00 committed by Gerrit Code Review
commit f30af26265
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/source/getting_started.rst
View File

@ -60,7 +60,35 @@ variable::
export SURVEIL_AUTH_URL=http://localhost:8080/v2/auth export SURVEIL_AUTH_URL=http://localhost:8080/v2/auth
You can now use the CLI to view the status of the currently monitored hosts: Viewing host status
```````````````````
You can use the CLI to view the status of the currently monitored hosts and services with
:bash:`surveil status-host-list` and :bash:`surveil status-service-list`
:bash:`surveil status-host-list` Example output: ::
+-------------------------------+---------------+-------+------------+-----------------------------------+
| host_name | address | state | last_check | plugin_output |
+-------------------------------+---------------+-------+------------+-----------------------------------+
| srv-ldap-01 | 127.0.0.1 | UP | 1431712968 | OK - 127.0.0.1: rta 0.036ms, l... |
| sw-iwebcore-01 | 127.0.0.1 | UP | 1431712971 | OK - 127.0.0.1: rta 0.041ms, l... |
| os-controller-1.cloud.mtl.sfl | 145.50.1.61 | UP | 1431713146 | OK - 172.20.1.21: rta 0.453ms,... |
| os-compute-1.cloud.mtl.sfl | 145.50.1.62 | UP | 1431713144 | OK - 172.20.1.31: rta 0.318ms,... |
| os-compute-2.cloud.mtl.sfl | 145.50.1.63 | UP | 1431713144 | OK - 172.20.1.32: rta 0.378ms,... |
| os-compute-3.cloud.mtl.sfl | 145.50.1.64 | UP | 1431713146 | OK - 172.20.1.33: rta 0.373ms,... |
| os-compute-4.cloud.mtl.sfl | 145.50.1.65 | UP | 1431713146 | OK - 172.20.1.34: rta 0.337ms,... |
+-------------------------------+---------------+-------+------------+-----------------------------------+
You can also use the CLI to view the configured hosts in the API with
:bash:`surveil config-host-list` and :bash:`surveil config-service-list`
Adding a new host
`````````````````
Surveil ships with configuration templates (or packs). While it is possible possible to define services by yourself, it is suggested
to use configuration templates. For example, the following command defines a host using the OpenStack Keystone template: ::
surveil config-host-create --host_name os-controller-1.cloud.mtl.sfl --address 172.20.1.21 --use linux-keystone --custom_fields '{"_OS_AUTH_URL":"http://145.50.1.61:5000/v2.0", "_OS_TENANT_NAME":"admin", "_OS_USERNAME":"admin", "_OS_PASSWORD":"password","_KS_SERVICES":"identity"}'
This will create a ``os-controller-1.cloud.mtl.sfl`` host using the ``linux-keystone`` template. A service will be automatically
defined to monitor the Keystone API with the authentication credentials provided. More documentation about configuration packs
is available `here <http://sfl-monitoring-tools.readthedocs.org>`_.