summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release_notes.rst
blob: f3bba8129c59eb4306635d4253ae46456c69a6e4 (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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Huawei Technologies Co.,Ltd and others.


===============================
OPNFV Bottlenecks Release Notes
===============================
.. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks


Abstract
========

This document describes the release notes of Bottlenecks project.


License
=======

OPNFV release notes for Bottlenecks Docs
are licensed under a Creative Commons Attribution 4.0 International License.
You should have received a copy of the license along with this.
If not, see <http://creativecommons.org/licenses/by/4.0/>.

The *Bottlenecks software* is opensource software, licensed under the terms of the
Apache License, Version 2.0.


Version History
===============

+----------------+--------------------+-----------------------------------+
| *Date*         | *Version*          | *Comment*                         |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Sept 22nd, 2016|  1.0               | Bottlenecks Colorado release 1.0  |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Feb 17nd, 2017 |  1.1               | Bottlenecks Danube release 1.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Mar 24nd, 2017 |  1.2               | Bottlenecks Danube release 1.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Mar 24nd, 2017 |  1.3               | Bottlenecks Danube release 1.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Apr 25th, 2017 |  1.4               | Bottlenecks Danube release 2.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Jun 19th, 2017 |  1.5               | Bottlenecks Danube release 3.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Sept 15th, 2017|  1.6               | Bottlenecks Euphrates release 5.0 |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Nov 15th, 2017 |  1.6.1             | Bottlenecks Euphrates release 5.1 |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Apr 10th, 2018 |  1.7               | Bottlenecks Fraser release 6.0    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| May 26th, 2018 |  1.7.1             | Bottlenecks Fraser release 6.1    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+
| Jul 2nd, 2018  |  1.7.2             | Bottlenecks Fraser release 6.2    |
|                |                    |                                   |
+----------------+--------------------+-----------------------------------+

Summary
=======

* Documentation generated with Sphinx

  * Release

    * Release Notes

  * Testing

    * User Guide

    * Developer Guide

The *Bottlenecks software* is developed in the OPNFV community, by the
Bottlenecks_ team.

Release Data
============

Fraser Release Data
-----------------------

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/6.2.0            |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * 6.2.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * 6.2.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * Jul 2nd 2018                 |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Fraser stable release          |
|                                      |                                |
+--------------------------------------+--------------------------------+

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/6.1.0            |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * 6.1.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * 6.1.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * May 26th 2018                |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Fraser stable release          |
|                                      |                                |
+--------------------------------------+--------------------------------+

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/6.0.0            |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * 6.0.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * 6.0.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * Apr 10th 2018                |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Fraser stable release          |
|                                      |                                |
+--------------------------------------+--------------------------------+

Euphrates Release Data
-----------------------

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/5.1.0            |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * 5.1.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * 5.1.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * Nov 15th 2017                |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Euphrates stable release       |
|                                      |                                |
+--------------------------------------+--------------------------------+

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/5.0.0            |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * 5.0.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * 5.0.0                        |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * Sept 15th 2017               |
|                                      |                                |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Euphrates stable release       |
|                                      |                                |
+--------------------------------------+--------------------------------+

Danube Release Data
-----------------------

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | * Bottlenecks/danube.1.0       |
|                                      | * Bottlenecks/danube.2.0       |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * danube.1.0                   |
|                                      | * danube.2.0                   |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * Danube 1.0                   |
|                                      | * Danube 2.0                   |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * March 31st 2017              |
|                                      | * May 1st 2017                 |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Danube stable release          |
|                                      |                                |
+--------------------------------------+--------------------------------+

Colorado Release Data
-----------------------

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | Bottlenecks/colorado.1.0       |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * colorado.1.0                 |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * Colorado 1.0                 |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * September 22 2016            |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Colorado stable release        |
|                                      |                                |
+--------------------------------------+--------------------------------+

Bramaputra Release Data
-----------------------

+--------------------------------------+--------------------------------+
| **Project**                          | Bottlenecks                    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release designation**              | * Brahmaputra 1.0              |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Release date**                     | * February 25 2016             |
|                                      |                                |
+--------------------------------------+--------------------------------+
| **Purpose of the delivery**          | Brahmaputra stable release     |
|                                      |                                |
+--------------------------------------+--------------------------------+


Release Deliverables
====================

Software Deliverables
---------------------

**Bottlenecks source code**

* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary


Documentatiion Deliverables
---------------------------

**Bottlenecks documentation <fraser>**

* Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
* User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
* Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html

**Bottlenecks documentation <euphrates>**

* Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
* User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
* Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html

**Bottlenecks documentation <danube>**

* Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
* User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
* Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html

**Bottlenecks documentation <colorado.1.0>**

* Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
* Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
* Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
* http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
* User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html

Reason for Fraser
=================

* Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
* Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
* Introduction of multi-stack storage tests and Storperf storage test
* Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks

These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.

Reason for Euphrates
====================

* Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
* Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
* Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
* Testing framework is revised to support installer-agnostic testing.

These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.


Known restrictions/issues
=========================

* Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.

  * Sometimes, Yardstick just waits for the test environment preparing.
  This cause troubles since it seams to get Yardstick into a loop to keep waiting.
  For OPNFV CI, this loop will be automatically stopped because of the default timeout setting. However, for local testing, user should stop this loop manually.

  * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
  It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.

* Sometimes, a process will go to sleep state. In this case when a running tool go to sleep state, we try to call it twice. Normally, it will response. This applies to the traffic generator, i.e., netperf.


Test results
============

Test results are available in:

 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/

The test results are reported to MongoDB. An example is given below.

::

    {
      "project_name": "bottlenecks",
      "scenario": "os-odl_l2-nofeature-ha",
      "stop_date": null,
      "trust_indicator": null,
      "case_name": "posca_stress_ping",
      "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
      "version": "master",
      "pod_name": "huawei-pod2",
      "criteria": "PASS",
      "installer": "compass",
      "_id": "58cf4d3e32c829000a1150a8",
      "start_date": "2017-3-9 4:33:04",
      "details": {}
    }

For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks

Open JIRA tickets
=================

+------------------+----------------------------------------------------+
|   JIRA           |         Description                                |
+==================+====================================================+
| BOTTLENECK-147   | Investigting why calling remote docker client      |
+------------------+----------------------------------------------------+
| BOTTLENECK-207   | Yardstick loop when executing test cases           |
+------------------+----------------------------------------------------+
| BOTTLENECK-208   | Yardstick empty results when executing test cases  |
+------------------+----------------------------------------------------+
| BOTTLENECK-209   | Sleep process when executing test cases            |
+------------------+----------------------------------------------------+


Useful links
============

 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks

 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/

 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/

 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks

 - Bottlenecks IRC chanel: #opnfv-bottlenecks