Merge "docs: Update documentation to refer to Barometer"

7 files changed, 101 insertions, 53 deletions

diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst
index 9b02e8ca..d5b161f6 100644
--- a/docs/configguide/index.rst
+++ b/docs/configguide/index.rst
@@ -2,9 +2,9 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright (c) 2016 Open Platform for NFV Project, Inc. and its contributors
 
-==============================
-SFQM Guides and Installation
-==============================
+==================================
+Barometer Guides and Installation
+==================================
 
 .. toctree::
     :numbered:
diff --git a/docs/index.rst b/docs/index.rst
index e22c95e7..00e13366 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,11 +2,11 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) OPNFV, Intel Corporation and others.
 
-******************************************
-Software Fastpath Service Quality Metrics
-******************************************
+**********
+Barometer
+**********
 
-:Project: SFQM, https://wiki.opnfv.org/collaborative_development_projects/opnfv_telco_kpi_monitoring
+:Project: Barometer, https://wiki.opnfv.org/display/fastpath/Barometer+Home
 :Authors: Maryam Tahhan <maryam.tahhan@intel.com>
 :History:
 
@@ -25,6 +25,6 @@ Table of Contents:
      :numbered:
 
      requirements/index.rst
-     conffiguide/index.rst
+     configguide/index.rst
      userguide/index.rst
      release/index.rst
diff --git a/docs/release/01-release.rst b/docs/release/01-release.rst
index 0399020c..dcf6e180 100644
--- a/docs/release/01-release.rst
+++ b/docs/release/01-release.rst
@@ -9,17 +9,17 @@ relevant upstream projects.
 
 .. Figure:: Features_to_date1.png
 
-   SFQM features to date
+   Barometer features to date
 
 .. Figure:: Features_to_date2.png
 
-   SFQM features to date cont.
+   Barometer features to date cont.
 
 Please note the timeline denotes DPDK releases.
 
 Release B
 =========
-The features implemented for OPNFV release B in DPDK include:
+The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
 
 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
@@ -28,7 +28,7 @@ The features implemented for OPNFV release B in DPDK include:
 
 Release C
 =========
-The features implemented for OPNFV release C include:
+The features implemented for OPNFV release C (as part of SFQM) include:
 
 * DPDK extended NIC stats API improvement; migrate from key value pairs to
   using id value pairs.
diff --git a/docs/requirements/01-intro.rst b/docs/requirements/01-intro.rst
index 56a41336..bc0e9ba0 100644
--- a/docs/requirements/01-intro.rst
+++ b/docs/requirements/01-intro.rst
@@ -4,9 +4,11 @@
 
 Introduction
 ============
+Barometer is the project that renames Software Fastpath service Quality Metrics
+(SFQM) and updates its scope which was networking centric.
 
-The goal of Software Fastpath service Quality Metrics (SFQM) is to
-develop the utilities and libraries in `DPDK`_ to support:
+The goal of SFQM was to develop the utilities and libraries in DPDK to
+support:
 
 * Measuring Telco Traffic and Performance KPIs. Including:
 
@@ -18,15 +20,35 @@ develop the utilities and libraries in `DPDK`_ to support:
 * Detecting and reporting violations that can be consumed by VNFs
   and higher level management systems (through DPDK Keep Alive).
 
-After all **the ability to measure and enforce Telco KPIs (Service
-assurance) in the data-plane will be mandatory for any Telco grade NFVI
-implementation**.
+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:
 
-All developed features will be upstreamed to `DPDK`_ or other Open
-Source projects relevant to telemetry such as `collectd`_ and
-`Ceilometer`_.
+* 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.
 
-The OPNFV project wiki can be found @ `SFQM`_
+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`_ and `Ceilometer`_.
+
+The OPNFV project wiki can be found @ `Barometer`_
 
 Problem Statement
 ==================
@@ -69,8 +91,21 @@ All these traffic statistics for Traffic and Performance Monitoring must be
 measured in-service and must be capable of being reported by standard Telco
 mechanisms (e.g. SNMP traps), for potential enforcement actions.
 
-Scope
-======
+Barometer updated scope
+=======================
+The scope of the project is to provide interfaces to support monitoring of the
+NFVI. The project will develop plugins for telemetry frameworks to enable the
+collection of platform stats and events and relay gathered information to fault
+management applications or the VIM. The scope is limited to
+collecting/gathering the events and stats and relaying them to a relevant
+endpoint. The project will not enforce or take any actions based on the
+gathered information.
+
+.. image: barometer_scope.png
+
+Scope of SFQM
+=============
+**NOTE:** The SFQM project has been replaced by Barometer.
 The output of the project will provide interfaces and functions to support
 monitoring of Packet Latency and Network Interfaces while the VNF is in service.
 
@@ -126,25 +161,23 @@ In reality many VNFs will have an existing performance or traffic monitoring
 utility used to monitor VNF behavior and report statistics, counters, etc.
 
 The consumption of performance and traffic related information/events provided
-by this project should be a logical extension of any existing VNF monitoring
-utility. It should not require a new utility to be developed. We do not see the
-Software Fastpath Service Quality Metrics data as major additional effort for
-VNFs to consume; this project would be sympathetic to existing VNF architecture
-constructs. The intention is that this project represents a lower level
-interface for network interface monitoring to be used
-by higher level fault management entities (see below).
-
-Allowing the Software Fastpath Service Quality Metrics data to be handled within
-existing VNF performance or traffic monitoring utilities also makes it simpler
-for overall interfacing with higher level management components in the VIM, MANO
-and OSS/BSS. The Software Fastpath Service Quality Metrics proposal would be
-complementary to the Fault Management and Maintenance project proposal
-(Doctor), which addresses NFVI Fault Management
-support in the VIM. To that end, the project committers and contributors for the
-Software Fastpath Service Quality Metrics project wish to collaborate with the
-Doctor project to facilitate this.
-
-.. _SFQM: https://wiki.opnfv.org/collaborative_development_projects/opnfv_telco_kpi_monitoring
-.. _DPDK: http://dpdk.org/
+by this project should be a logical extension of any existing VNF/NFVI monitoring
+framework. It should not require a new framework to be developed. We do not see
+the Barometer gathered metrics and evetns as major additional effort for
+monitoring frameworks to consume; this project would be sympathetic to existing
+monitoring frameworks. The intention is that this project represents an
+interface for NFVI monitoring to be used by higher level fault management
+entities (see below).
+
+Allowing the Barometer metrics and events to be handled within existing
+telemetry frameoworks makes it simpler for overall interfacing with higher
+level management components in the VIM, MANO and OSS/BSS. The Barometer
+proposal would be complementary to the Doctor project, which addresses NFVI Fault
+Management support in the VIM, and the VES project, which addresses the
+integration of VNF telemetry-related data into automated VNF management
+systems. To that end, the project committers and contributors for the Barometer
+project wish to collaborate with the Doctor and VES projects to facilitate this.
+
+.. _Barometer: https://wiki.opnfv.org/display/fastpath
 .. _collectd: http://collectd.org/
 .. _Ceilometer: https://wiki.openstack.org/wiki/Telemetry
diff --git a/docs/requirements/barometer_scope.png b/docs/requirements/barometer_scope.png
new file mode 100755
index 00000000..03783bde
--- /dev/null
+++ b/docs/requirements/barometer_scope.png
diff --git a/docs/userguide/collectd.userguide.rst b/docs/userguide/collectd.userguide.rst
index 0755fdf5..5151befc 100644
--- a/docs/userguide/collectd.userguide.rst
+++ b/docs/userguide/collectd.userguide.rst
@@ -149,19 +149,27 @@ Notifications in collectd are generic messages containing:
 
 collectd plugins
 ----------------
-SFQM has enabled three collectd plugins to date:
+Barometer has enabled the following collectd plugins:
 
-* `dpdkstat plugin`_: A read plugin that retrieve stats from the DPDK extended
+* dpdkstat plugin: A read plugin that retrieve stats from the DPDK extended
    NIC stats API.
 
 * `ceilometer plugin`_: A write plugin that pushes the retrieved stats to
   Ceilometer. It's capable of pushing any stats read through collectd to
   Ceilometer, not just the DPDK stats.
 
-* `hugepages plugin`_:  A read plugin that retrieves the number of available
+* hugepages plugin:  A read plugin that retrieves the number of available
   and free hugepages on a platform as well as what is available in terms of
   hugepages per socket.
 
+* RDT plugin: A read plugin that provides the last level cache utilitzation and
+  memory bandwidth utilization
+
+All the plugins above are available on the collectd master, except for the
+ceilometer plugin as it's a python based plugin and only C plugins are accepted
+by the collectd community. The ceilometer plugin lives in the OpenStack
+repositories.
+
 Other plugins in progress:
 
 * dpdkevents:  A read plugin that retrieves DPDK link status and DPDK
@@ -172,6 +180,15 @@ Other plugins in progress:
 
 * Open vSwitch events Plugin: A read plugin that retrieves events from OVS.
 
+* mcelog plugin: A read plugin that uses mcelog client protocol to check for
+  memory Machine Check Exceptions and sends the stats for reported exceptions.
+
+* SNMP write: A write plugin that will act as a SNMP subagent and will map
+  collectd metrics to relavent OIDs. Will only support SNMP: get, getnext and
+  walk.
+
+* Legacy/IPMI: A read plugin that will report platform thermals, voltages,
+  fanspeed....
 
 Monitoring Interfaces and Openstack Support
 -------------------------------------------
@@ -197,6 +214,4 @@ References
 [7] https://collectd.org/wiki/index.php/Meta_Data_Interface
 
 .. _SFQM OPNFV Summit demo: https://prezi.com/kjv6o8ixs6se/software-fastpath-service-quality-metrics-demo/
-.. _dpdkstat plugin: https://github.com/maryamtahhan/collectd-with-DPDK/tree/dpdkstat
 .. _ceilometer plugin: https://github.com/openstack/collectd-ceilometer-plugin/tree/stable/mitaka
-.. _hugepages plugin: https://github.com/maryamtahhan/collectd-with-DPDK/tree/hugepages
diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 994f63c8..ae459d0a 100644
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -3,14 +3,14 @@
       .. (c) <optionally add copywriters name>
 
 ====================
-SFQM user guide
+Barometer user guide
 ====================
 
 .. The feature user guide should provide an OPNFV user with enough information to
-   .. use the features provided by the feature project in the supported scenarios.
-      .. This guide should walk a user through the usage of the features once a scenario
-         .. has been deployed and is active according to the installation guide provided
-            .. by the installer project.
+.. use the features provided by the feature project in the supported scenarios.
+.. This guide should walk a user through the usage of the features once a scenario
+.. has been deployed and is active according to the installation guide provided
+.. by the installer project.
 
 .. toctree::
      :maxdepth: 3