Merge pull request #21 from Fiware/hardening/documentation

Add ReSTructured text documentation

README.rst

@@ -0,0 +1,82 @@
+FIWARE Monitoring GE
+____________________
+
+
+| |Build Status| |Coverage Status|
+
+
+Description
+===========
+
+This generic enabler allows gathering data from heterogeneous monitoring and
+metering systems in order to constantly check the status and performance of the
+cloud infrastructure.
+
+Collected information can be used for several purposes:
+
+-  Cloud users to track the performance of their own instances.
+-  SLA management, in order to check adherence to agreement terms.
+-  Optimization of virtual machines.
+
+For more information, please refer to the `documentation <doc/README.rst>`_ and,
+additionally, to the description of this GE in `FIWARE Catalogue`__.
+
+__ `FIWARE Catalogue - Monitoring GE`_
+
+
+Components
+==========
+
+`NGSI Adapter <ngsi_adapter/README.rst>`__
+   Generic adapter to transform monitoring data from probes to NGSI context
+   attributes.
+
+`NGSI Event Broker <ngsi_event_broker/README.rst>`__
+   Nagios module to forward plugin data to NGSI Adapter.
+
+
+Releases
+========
+
+`FIWARE 3.5.2`_
+
+-  NGSI Event Broker version 1.3.1
+-  NGSI Adapter version 1.1.1
+
+`FIWARE 3.5.1`_
+
+-  NGSI Event Broker version 1.3.1
+-  NGSI Adapter version 1.1.0
+
+`FIWARE 3.3.3`_
+
+-  NGSI Event Broker version 1.3.0
+-  NGSI Adapter version 1.0.1
+
+`FIWARE 3.3.2`_
+
+-  NGSI Event Broker version 1.1.0
+-  NGSI Adapter version 1.0.1
+
+
+License
+=======
+
+\(c) 2013-2014 Telefónica I+D, Apache License 2.0
+
+
+.. IMAGES
+
+.. |Build Status| image:: https://travis-ci.org/telefonicaid/fiware-monitoring.svg?branch=develop
+   :target: https://travis-ci.org/telefonicaid/fiware-monitoring
+.. |Coverage Status| image:: https://coveralls.io/repos/telefonicaid/fiware-monitoring/badge.png?branch=develop
+   :target: https://coveralls.io/r/telefonicaid/fiware-monitoring
+
+
+.. REFERENCES
+
+.. _FIWARE Catalogue - Monitoring GE: http://catalogue.fi-ware.org/enablers/monitoring-ge-tid-implementation
+.. _FIWARE 3.5.2: https://forge.fi-ware.org/frs/?group_id=7&release_id=529#cloud-monitoring-3-5-2-title-content
+.. _FIWARE 3.5.1: https://forge.fi-ware.org/frs/?group_id=7&release_id=506#cloud-monitoring-3-5-1-title-content
+.. _FIWARE 3.3.3: https://forge.fi-ware.org/frs/?group_id=7&release_id=419#cloud-monitoring-3-3-3-title-content
+.. _FIWARE 3.3.2: https://forge.fi-ware.org/frs/?group_id=23&release_id=399#cloud-monitoring-3-3-2-title-content

doc/README.rst

@@ -0,0 +1,80 @@
+Overview
+________
+
+
+What you get
+============
+
+Monitoring GE - TID Implementation is the key component to allow incorporating
+monitoring and metering mechanisms in order be able to constantly check the
+performance of the system, but the architecture should be easily extended
+to collect data for other required needs. Monitoring involves gathering
+operational data in a running system. Collected information can be used for
+several purposes:
+
+-  Cloud users to track the performance of their own instances.
+-  SLA management, in order to check adherence to agreement terms.
+-  Optimization of virtual machines.
+
+The monitoring system is used by different Cloud GEs in order to track the
+status of the resources. They use gathered data to take decisions about
+elasticity or for SLA management. Whenever a new resource is deployed in the
+cloud, the proper monitoring probe is set up and configured to start providing
+monitoring data.
+
+
+Why to get it
+=============
+
+Monitoring GE - TID Implementation is the monitoring platform to be used in the
+FIWARE Cloud ecosystem in order to monitoring and metering virtual resources.
+This middleware unify the monitoring and metering solution, providing the
+following advantages:
+
+-  **Full FIWARE integrated solution**
+
+   This component is integrated with the architecture deployed in the FIWARE
+   and you do not need to do extra work in order to integrate the solution with
+   the rest of Generic Enabler implementation.
+
+-  **Non-intrusiveness on resource functionality and performance**
+
+   The Monitoring system not affect the rest of resource functionality nor
+   performance.
+
+-  **Deal with metric heterogeneity**
+
+   The Monitoring system deals with different kind of metrics (infrastructure,
+   KPI, applications and product metrics), different virtualization
+   technologies, different products, applications, etc.
+
+-  **Scalability in monitored resources**
+
+   The system scales to large numbers of monitored nodes and resources.
+
+-  **Service Aggregation**
+
+   The framework aggregates the monitoring information collected at
+   application/service level, which means that it aggregates metrics from
+   virtual machines or hardware resources at service level.
+
+
+Documentation
+=============
+
+-  `User and Programmers Guide <user_guide.rst>`_
+-  `Installation and Administration Guide <admin_guide.rst>`_
+
+
+See also
+========
+
+-  `Monitoring Federation Infrastructure`_
+
+   This presentation summarises the development of this component as a joint
+   task between FIWARE and XIFI projects.
+
+
+.. REFERENCES
+
+.. _Monitoring Federation Infrastructure: http://www.slideshare.net/flopezaguilar/monitoring-federation-open-stack-infrastructure