docs/release/release-notes/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4 ======================================================================
   5 OPNFV Barometer Release Notes
   6 ======================================================================
   7
   8 This document provides the release notes for Danube Release of Barometer.
   9
  10 .. contents::
  11    :depth: 3
  12    :local:
  13
  14
  15 Version history
  16 ------------------
  17
  18 +--------------------+--------------------+--------------------+--------------------+
  19 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  20 |                    |                    |                    |                    |
  21 +--------------------+--------------------+--------------------+--------------------+
  22 | 2017-02-16         | 0.1.0              | Maryam Tahhan      | First draft        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 | 2017-05-23         | 0.1.1              | Maryam Tahhan      | Danube final       |
  26 |                    |                    |                    | documentation      |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 Important notes
  29 -----------------
  30 None to date.
  31
  32 Summary
  33 ------------
  34 The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
  35 that is capabable of retrieving platform statistics and events, and relay them
  36 to Openstack ceilometer. The telemetry agent currently supported by Barometer
  37 is collectd. Some additional collectd plugin were developed to add functionality
  38 to retrieve statistics or events for:
  39
  40 - Hugepages
  41 - mcelog memory machine check exceptions
  42 - Open vSwitch events
  43 - Ceilometer
  44
  45 Release Data
  46 ---------------
  47
  48 +--------------------------------------+--------------------------------------+
  49 | **Project**                          | Danube/barometer/barometer@opnfv     |
  50 |                                      |                                      |
  51 +--------------------------------------+--------------------------------------+
  52 | **Repo/commit-ID**                   | barometer/                           |
  53 |                                      |                                      |
  54 +--------------------------------------+--------------------------------------+
  55 | **Release designation**              | Danube 3.0                           |
  56 |                                      |                                      |
  57 +--------------------------------------+--------------------------------------+
  58 | **Release date**                     |  08 June 2017                        |
  59 |                                      |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Purpose of the delivery**          | Official OPNFV release               |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64
  65 Version change
  66 ^^^^^^^^^^^^^^^^
  67
  68 Module version changes
  69 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  70
  71 - There have been no version changes.
  72
  73 Document version changes
  74 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  75 - The Barometer@OPNFV installation guide version has changed from version 0.1 to to 0.2
  76
  77 Reason for version
  78 ^^^^^^^^^^^^^^^^^^^^
  79 Feature additions
  80 ~~~~~~~~~~~~~~~~~~~~~~~
  81
  82 **JIRA BACK-LOG:**
  83
  84 +--------------------------------------+--------------------------------------+
  85 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88 | BAROMETER-38                         | RAS Collectd Plugin                  |
  89 |                                      |                                      |
  90 +--------------------------------------+--------------------------------------+
  91 | BAROMETER-41                         | OVS Collectd Plugin                  |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | BAROMETER-43                         | Fuel Plugin for D Release            |
  95 |                                      |                                      |
  96 +--------------------------------------+--------------------------------------+
  97 | BAROMETER-48                         | Hugepages Plugin for Collectd        |
  98 |                                      |                                      |
  99 +--------------------------------------+--------------------------------------+
 100
 101 Bug corrections
 102 ~~~~~~~~~~~~~~~~~~~~~
 103
 104 **JIRA TICKETS:**
 105
 106 +--------------------------------------+--------------------------------------+
 107 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110 |                                      |                                      |
 111 |                                      |                                      |
 112 +--------------------------------------+--------------------------------------+
 113 |                                      |                                      |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116
 117 Deliverables
 118 ----------------
 119
 120 Software deliverables
 121 ^^^^^^^^^^^^^^^^^^^^^^^
 122
 123 Features to Date
 124 ~~~~~~~~~~~~~~~~
 125
 126 This section provides a summary of the features implemented to date and their
 127 relevant upstream projects.
 128
 129 .. Figure:: Features_to_date1.png
 130
 131    Barometer features to date
 132
 133 .. Figure:: Features_to_date2.png
 134
 135    Barometer features to date cont.
 136
 137 Please note the timeline denotes DPDK releases.
 138
 139 Release B
 140 ~~~~~~~~~~
 141 The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
 142
 143 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
 144 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
 145   statistics for DPDK interfaces in addition to the overall aggregate statistics.
 146 * DPDK Keep Alive.
 147
 148 Release C
 149 ~~~~~~~~~~
 150 The features implemented for OPNFV release C (as part of SFQM) include:
 151
 152 * DPDK extended NIC stats API improvement; migrate from key value pairs to
 153   using id value pairs.
 154 * DPDK Keep Alive improvement, so that core status is exposed through a posix
 155   shared memory object.
 156 * collectd dpdkstat plugin that can retrieve DPDK interface statistics.
 157 * collectd ceilometer plugin that can publish any statistics collected by
 158   collectd to ceilometer.
 159 * Fuel plugin support for the collectd ceilometer plugin for OPNFV.
 160
 161 Documentation deliverables
 162 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 163
 164 - Configuration guide
 165 - User guide
 166 - Release notes
 167 - Scenario documentation.
 168
 169 Known Limitations, Issues and Workarounds
 170 --------------------------------------------
 171
 172 System Limitations
 173 ^^^^^^^^^^^^^^^^^^^^
 174
 175 Barometer has the same limiations as the fuel project in general as regards
 176
 177 - **Max number of blades**
 178
 179 - **Min number of blades**
 180
 181 - **Storage**
 182
 183 - **Max number of networks**
 184
 185 - **L3Agent**
 186
 187 The only additional limitiation is the following:
 188
 189 **Telemetry:** Ceilometer service needs to be configured for compute nodes.
 190
 191 Known issues
 192 ^^^^^^^^^^^^^^^
 193
 194 No known issues to date.
 195
 196 **JIRA TICKETS:**
 197
 198 +--------------------------------------+--------------------------------------+
 199 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 200 |                                      |                                      |
 201 +--------------------------------------+--------------------------------------+
 202 |                                      |                                      |
 203 |                                      |                                      |
 204 |                                      |                                      |
 205 +--------------------------------------+--------------------------------------+
 206 |                                      |                                      |
 207 |                                      |                                      |
 208 |                                      |                                      |
 209 +--------------------------------------+--------------------------------------+
 210
 211 Workarounds
 212 ^^^^^^^^^^^^^^^^^
 213
 214 - None to date.
 215
 216 Test Result
 217 ---------------
 218
 219 Barometer@OPNFV Danube RC1 has undergone QA test runs with the following results:
 220
 221 +--------------------------------------+--------------------------------------+
 222 | **TEST-SUITE**                       | **Results:**                         |
 223 |                                      |                                      |
 224 +--------------------------------------+--------------------------------------+
 225 | BarometerCollectd                    | `Build results`_                     |
 226 |                                      |                                      |
 227 |                                      |                                      |
 228 |                                      |                                      |
 229 |                                      |                                      |
 230 +--------------------------------------+--------------------------------------+
 231
 232 References
 233 ------------
 234
 235 For more information on the OPNFV Danube release, please see:
 236
 237 http://opnfv.org/danube
 238
 239 .. _Build results: https://build.opnfv.org/ci/view/fuel/job/fuel-os-nosdn-kvm_ovs_dpdk_bar-ha-baremetal-daily-danube/