Doc: Administration - Surveil API

Change-Id: I0af049cc833e3b08e379a66858fee9ba0feb30f4

doc/source/administration/index.rst

@@ -0,0 +1,9 @@
+Administration
+##############
+
+This section will covers the administration and configuration of the Surveil services.
+
+.. toctree::
+   :maxdepth: 1
+
+   surveil_api

doc/source/administration/surveil_api.rst

@@ -0,0 +1,36 @@
+Surveil API
+~~~~~~~~~~~
+
+The Surveil API provides Surveil's REST API.
+
+==================================   ==========================
+**package name (RPM)**               surveil
+**services**                         surveil-api.service
+**Default port**                     8080
+**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
+

doc/source/index.rst

@@ -8,9 +8,10 @@ Table of Contents:
    :maxdepth: 2
 
    readme
-   tutorials/index.rst
    project_architecture
+   tutorials/index.rst
    webapi/index
+   administration/index.rst
 
 Indices and tables
 ==================

etc/surveil/api_paste.ini

@@ -1,7 +1,7 @@
 # Surveil API WSGI Pipeline
 # Define the filters that make up the pipeline for processing WSGI requests
 
-# Remove authtoken from the pipeline if you don't want to use keystone authentication
+# Replace `surveil-auth` by `authtoken` to enable Keystone authentication.
 [pipeline:main]
 pipeline = surveil-auth api-server
 

etc/surveil/surveil.cfg

@@ -1,4 +1,13 @@
 [surveil]
+
+# mongodb_uri is used to connect to MongoDB. Uses the MongoDB Connection
+# String URI Format
 mongodb_uri= mongodb://mongo:27017
+
+# ws_arbiter_url is the endpoing of the ws-arbiter module of Alignak it is
+# used to send commands to Alignak
 ws_arbiter_url= http://alignak:7760
+
+# influxdb_uri is used to connect to InfluxDB. Uses the python-influxdb
+# connection string format
 influxdb_uri= influxdb://root:root@influxdb:8086/db