aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes
diff options
context:
space:
mode:
authorShobhi <shobhi.jain@intel.com>2017-08-25 09:45:48 +0100
committerEmma Foley <emma.l.foley@intel.com>2017-08-25 12:22:47 +0000
commit301fa862fd306e11c516894bc603c95ad9287085 (patch)
tree30bc71fc24d6a2f7555825d90af5ea4e018dfe1f /docs/release/release-notes
parent04e102b5abcff93b10eaa08a64249a7e0c709c34 (diff)
docs: updated release notes for E release.
* Updated summary section. * Updated backlog and testsuite section. Change-Id: I32ed41bbe4badf43b6277636c2c901fa45918fa9 Signed-off-by: Shobhi <shobhi.jain@intel.com>
Diffstat (limited to 'docs/release/release-notes')
-rw-r--r--docs/release/release-notes/release-notes.rst90
1 files changed, 32 insertions, 58 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 3837b1e7..73ba36d2 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -2,10 +2,10 @@
.. http://creativecommons.org/licenses/by/4.0
======================================================================
-OPNFV Barometer Release Notes
+Barometer Release Notes
======================================================================
-This document provides the release notes for Danube Release of Barometer.
+This document provides the release notes for Euphrates release of Barometer.
.. contents::
:depth: 3
@@ -19,7 +19,10 @@ Version history
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 2017-02-16 | 0.1.0 | Maryam Tahhan | First draft |
+| 2017-08-25 | 0.1.0 | Shobhi Jain | First draft |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| | | | |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
@@ -31,26 +34,26 @@ Summary
------------
The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
that is capabable of retrieving platform statistics and events, and relay them
-to Openstack ceilometer. The telemetry agent currently supported by Barometer
-is collectd. Some additional collectd plugin were developed to add functionality
-to retrieve statistics or events for:
+to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer
+is collectd. Some additional collectd plugins and application were developed to add
+functionality to retrieve statistics or events for:
+
+Write Plugins: aodh plugin, SNMP agent plugin, gnocchi plugin.
-- Hugepages
-- mcelog memory machine check exceptions
-- Open vSwitch events
-- Ceilometer
+Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plugin,
+Open vSwitch PMD stats application.
Release Data
---------------
+--------------------------------------+--------------------------------------+
-| **Project** | Danube/barometer/barometer@opnfv |
+| **Project** | Euphrates/barometer/barometer@opnfv |
| | |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID** | barometer/ |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Danube 1.0 |
+| **Release designation** | Euphrates 1.0 |
| | |
+--------------------------------------+--------------------------------------+
| **Release date** | |
@@ -70,7 +73,7 @@ Module version changes
Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- The Barometer@OPNFV installation guide version has changed from version 0.1 to to 0.2
+
Reason for version
^^^^^^^^^^^^^^^^^^^^
@@ -83,16 +86,7 @@ Feature additions
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| BAROMETER-38 | RAS Collectd Plugin |
-| | |
-+--------------------------------------+--------------------------------------+
-| BAROMETER-41 | OVS Collectd Plugin |
-| | |
-+--------------------------------------+--------------------------------------+
-| BAROMETER-43 | Fuel Plugin for D Release |
-| | |
-+--------------------------------------+--------------------------------------+
-| BAROMETER-48 | Hugepages Plugin for Collectd |
+| BAROMETER-78 | Barometer + Doctor Collaboration |
| | |
+--------------------------------------+--------------------------------------+
| | |
@@ -124,19 +118,6 @@ Software deliverables
Features to Date
~~~~~~~~~~~~~~~~
-This section provides a summary of the features implemented to date and their
-relevant upstream projects.
-
-.. Figure:: Features_to_date1.png
-
- Barometer features to date
-
-.. Figure:: Features_to_date2.png
-
- Barometer features to date cont.
-
-Please note the timeline denotes DPDK releases.
-
Release B
~~~~~~~~~~
The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
@@ -159,6 +140,18 @@ The features implemented for OPNFV release C (as part of SFQM) include:
collectd to ceilometer.
* Fuel plugin support for the collectd ceilometer plugin for OPNFV.
+Release D
+~~~~~~~~~
+The features implemented for OPNFV release D include:
+
+* collectd hugepages plugin that can retrieves the number of available and free hugepages
+ on a platform as well as what is available in terms of hugepages per socket.
+* collectd Open vSwitch Events plugin that can retrieves events from OVS.
+* collectd mcelog plugin that can use mcelog client protocol to check for memory Machine
+ Check Exceptions and sends the stats for reported exceptions.
+* collectd ceilometer plugin that can publish any statistics collected by
+ collectd to ceilometer.
+
Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -173,21 +166,7 @@ Known Limitations, Issues and Workarounds
System Limitations
^^^^^^^^^^^^^^^^^^^^
-Barometer has the same limiations as the fuel project in general as regards
-
-- **Max number of blades*
-
-- **Min number of blades**
-
-- **Storage**
-
-- **Max number of networks**
-
-- **L3Agent**
-
-The only additional limitiation is the following:
-
-**Telemetry:** Ceilometer service needs to be configured for compute nodes.
+For Intel RDT plugin, compute node needs to support Intel RDT.
Known issues
^^^^^^^^^^^^^^^
@@ -217,13 +196,13 @@ Workarounds
Test Result
---------------
-Barometer@OPNFV Danube RC1 has undergone QA test runs with the following results:
+Barometer@OPNFV Euphrates has undergone QA test runs with the following results:
+--------------------------------------+--------------------------------------+
| **TEST-SUITE** | **Results:** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
+| barometercollectd | |
| | |
| | |
| | |
@@ -238,8 +217,3 @@ Barometer@OPNFV Danube RC1 has undergone QA test runs with the following results
References
------------
-
-For more information on the OPNFV Danube release, please see:
-
-http://opnfv.org/danube
-