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