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 Barometer Release Notes
   6 ======================================================================
   7
   8 This document provides the release notes for Euphrates 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-08-25         | 0.1.0              | Shobhi Jain        | First draft        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 |                    |                    |                    |                    |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28
  29 Important notes
  30 -----------------
  31 None to date.
  32
  33 Summary
  34 ------------
  35 The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
  36 that is capabable of retrieving platform statistics and events, and relay them
  37 to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer
  38 is collectd. Some additional collectd plugins and application were developed to add
  39 functionality to retrieve statistics or events for:
  40
  41 Write Plugins: aodh plugin, SNMP agent plugin, gnocchi plugin.
  42
  43 Read Plugins/application: Intel RDT plugin, virt plugin, Open vSwitch stats plugin,
  44 Open vSwitch PMD stats application.
  45
  46 Release Data
  47 ---------------
  48
  49 +--------------------------------------+--------------------------------------+
  50 | **Project**                          | Euphrates/barometer/barometer@opnfv  |
  51 |                                      |                                      |
  52 +--------------------------------------+--------------------------------------+
  53 | **Repo/commit-ID**                   | barometer/                           |
  54 |                                      |                                      |
  55 +--------------------------------------+--------------------------------------+
  56 | **Release designation**              | Euphrates 1.0                        |
  57 |                                      |                                      |
  58 +--------------------------------------+--------------------------------------+
  59 | **Release date**                     |                                      |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Purpose of the delivery**          | Official OPNFV release               |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65
  66 Version change
  67 ^^^^^^^^^^^^^^^^
  68
  69 Module version changes
  70 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71
  72 - There have been no version changes.
  73
  74 Document version changes
  75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  77
  78 Reason for version
  79 ^^^^^^^^^^^^^^^^^^^^
  80 Feature additions
  81 ~~~~~~~~~~~~~~~~~~~~~~~
  82
  83 **JIRA BACK-LOG:**
  84
  85 +--------------------------------------+--------------------------------------+
  86 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  87 |                                      |                                      |
  88 +--------------------------------------+--------------------------------------+
  89 | BAROMETER-78                         | Barometer + Doctor Collaboration     |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 |                                      |                                      |
  93 |                                      |                                      |
  94 +--------------------------------------+--------------------------------------+
  95
  96 Bug corrections
  97 ~~~~~~~~~~~~~~~~~~~~~
  98
  99 **JIRA TICKETS:**
 100
 101 +--------------------------------------+--------------------------------------+
 102 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 103 |                                      |                                      |
 104 +--------------------------------------+--------------------------------------+
 105 |                                      |                                      |
 106 |                                      |                                      |
 107 +--------------------------------------+--------------------------------------+
 108 |                                      |                                      |
 109 |                                      |                                      |
 110 +--------------------------------------+--------------------------------------+
 111
 112 Deliverables
 113 ----------------
 114
 115 Software deliverables
 116 ^^^^^^^^^^^^^^^^^^^^^^^
 117
 118 Features to Date
 119 ~~~~~~~~~~~~~~~~
 120
 121 Release B
 122 ~~~~~~~~~~
 123 The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
 124
 125 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
 126 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
 127   statistics for DPDK interfaces in addition to the overall aggregate statistics.
 128 * DPDK Keep Alive.
 129
 130 Release C
 131 ~~~~~~~~~~
 132 The features implemented for OPNFV release C (as part of SFQM) include:
 133
 134 * DPDK extended NIC stats API improvement; migrate from key value pairs to
 135   using id value pairs.
 136 * DPDK Keep Alive improvement, so that core status is exposed through a posix
 137   shared memory object.
 138 * collectd dpdkstat plugin that can retrieve DPDK interface statistics.
 139 * collectd ceilometer plugin that can publish any statistics collected by
 140   collectd to ceilometer.
 141 * Fuel plugin support for the collectd ceilometer plugin for OPNFV.
 142
 143 Release D
 144 ~~~~~~~~~
 145 The features implemented for OPNFV release D include:
 146
 147 * collectd hugepages plugin that can retrieves the number of available and free hugepages
 148   on a platform as well as what is available in terms of hugepages per socket.
 149 * collectd Open vSwitch Events plugin that can retrieves events from OVS.
 150 * collectd mcelog plugin that can use mcelog client protocol to check for memory Machine
 151   Check Exceptions and sends the stats for reported exceptions.
 152 * collectd ceilometer plugin that can publish any statistics collected by
 153   collectd to ceilometer.
 154
 155 Documentation deliverables
 156 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 157
 158 - Configuration guide
 159 - User guide
 160 - Release notes
 161 - Scenario documentation.
 162
 163 Known Limitations, Issues and Workarounds
 164 --------------------------------------------
 165
 166 System Limitations
 167 ^^^^^^^^^^^^^^^^^^^^
 168
 169 For Intel RDT plugin, compute node needs to support Intel RDT.
 170
 171 Known issues
 172 ^^^^^^^^^^^^^^^
 173
 174 No known issues to date.
 175
 176 **JIRA TICKETS:**
 177
 178 +--------------------------------------+--------------------------------------+
 179 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 180 |                                      |                                      |
 181 +--------------------------------------+--------------------------------------+
 182 |                                      |                                      |
 183 |                                      |                                      |
 184 |                                      |                                      |
 185 +--------------------------------------+--------------------------------------+
 186 |                                      |                                      |
 187 |                                      |                                      |
 188 |                                      |                                      |
 189 +--------------------------------------+--------------------------------------+
 190
 191 Workarounds
 192 ^^^^^^^^^^^^^^^^^
 193
 194 - None to date.
 195
 196 Test Result
 197 ---------------
 198
 199 Barometer@OPNFV Euphrates has undergone QA test runs with the following results:
 200
 201 +--------------------------------------+--------------------------------------+
 202 | **TEST-SUITE**                       | **Results:**                         |
 203 |                                      |                                      |
 204 +--------------------------------------+--------------------------------------+
 205 | barometercollectd                    |                                      |
 206 |                                      |                                      |
 207 |                                      |                                      |
 208 |                                      |                                      |
 209 |                                      |                                      |
 210 +--------------------------------------+--------------------------------------+
 211 |                                      |                                      |
 212 |                                      |                                      |
 213 |                                      |                                      |
 214 |                                      |                                      |
 215 |                                      |                                      |
 216 +--------------------------------------+--------------------------------------+
 217
 218 References
 219 ------------