aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
authorMaryam Tahhan <maryam.tahhan@intel.com>2017-02-17 10:01:53 +0000
committerMaryam Tahhan <maryam.tahhan@intel.com>2017-02-17 10:25:21 +0000
commit0eb85225a26e7eb5da3f7bf351274ccb257163d2 (patch)
treec1bd8bc4c3980a1818f88f0019512bb10aea6300 /docs/index.rst
parent2bb8c4857689cabe69d3d2d3d54dffa78d8f4a9f (diff)
docs: add templates for the new docs dirs
Add templates for missing docs in new doc structure and update project description. Change-Id: I9d9040ec43fbf143b393d1de000bfe8f25611606 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst53
1 files changed, 52 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 35e5b6b9..5e5eb616 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,7 +6,8 @@
Barometer
=========
-:Project: Barometer, https://wiki.opnfv.org/display/fastpath/Barometer+Home
+:Project: `Barometer`_
+
:Authors: Maryam Tahhan <maryam.tahhan@intel.com>
@@ -18,6 +19,50 @@ Barometer
16.12.2014 Project creation
========== =====================================================
+Barometer is the project that renames Software Fastpath service Quality Metrics
+(SFQM) and updates its scope which was networking centric.
+
+The goal of SFQM was to develop the utilities and libraries in DPDK to
+support:
+
+* Measuring Telco Traffic and Performance KPIs. Including:
+
+ * Packet Delay Variation (by enabling TX and RX time stamping).
+ * Packet loss (by exposing extended NIC stats).
+
+* Performance Monitoring of the DPDK interfaces (by exposing
+ extended NIC stats + collectd Plugin).
+* Detecting and reporting violations that can be consumed by VNFs
+ and higher level management systems (through DPDK Keep Alive).
+
+With Barometer the scope is extended to monitoring the NFVI. The ability to
+monitor the Network Function Virtualization Infrastructure (NFVI) where VNFs
+are in operation will be a key part of Service Assurance within an NFV
+environment, in order to enforce SLAs or to detect violations, faults or
+degradation in the performance of NFVI resources so that events and relevant
+metrics are reported to higher level fault management systems.
+If physical appliances are going to be replaced by virtualized appliances
+the service levels, manageability and service assurance needs to remain
+consistent or improve on what is available today. As such, the NFVI needs to
+support the ability to monitor:
+
+* Traffic monitoring and performance monitoring of the components that provide
+ networking functionality to the VNF, including: physical interfaces, virtual
+ switch interfaces and flows, as well as the virtual interfaces themselves and
+ their status, etc.
+* Platform monitoring including: CPU, memory, load, cache, themals, fan speeds,
+ voltages and machine check exceptions, etc.
+
+All of the statistics and events gathered must be collected in-service and must
+be capable of being reported by standard Telco mechanisms (e.g. SNMP), for
+potential enforcement or correction actions. In addition, this information
+could be fed to analytics systems to enable failure prediction, and can also be
+used for intelligent workload placement.
+
+All developed features will be upstreamed to Open Source projects relevant to
+telemetry such as `collectd`_, `Ceilometer`_. and other relavent Openstack
+projects.
+
.. toctree::
:maxdepth: 3
:numbered:
@@ -27,8 +72,14 @@ Barometer
./release/userguide/index.rst
./release/release-notes/index.rst
./development/requirements/index.rst
+ ./development/design/index.rst
+ ./development/testing/index.rst
Indices
=======
* :ref:`search`
+.. _Barometer: https://wiki.opnfv.org/display/fastpath
+.. _collectd: http://collectd.org/
+.. _Ceilometer: https://wiki.openstack.org/wiki/Telemetry
+