aboutsummaryrefslogtreecommitdiffstats
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
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>
-rw-r--r--docs/development/design/index.rst1
-rw-r--r--docs/development/overview/index.rst1
-rw-r--r--docs/development/requirements/01-intro.rst60
-rw-r--r--docs/development/requirements/index.rst17
-rw-r--r--docs/index.rst53
-rw-r--r--docs/testing/index.rst1
6 files changed, 68 insertions, 65 deletions
diff --git a/docs/development/design/index.rst b/docs/development/design/index.rst
new file mode 100644
index 0000000..392b39f
--- /dev/null
+++ b/docs/development/design/index.rst
@@ -0,0 +1 @@
+.. To be decided
diff --git a/docs/development/overview/index.rst b/docs/development/overview/index.rst
new file mode 100644
index 0000000..392b39f
--- /dev/null
+++ b/docs/development/overview/index.rst
@@ -0,0 +1 @@
+.. To be decided
diff --git a/docs/development/requirements/01-intro.rst b/docs/development/requirements/01-intro.rst
index bc0e9ba..70abc55 100644
--- a/docs/development/requirements/01-intro.rst
+++ b/docs/development/requirements/01-intro.rst
@@ -2,56 +2,8 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.
-Introduction
-============
-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`_ and `Ceilometer`_.
-
-The OPNFV project wiki can be found @ `Barometer`_
-
Problem Statement
-==================
+------------------
Providing carrier grade Service Assurance is critical in the network
transformation to a software defined and virtualized network (NFV).
Medium-/large-scale cloud environments account for between hundreds and
@@ -92,7 +44,7 @@ measured in-service and must be capable of being reported by standard Telco
mechanisms (e.g. SNMP traps), for potential enforcement actions.
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
@@ -104,7 +56,7 @@ 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.
@@ -156,7 +108,7 @@ this and would report to a VNF-level Failover and High Availability mechanism
that would then determine what actions, including failover, may be triggered.
Consumption Models
-===================
+^^^^^^^^^^^^^^^^^^^
In reality many VNFs will have an existing performance or traffic monitoring
utility used to monitor VNF behavior and report statistics, counters, etc.
@@ -177,7 +129,3 @@ 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/development/requirements/index.rst b/docs/development/requirements/index.rst
index e5d0489..685f611 100644
--- a/docs/development/requirements/index.rst
+++ b/docs/development/requirements/index.rst
@@ -2,13 +2,14 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) OPNFV, Intel Corporation and others.
-**********************
-Barometer Requirements
-**********************
+=============================
+OPNFV Barometer Requirements
+=============================
+
.. toctree::
- :maxdepth: 3
- :numbered:
+ :maxdepth: 1
+
+ 01-intro
+ 02-collectd
+ 03-dpdk
- 01-intro.rst
- 02-collectd.rst
- 03-dpdk.rst
diff --git a/docs/index.rst b/docs/index.rst
index 35e5b6b..5e5eb61 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
+
diff --git a/docs/testing/index.rst b/docs/testing/index.rst
new file mode 100644
index 0000000..392b39f
--- /dev/null
+++ b/docs/testing/index.rst
@@ -0,0 +1 @@
+.. To be decided