Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pratid committed Aug 10, 2015
1 parent 511608a commit a5c4a81
Show file tree
Hide file tree
Showing 16 changed files with 511 additions and 635 deletions.
29 changes: 13 additions & 16 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Requirements
------------

- System resources: see `these recommendations
<doc/manuals/admin/resources.rst#resources-recommendations>`_.
<doc/manuals/admin/README.rst#resource-availability>`_.
- Operating systems: CentOS (RedHat) and Ubuntu (Debian), being CentOS 6.3 the
reference operating system.
- RPM/DEB dependencies: some required packages may not be present in official
Expand Down Expand Up @@ -175,7 +175,7 @@ command line or as a system service (the latter only available if installed as
a package). It is not recommended to mix both ways (e.g. start it manually but
use the service scripts to stop it). This section assumes you are using the
system service (recommended): for the command line alternative, please refer
to `this document <doc/manuals/admin/adapter_cli.rst>`_.
to `this document <doc/manuals/admin/README.rst#from-the-command-line>`_.

In order to start the adapter service, run::

Expand Down Expand Up @@ -216,7 +216,7 @@ The configuration used by the adapter service is optionally read from the file


All these attributes map to options of the `command line interface
<doc/manuals/admin/adapter_cli.rst>`_ as follows:
<doc/manuals/admin/README.rst#from-the-command-line>`_ as follows:

- ``ADAPTER_LOGLEVEL`` maps to ``-l`` or ``--logLevel`` option
- ``ADAPTER_LISTEN_HOST`` maps to ``-H`` or ``--listenHost`` option
Expand Down Expand Up @@ -258,16 +258,8 @@ This would result in an invocation to Context Broker updating the context
of an entity of type ``host`` identified by ``myhostname`` with a new
attribute ``cpuLoadPct`` with value ``5.00``.

Please have a look at the `Quick Start guide
<doc/manuals/quick_start_guide.rst>`_ for more examples. And, additionally,
at the `API Walkthrough`_ and `API Reference Documentation`_ sections bellow
in order to know more details about the API.


API Walkthrough
---------------

- `FIWARE Monitoring v1 <doc/manuals/user/walkthrough_api_v1.rst>`_
Please have a look at the `API Reference Documentation`_ section bellow and
at the `programmer guide <doc/manuals/user/README.rst#programmer-guide>`_.


API Reference Documentation
Expand Down Expand Up @@ -329,12 +321,17 @@ unit tests.
Advanced topics
===============

- Installation and administration
- `Installation and administration <doc/manuals/admin/README.rst>`_

* `Building from sources <doc/manuals/admin/build_source.rst>`_
* `Running Adapter from command line <doc/manuals/admin/adapter_cli.rst>`_
* `Running Adapter from command line <doc/manuals/admin/README.rst#from-the-command-line>`_
* `Logs <doc/manuals/admin/logs.rst>`_
* `Resources & I/O Flows <doc/manuals/admin/resources.rst>`_
* `Resources & I/O Flows <doc/manuals/admin/README.rst#resource-availability>`_

- `User and programmers guide <doc/manuals/user/README.rst>`_

* `NGSI Adapter custom probe parsers <doc/manuals/user/README.rst#ngsi-adapter-parsers>`_
* `Retrieval of historical data <doc/manuals/user/README.rst#monitoring-api>`_


License
Expand Down
55 changes: 28 additions & 27 deletions doc/README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
Overview
________
==========
Overview
==========


What you get
Expand All @@ -12,9 +13,9 @@ 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.
- 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
Expand All @@ -31,48 +32,48 @@ 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**
- **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.
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**
- **Non-intrusiveness on resource functionality and performance**

The Monitoring system not affect the rest of resource functionality nor
performance.
The Monitoring system not affect the rest of resource functionality nor
performance.

- **Deal with metric heterogeneity**
- **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.
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**
- **Scalability in monitored resources**

The system scales to large numbers of monitored nodes and resources.
The system scales to large numbers of monitored nodes and resources.

- **Service Aggregation**
- **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.
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>`_
- `User and Programmers Guide <manuals/user/README.rst>`_
- `Installation and Administration Guide <manuals/admin/README.rst>`_


See also
========

- `Monitoring Federation Infrastructure`_
- `Monitoring Federation Infrastructure`_

This presentation summarises the development of this component as a joint
task between FIWARE and XIFI projects.
This presentation summarises the development of this component as a joint
task between FIWARE and XIFI projects.


.. REFERENCES
Expand Down
Loading

0 comments on commit a5c4a81

Please sign in to comment.