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-51                         | RDT Cache Feature                    |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | BAROMETER-53                         | RAS Metrics and Events/              |
  93 |                                      | MCELOG Memory Errors                 |
  94 +--------------------------------------+--------------------------------------+
  95 | BAROMETER-55                         | Libvirt Metrics and Events           |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98 | BAROMETER-56                         | Openvswitch Mrtics and Events        |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101 | BAROMETER-59                         | AODH plugin                          |
 102 |                                      |                                      |
 103 +--------------------------------------+--------------------------------------+
 104 | BAROMETER-60                         | Gnocchi Plugin                       |
 105 |                                      |                                      |
 106 +--------------------------------------+--------------------------------------+
 107 | BAROMETER-58                         | SNMP Agent                           |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110
 111 Bug corrections
 112 ~~~~~~~~~~~~~~~~~~~~~
 113
 114 **JIRA TICKETS:**
 115
 116 +--------------------------------------+--------------------------------------+
 117 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120 |                                      |                                      |
 121 |                                      |                                      |
 122 +--------------------------------------+--------------------------------------+
 123 |                                      |                                      |
 124 |                                      |                                      |
 125 +--------------------------------------+--------------------------------------+
 126
 127 Deliverables
 128 ----------------
 129
 130 Software deliverables
 131 ^^^^^^^^^^^^^^^^^^^^^^^
 132
 133 Features to Date
 134 ~~~~~~~~~~~~~~~~
 135
 136 Release B
 137 ~~~~~~~~~~
 138 The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
 139
 140 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
 141 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
 142   statistics for DPDK interfaces in addition to the overall aggregate statistics.
 143 * DPDK Keep Alive.
 144
 145 Release C
 146 ~~~~~~~~~~
 147 The features implemented for OPNFV release C (as part of SFQM) include:
 148
 149 * DPDK extended NIC stats API improvement; migrate from key value pairs to
 150   using id value pairs.
 151 * DPDK Keep Alive improvement, so that core status is exposed through a posix
 152   shared memory object.
 153 * collectd dpdkstat plugin that can retrieve DPDK interface statistics.
 154 * collectd ceilometer plugin that can publish any statistics collected by
 155   collectd to ceilometer.
 156 * Fuel plugin support for the collectd ceilometer plugin for OPNFV.
 157
 158 Release D
 159 ~~~~~~~~~
 160 The features implemented for OPNFV release D include:
 161
 162 * collectd hugepages plugin that can retrieves the number of available and free hugepages
 163   on a platform as well as what is available in terms of hugepages per socket.
 164 * collectd Open vSwitch Events plugin that can retrieves events from OVS.
 165 * collectd mcelog plugin that can use mcelog client protocol to check for memory Machine
 166   Check Exceptions and sends the stats for reported exceptions.
 167 * collectd ceilometer plugin that can publish any statistics collected by
 168   collectd to ceilometer.
 169
 170 Documentation deliverables
 171 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 172
 173 - Configuration guide
 174 - User guide
 175 - Release notes
 176 - Scenario documentation.
 177
 178 Known Limitations, Issues and Workarounds
 179 --------------------------------------------
 180
 181 System Limitations
 182 ^^^^^^^^^^^^^^^^^^^^
 183
 184 For Intel RDT plugin, compute node needs to support Intel RDT.
 185
 186 Known issues
 187 ^^^^^^^^^^^^^^^
 188
 189 No known issues to date.
 190
 191 **JIRA TICKETS:**
 192
 193 +--------------------------------------+--------------------------------------+
 194 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 195 |                                      |                                      |
 196 +--------------------------------------+--------------------------------------+
 197 |                                      |                                      |
 198 |                                      |                                      |
 199 |                                      |                                      |
 200 +--------------------------------------+--------------------------------------+
 201 |                                      |                                      |
 202 |                                      |                                      |
 203 |                                      |                                      |
 204 +--------------------------------------+--------------------------------------+
 205
 206 Workarounds
 207 ^^^^^^^^^^^^^^^^^
 208
 209 - None to date.
 210
 211 Test Result
 212 ---------------
 213
 214 Barometer@OPNFV Euphrates has undergone QA test runs with the following results:
 215
 216 +--------------------------------------+--------------------------------------+
 217 | **TEST-SUITE**                       | **Results:**                         |
 218 |                                      |                                      |
 219 +--------------------------------------+--------------------------------------+
 220 | barometercollectd                    |                                      |
 221 |                                      |                                      |
 222 |                                      |                                      |
 223 |                                      |                                      |
 224 |                                      |                                      |
 225 +--------------------------------------+--------------------------------------+
 226 |                                      |                                      |
 227 |                                      |                                      |
 228 |                                      |                                      |
 229 |                                      |                                      |
 230 |                                      |                                      |
 231 +--------------------------------------+--------------------------------------+
 232
 233 References
 234 ------------