1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Huawei Technologies Co.,Ltd and others.
6 ===============================
7 OPNFV Bottlenecks Release Notes
8 ===============================
9 .. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
15 This document describes the release notes of Bottlenecks project.
21 OPNFV release notes for Bottlenecks Docs
22 are licensed under a Creative Commons Attribution 4.0 International License.
23 You should have received a copy of the license along with this.
24 If not, see <http://creativecommons.org/licenses/by/4.0/>.
26 The *Bottlenecks software* is opensource software, licensed under the terms of the
27 Apache License, Version 2.0.
33 +----------------+--------------------+-----------------------------------+
34 | *Date* | *Version* | *Comment* |
36 +----------------+--------------------+-----------------------------------+
37 | Sept 22nd, 2016| 1.0 | Bottlenecks Colorado release 1.0 |
39 +----------------+--------------------+-----------------------------------+
40 | Feb 17nd, 2017 | 1.1 | Bottlenecks Danube release 1.0 |
42 +----------------+--------------------+-----------------------------------+
43 | Mar 24nd, 2017 | 1.2 | Bottlenecks Danube release 1.0 |
45 +----------------+--------------------+-----------------------------------+
46 | Mar 24nd, 2017 | 1.3 | Bottlenecks Danube release 1.0 |
48 +----------------+--------------------+-----------------------------------+
49 | Apr 25th, 2017 | 1.4 | Bottlenecks Danube release 2.0 |
51 +----------------+--------------------+-----------------------------------+
52 | Jun 19th, 2017 | 1.5 | Bottlenecks Danube release 3.0 |
54 +----------------+--------------------+-----------------------------------+
55 | Sept 15th, 2017| 1.6 | Bottlenecks Euphrates release 5.0 |
57 +----------------+--------------------+-----------------------------------+
58 | Nov 15th, 2017 | 1.6.1 | Bottlenecks Euphrates release 5.1 |
60 +----------------+--------------------+-----------------------------------+
61 | Apr 10th, 2018 | 1.7 | Bottlenecks Fraser release 6.0 |
63 +----------------+--------------------+-----------------------------------+
64 | May 26th, 2018 | 1.7.1 | Bottlenecks Fraser release 6.1 |
66 +----------------+--------------------+-----------------------------------+
67 | Jul 2nd, 2018 | 1.7.2 | Bottlenecks Fraser release 6.2 |
69 +----------------+--------------------+-----------------------------------+
70 | Dec 10th, 2018 | 1.8.0 | Bottlenecks Gambia release 7.0 |
72 +----------------+--------------------+-----------------------------------+
73 | May 10th, 2019 | 1.9.0 | Bottlenecks Hunter release 8.0 |
75 +----------------+--------------------+-----------------------------------+
80 * Documentation generated with Sphinx
92 The *Bottlenecks software* is developed in the OPNFV community, by the
99 -----------------------
101 +--------------------------------------+--------------------------------+
102 | **Project** | Bottlenecks |
104 +--------------------------------------+--------------------------------+
105 | **Repo/tag** | * Bottlenecks/8.0.0 |
108 +--------------------------------------+--------------------------------+
109 | **Bottlenecks Docker image tag** | * 8.0.0 |
112 +--------------------------------------+--------------------------------+
113 | **Release designation** | * 8.0.0 |
116 +--------------------------------------+--------------------------------+
117 | **Release date** | * May 10th 2019 |
120 +--------------------------------------+--------------------------------+
121 | **Purpose of the delivery** | Hunter stable release |
123 +--------------------------------------+--------------------------------+
126 -----------------------
128 +--------------------------------------+--------------------------------+
129 | **Project** | Bottlenecks |
131 +--------------------------------------+--------------------------------+
132 | **Repo/tag** | * Bottlenecks/6.2.0 |
135 +--------------------------------------+--------------------------------+
136 | **Bottlenecks Docker image tag** | * 6.2.0 |
139 +--------------------------------------+--------------------------------+
140 | **Release designation** | * 6.2.0 |
143 +--------------------------------------+--------------------------------+
144 | **Release date** | * Jul 2nd 2018 |
147 +--------------------------------------+--------------------------------+
148 | **Purpose of the delivery** | Fraser stable release |
150 +--------------------------------------+--------------------------------+
152 +--------------------------------------+--------------------------------+
153 | **Project** | Bottlenecks |
155 +--------------------------------------+--------------------------------+
156 | **Repo/tag** | * Bottlenecks/6.1.0 |
159 +--------------------------------------+--------------------------------+
160 | **Bottlenecks Docker image tag** | * 6.1.0 |
163 +--------------------------------------+--------------------------------+
164 | **Release designation** | * 6.1.0 |
167 +--------------------------------------+--------------------------------+
168 | **Release date** | * May 26th 2018 |
171 +--------------------------------------+--------------------------------+
172 | **Purpose of the delivery** | Fraser stable release |
174 +--------------------------------------+--------------------------------+
176 +--------------------------------------+--------------------------------+
177 | **Project** | Bottlenecks |
179 +--------------------------------------+--------------------------------+
180 | **Repo/tag** | * Bottlenecks/6.0.0 |
183 +--------------------------------------+--------------------------------+
184 | **Bottlenecks Docker image tag** | * 6.0.0 |
187 +--------------------------------------+--------------------------------+
188 | **Release designation** | * 6.0.0 |
191 +--------------------------------------+--------------------------------+
192 | **Release date** | * Apr 10th 2018 |
195 +--------------------------------------+--------------------------------+
196 | **Purpose of the delivery** | Fraser stable release |
198 +--------------------------------------+--------------------------------+
200 Euphrates Release Data
201 -----------------------
203 +--------------------------------------+--------------------------------+
204 | **Project** | Bottlenecks |
206 +--------------------------------------+--------------------------------+
207 | **Repo/tag** | * Bottlenecks/5.1.0 |
210 +--------------------------------------+--------------------------------+
211 | **Bottlenecks Docker image tag** | * 5.1.0 |
214 +--------------------------------------+--------------------------------+
215 | **Release designation** | * 5.1.0 |
218 +--------------------------------------+--------------------------------+
219 | **Release date** | * Nov 15th 2017 |
222 +--------------------------------------+--------------------------------+
223 | **Purpose of the delivery** | Euphrates stable release |
225 +--------------------------------------+--------------------------------+
227 +--------------------------------------+--------------------------------+
228 | **Project** | Bottlenecks |
230 +--------------------------------------+--------------------------------+
231 | **Repo/tag** | * Bottlenecks/5.0.0 |
234 +--------------------------------------+--------------------------------+
235 | **Bottlenecks Docker image tag** | * 5.0.0 |
238 +--------------------------------------+--------------------------------+
239 | **Release designation** | * 5.0.0 |
242 +--------------------------------------+--------------------------------+
243 | **Release date** | * Sept 15th 2017 |
246 +--------------------------------------+--------------------------------+
247 | **Purpose of the delivery** | Euphrates stable release |
249 +--------------------------------------+--------------------------------+
252 -----------------------
254 +--------------------------------------+--------------------------------+
255 | **Project** | Bottlenecks |
257 +--------------------------------------+--------------------------------+
258 | **Repo/tag** | * Bottlenecks/danube.1.0 |
259 | | * Bottlenecks/danube.2.0 |
261 +--------------------------------------+--------------------------------+
262 | **Bottlenecks Docker image tag** | * danube.1.0 |
265 +--------------------------------------+--------------------------------+
266 | **Release designation** | * Danube 1.0 |
269 +--------------------------------------+--------------------------------+
270 | **Release date** | * March 31st 2017 |
273 +--------------------------------------+--------------------------------+
274 | **Purpose of the delivery** | Danube stable release |
276 +--------------------------------------+--------------------------------+
278 Colorado Release Data
279 -----------------------
281 +--------------------------------------+--------------------------------+
282 | **Project** | Bottlenecks |
284 +--------------------------------------+--------------------------------+
285 | **Repo/tag** | Bottlenecks/colorado.1.0 |
287 +--------------------------------------+--------------------------------+
288 | **Bottlenecks Docker image tag** | * colorado.1.0 |
290 +--------------------------------------+--------------------------------+
291 | **Release designation** | * Colorado 1.0 |
293 +--------------------------------------+--------------------------------+
294 | **Release date** | * September 22 2016 |
296 +--------------------------------------+--------------------------------+
297 | **Purpose of the delivery** | Colorado stable release |
299 +--------------------------------------+--------------------------------+
301 Bramaputra Release Data
302 -----------------------
304 +--------------------------------------+--------------------------------+
305 | **Project** | Bottlenecks |
307 +--------------------------------------+--------------------------------+
308 | **Repo/tag** | Bottlenecks/brahmaputra.1.0 |
310 +--------------------------------------+--------------------------------+
311 | **Bottlenecks Docker image tag** | * brahmaputra.1.0 |
313 +--------------------------------------+--------------------------------+
314 | **Release designation** | * Brahmaputra 1.0 |
316 +--------------------------------------+--------------------------------+
317 | **Release date** | * February 25 2016 |
319 +--------------------------------------+--------------------------------+
320 | **Purpose of the delivery** | Brahmaputra stable release |
322 +--------------------------------------+--------------------------------+
328 Software Deliverables
329 ---------------------
331 **Bottlenecks source code**
333 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
336 Documentatiion Deliverables
337 ---------------------------
339 **Bottlenecks documentation <hunter>**
341 * Release Notes: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/release/release-notes/release_notes.html
342 * User Guide: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/testing/user/userguide/index.html
343 * Developer Guide: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/testing/developer/devguide/index.html
345 **Bottlenecks documentation <fraser>**
347 * Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
348 * User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
349 * Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html
351 **Bottlenecks documentation <euphrates>**
353 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
354 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
355 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
357 **Bottlenecks documentation <danube>**
359 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
360 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
361 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
363 **Bottlenecks documentation <colorado.1.0>**
365 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
366 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
367 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
368 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
369 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
374 * Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
375 * Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
376 * Introduction of multi-stack storage tests and Storperf storage test
377 * Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks
379 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
384 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
385 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
386 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
387 * Testing framework is revised to support installer-agnostic testing.
389 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
390 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
391 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
394 Known restrictions/issues
395 =========================
397 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
399 * Sometimes, Yardstick just waits for the test environment preparing.
400 This cause troubles since it seams to get Yardstick into a loop to keep waiting.
401 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.
403 * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
404 It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
406 * 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.
412 Test results are available in:
414 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
416 The test results are reported to MongoDB. An example is given below.
421 "project_name": "bottlenecks",
422 "scenario": "os-odl_l2-nofeature-ha",
424 "trust_indicator": null,
425 "case_name": "posca_stress_ping",
426 "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
428 "pod_name": "huawei-pod2",
430 "installer": "compass",
431 "_id": "58cf4d3e32c829000a1150a8",
432 "start_date": "2017-3-9 4:33:04",
436 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
437 - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
438 - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
443 +------------------+----------------------------------------------------+
444 | JIRA | Description |
445 +==================+====================================================+
446 | BOTTLENECK-147 | Investigting why calling remote docker client |
447 +------------------+----------------------------------------------------+
448 | BOTTLENECK-207 | Yardstick loop when executing test cases |
449 +------------------+----------------------------------------------------+
450 | BOTTLENECK-208 | Yardstick empty results when executing test cases |
451 +------------------+----------------------------------------------------+
452 | BOTTLENECK-209 | Sleep process when executing test cases |
453 +------------------+----------------------------------------------------+
459 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
461 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
463 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
465 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
467 - Bottlenecks IRC chanel: #opnfv-bottlenecks