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
  11 Important notes
  12 -----------------
  13 None to date.
  14
  15 Summary
  16 ------------
  17 The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
  18 that is capable of retrieving platform statistics and events, and relay them
  19 to Openstack Gnocchi and Aodh. The telemetry agent currently supported by barometer
  20 is collectd. Some additional collectd plugins and application were developed to add
  21 the following functionality:
  22
  23 Write/publishing Plugins:
  24
  25 - aodh plugin: A notification plugin that pushes events to Aodh, and
  26   creates/updates alarms appropriately.
  27 - SNMP agent plugin: A write plugin that will act as an AgentX subagent that
  28   receives and handles queries from SNMP master agent and returns the data
  29   collected by read plugins. The SNMP Agent plugin handles requests only for OIDs
  30   specified in configuration file. To handle SNMP queries the plugin gets data
  31   from collectd and translates requested values from collectd’s internal format
  32   to SNMP format. Supports SNMP: get, getnext and walk requests.
  33 - gnocchi plugin: A write plugin that pushes the retrieved stats to Gnocchi.
  34   It’s capable of pushing any stats read through collectd to Gnocchi, not just
  35   the DPDK stats.
  36
  37 Read Plugins:
  38
  39 - Intel RDT plugin: A read plugin that provides the last level cache
  40   utilization and memory bandwidth utilization.
  41 - virt plugin: A read plugin that uses virtualization API libvirt to gather
  42   statistics and events about virtualized guests on a system directly from the
  43   hypervisor, without a need to install collectd instance on the guest.
  44 - Open vSwitch stats plugin: A read plugin that retrieves interface stats from
  45   OVS.
  46
  47 In addition to the previous plugins from the Danube Release described below.
  48
  49 Release Data
  50 ---------------
  51
  52 +--------------------------------------+--------------------------------------+
  53 | **Project**                          | Euphrates/barometer/barometer@opnfv  |
  54 |                                      |                                      |
  55 +--------------------------------------+--------------------------------------+
  56 | **Repo/commit-ID**                   | barometer/opnfv-5.1.0                |
  57 |                                      |                                      |
  58 +--------------------------------------+--------------------------------------+
  59 | **Release designation**              | Euphrates 5.1.0                      |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Release date**                     | December 15th, 2017                  |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Purpose of the delivery**          | Official OPNFV release               |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68
  69 Version change
  70 ^^^^^^^^^^^^^^^^
  71
  72 Module version changes
  73 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  74
  75 - There have been no version changes.
  76
  77 Document version changes
  78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79
  80
  81 Reason for version
  82 ^^^^^^^^^^^^^^^^^^^^
  83 Feature additions
  84 ~~~~~~~~~~~~~~~~~~~~~~~
  85
  86 **JIRA BACK-LOG:**
  87
  88 +--------------------------------------+--------------------------------------+
  89 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  90 |                                      |                                      |
  91 +--------------------------------------+--------------------------------------+
  92 | BAROMETER-51                         | RDT Cache Feature                    |
  93 |                                      |                                      |
  94 +--------------------------------------+--------------------------------------+
  95 | BAROMETER-53                         | RAS Metrics and Events/              |
  96 |                                      | MCELOG Memory Errors                 |
  97 +--------------------------------------+--------------------------------------+
  98 | BAROMETER-55                         | Libvirt Metrics and Events           |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101 | BAROMETER-56                         | Openvswitch Mrtics and Events        |
 102 |                                      |                                      |
 103 +--------------------------------------+--------------------------------------+
 104 | BAROMETER-59                         | AODH plugin                          |
 105 |                                      |                                      |
 106 +--------------------------------------+--------------------------------------+
 107 | BAROMETER-60                         | Gnocchi Plugin                       |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110 | BAROMETER-58                         | SNMP Agent                           |
 111 |                                      |                                      |
 112 +--------------------------------------+--------------------------------------+
 113
 114 Bugs
 115 ~~~~
 116
 117 **JIRA TICKETS:**
 118
 119 +--------------------------------------+--------------------------------------+
 120 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 121 |                                      |                                      |
 122 +--------------------------------------+--------------------------------------+
 123 | BAROMETER-80                         | SNMP Agent testing with Intel RDT,   |
 124 |                                      | MCELOG, Hugepages, and OVS Stats not |
 125 |                                      | functional in the Apex image of OPNFV|
 126 |                                      | Release E                            |
 127 +--------------------------------------+--------------------------------------+
 128 |                                      |                                      |
 129 |                                      |                                      |
 130 +--------------------------------------+--------------------------------------+
 131
 132 Deliverables
 133 ----------------
 134
 135 Software deliverables
 136 ^^^^^^^^^^^^^^^^^^^^^^^
 137
 138 Features to Date
 139 ~~~~~~~~~~~~~~~~
 140
 141 Release B
 142 ~~~~~~~~~~
 143 The features implemented for OPNFV release B (as part of SFQM) in DPDK include:
 144
 145 * Callback API to enable TX/RX timestamping to measure latency through DPDK.
 146 * Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
 147   statistics for DPDK interfaces in addition to the overall aggregate statistics.
 148 * DPDK Keep Alive.
 149
 150 Release C
 151 ~~~~~~~~~~
 152 The features implemented for OPNFV release C (as part of SFQM) include:
 153
 154 * DPDK extended NIC stats API improvement; migrate from key value pairs to
 155   using id value pairs.
 156 * DPDK Keep Alive improvement, so that core status is exposed through a posix
 157   shared memory object.
 158 * collectd dpdkstat plugin that can retrieve DPDK interface statistics.
 159 * collectd ceilometer plugin that can publish any statistics collected by
 160   collectd to ceilometer.
 161 * Fuel plugin support for the collectd ceilometer plugin for OPNFV.
 162
 163 Release D
 164 ~~~~~~~~~
 165 The features implemented for OPNFV release D include:
 166
 167 * collectd hugepages plugin that can retrieves the number of available and free hugepages
 168   on a platform as well as what is available in terms of hugepages per socket.
 169 * collectd Open vSwitch Events plugin that can retrieves events from OVS.
 170 * collectd mcelog plugin that can use mcelog client protocol to check for memory Machine
 171   Check Exceptions and sends the stats for reported exceptions.
 172 * collectd ceilometer plugin that can publish any statistics collected by
 173   collectd to ceilometer.
 174
 175 Documentation deliverables
 176 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 177
 178 - Configuration guide
 179 - User guide
 180 - Release notes
 181 - Scenario documentation.
 182
 183 Known Limitations, Issues and Workarounds
 184 --------------------------------------------
 185
 186 System Limitations
 187 ^^^^^^^^^^^^^^^^^^^^
 188
 189 For Intel RDT plugin, compute node needs to support Intel RDT.
 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 Euphrates has undergone QA test runs with the following results:
 220
 221 +--------------------------------------+--------------------------------------+
 222 | **TEST-SUITE**                       | **Results:**                         |
 223 |                                      |                                      |
 224 +--------------------------------------+--------------------------------------+
 225 | barometercollectd                    |                                      |
 226 |                                      |                                      |
 227 |                                      |                                      |
 228 |                                      |                                      |
 229 |                                      |                                      |
 230 +--------------------------------------+--------------------------------------+
 231 |                                      |                                      |
 232 |                                      |                                      |
 233 |                                      |                                      |
 234 |                                      |                                      |
 235 |                                      |                                      |
 236 +--------------------------------------+--------------------------------------+
 237
 238 References
 239 ------------