surveil/doc/source/administration/surveil_api.rst
aviau 31994cccd3 New default port: 5311
Change-Id: Id5297f1c3bf30d8c98b8613daad3f7fe1a88fa27
2015-07-03 10:49:41 -04:00

37 lines
1.1 KiB
ReStructuredText

Surveil API
~~~~~~~~~~~
The Surveil API provides Surveil's REST API.
================================== ==========================
**package name (RPM)** surveil
**services** surveil-api.service
**Default port** 5311
**configuration (API)** /etc/surveil/surveil.cfg
**configuration (permissions)** /etc/surveil/policy.json
**configuration (API - pipeline)** /etc/surveil/api_paste.ini
================================== ==========================
The Surveil API needs access to InfluxDB, Alignak and MongoDB. If Keystone authentication is enabled, it needs access to Keystone (see api_paste.ini).
Configuration samples
---------------------
/etc/surveil/surveil.cfg
************************
.. literalinclude:: ../../../etc/surveil/surveil.cfg
/etc/surveil/policy.json
************************
For documentation on this configuration file, refer to the OpenStack documentation.
.. literalinclude:: ../../../etc/surveil/policy.json
/etc/surveil/api_paste.ini
**************************
.. literalinclude:: ../../../etc/surveil/api_paste.ini