aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
blob: 3837b1e78cbee183ae2c569f1329b37f48f01808 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

======================================================================
OPNFV Barometer Release Notes
======================================================================

This document provides the release notes for Danube Release of Barometer.

.. contents::
   :depth: 3
   :local:


Version history
------------------

+--------------------+--------------------+--------------------+--------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2017-02-16         | 0.1.0              | Maryam Tahhan      | First draft        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+

Important notes
-----------------
None to date.

Summary
------------
The Barometer@OPNFV project adds a platform telemetry agent to compute nodes
that is capabable of retrieving platform statistics and events, and relay them
to Openstack ceilometer. The telemetry agent currently supported by Barometer
is collectd. Some additional collectd plugin were developed to add functionality
to retrieve statistics or events for:

- Hugepages
- mcelog memory machine check exceptions
- Open vSwitch events
- Ceilometer

Release Data
---------------

+--------------------------------------+--------------------------------------+
| **Project**                          | Danube/barometer/barometer@opnfv     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID**                   | barometer/                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube 1.0                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Official OPNFV release               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
^^^^^^^^^^^^^^^^

Module version changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- There have been no version changes.

Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- The Barometer@OPNFV installation guide version has changed from version 0.1 to to 0.2

Reason for version
^^^^^^^^^^^^^^^^^^^^
Feature additions
~~~~~~~~~~~~~~~~~~~~~~~

**JIRA BACK-LOG:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| BAROMETER-38                         | RAS Collectd Plugin                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| BAROMETER-41                         | OVS Collectd Plugin                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| BAROMETER-43                         | Fuel Plugin for D Release            |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| BAROMETER-48                         | Hugepages Plugin for Collectd        |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Bug corrections
~~~~~~~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Deliverables
----------------

Software deliverables
^^^^^^^^^^^^^^^^^^^^^^^

Features to Date
~~~~~~~~~~~~~~~~

This section provides a summary of the features implemented to date and their
relevant upstream projects.

.. Figure:: Features_to_date1.png

   Barometer features to date

.. Figure:: Features_to_date2.png

   Barometer features to date cont.

Please note the timeline denotes DPDK releases.

Release B
~~~~~~~~~~
The features implemented for OPNFV release B (as part of SFQM) in DPDK include:

* Callback API to enable TX/RX timestamping to measure latency through DPDK.
* Extended NIC statistics API for 1GB, 10GB and 40GB NICs to expose detailed
  statistics for DPDK interfaces in addition to the overall aggregate statistics.
* DPDK Keep Alive.

Release C
~~~~~~~~~~
The features implemented for OPNFV release C (as part of SFQM) include:

* DPDK extended NIC stats API improvement; migrate from key value pairs to
  using id value pairs.
* DPDK Keep Alive improvement, so that core status is exposed through a posix
  shared memory object.
* collectd dpdkstat plugin that can retrieve DPDK interface statistics.
* collectd ceilometer plugin that can publish any statistics collected by
  collectd to ceilometer.
* Fuel plugin support for the collectd ceilometer plugin for OPNFV.

Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- Configuration guide
- User guide
- Release notes
- Scenario documentation.

Known Limitations, Issues and Workarounds
--------------------------------------------

System Limitations
^^^^^^^^^^^^^^^^^^^^

Barometer has the same limiations as the fuel project in general as regards

- **Max number of blades*

- **Min number of blades**

- **Storage**

- **Max number of networks**

- **L3Agent**

The only additional limitiation is the following:

**Telemetry:** Ceilometer service needs to be configured for compute nodes.

Known issues
^^^^^^^^^^^^^^^

No known issues to date.

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Workarounds
^^^^^^^^^^^^^^^^^

- None to date.

Test Result
---------------

Barometer@OPNFV Danube RC1 has undergone QA test runs with the following results:

+--------------------------------------+--------------------------------------+
| **TEST-SUITE**                       | **Results:**                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

References
------------

For more information on the OPNFV Danube release, please see:

http://opnfv.org/danube