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 +----------------+--------------------+-----------------------------------+
74 * Documentation generated with Sphinx
86 The *Bottlenecks software* is developed in the OPNFV community, by the
93 -----------------------
95 +--------------------------------------+--------------------------------+
96 | **Project** | Bottlenecks |
98 +--------------------------------------+--------------------------------+
99 | **Repo/tag** | * Bottlenecks/6.2.0 |
102 +--------------------------------------+--------------------------------+
103 | **Bottlenecks Docker image tag** | * 6.2.0 |
106 +--------------------------------------+--------------------------------+
107 | **Release designation** | * 6.2.0 |
110 +--------------------------------------+--------------------------------+
111 | **Release date** | * Jul 2nd 2018 |
114 +--------------------------------------+--------------------------------+
115 | **Purpose of the delivery** | Fraser stable release |
117 +--------------------------------------+--------------------------------+
119 +--------------------------------------+--------------------------------+
120 | **Project** | Bottlenecks |
122 +--------------------------------------+--------------------------------+
123 | **Repo/tag** | * Bottlenecks/6.1.0 |
126 +--------------------------------------+--------------------------------+
127 | **Bottlenecks Docker image tag** | * 6.1.0 |
130 +--------------------------------------+--------------------------------+
131 | **Release designation** | * 6.1.0 |
134 +--------------------------------------+--------------------------------+
135 | **Release date** | * May 26th 2018 |
138 +--------------------------------------+--------------------------------+
139 | **Purpose of the delivery** | Fraser stable release |
141 +--------------------------------------+--------------------------------+
143 +--------------------------------------+--------------------------------+
144 | **Project** | Bottlenecks |
146 +--------------------------------------+--------------------------------+
147 | **Repo/tag** | * Bottlenecks/6.0.0 |
150 +--------------------------------------+--------------------------------+
151 | **Bottlenecks Docker image tag** | * 6.0.0 |
154 +--------------------------------------+--------------------------------+
155 | **Release designation** | * 6.0.0 |
158 +--------------------------------------+--------------------------------+
159 | **Release date** | * Apr 10th 2018 |
162 +--------------------------------------+--------------------------------+
163 | **Purpose of the delivery** | Fraser stable release |
165 +--------------------------------------+--------------------------------+
167 Euphrates Release Data
168 -----------------------
170 +--------------------------------------+--------------------------------+
171 | **Project** | Bottlenecks |
173 +--------------------------------------+--------------------------------+
174 | **Repo/tag** | * Bottlenecks/5.1.0 |
177 +--------------------------------------+--------------------------------+
178 | **Bottlenecks Docker image tag** | * 5.1.0 |
181 +--------------------------------------+--------------------------------+
182 | **Release designation** | * 5.1.0 |
185 +--------------------------------------+--------------------------------+
186 | **Release date** | * Nov 15th 2017 |
189 +--------------------------------------+--------------------------------+
190 | **Purpose of the delivery** | Euphrates stable release |
192 +--------------------------------------+--------------------------------+
194 +--------------------------------------+--------------------------------+
195 | **Project** | Bottlenecks |
197 +--------------------------------------+--------------------------------+
198 | **Repo/tag** | * Bottlenecks/5.0.0 |
201 +--------------------------------------+--------------------------------+
202 | **Bottlenecks Docker image tag** | * 5.0.0 |
205 +--------------------------------------+--------------------------------+
206 | **Release designation** | * 5.0.0 |
209 +--------------------------------------+--------------------------------+
210 | **Release date** | * Sept 15th 2017 |
213 +--------------------------------------+--------------------------------+
214 | **Purpose of the delivery** | Euphrates stable release |
216 +--------------------------------------+--------------------------------+
219 -----------------------
221 +--------------------------------------+--------------------------------+
222 | **Project** | Bottlenecks |
224 +--------------------------------------+--------------------------------+
225 | **Repo/tag** | * Bottlenecks/danube.1.0 |
226 | | * Bottlenecks/danube.2.0 |
228 +--------------------------------------+--------------------------------+
229 | **Bottlenecks Docker image tag** | * danube.1.0 |
232 +--------------------------------------+--------------------------------+
233 | **Release designation** | * Danube 1.0 |
236 +--------------------------------------+--------------------------------+
237 | **Release date** | * March 31st 2017 |
240 +--------------------------------------+--------------------------------+
241 | **Purpose of the delivery** | Danube stable release |
243 +--------------------------------------+--------------------------------+
245 Colorado Release Data
246 -----------------------
248 +--------------------------------------+--------------------------------+
249 | **Project** | Bottlenecks |
251 +--------------------------------------+--------------------------------+
252 | **Repo/tag** | Bottlenecks/colorado.1.0 |
254 +--------------------------------------+--------------------------------+
255 | **Bottlenecks Docker image tag** | * colorado.1.0 |
257 +--------------------------------------+--------------------------------+
258 | **Release designation** | * Colorado 1.0 |
260 +--------------------------------------+--------------------------------+
261 | **Release date** | * September 22 2016 |
263 +--------------------------------------+--------------------------------+
264 | **Purpose of the delivery** | Colorado stable release |
266 +--------------------------------------+--------------------------------+
268 Bramaputra Release Data
269 -----------------------
271 +--------------------------------------+--------------------------------+
272 | **Project** | Bottlenecks |
274 +--------------------------------------+--------------------------------+
275 | **Repo/tag** | Bottlenecks/brahmaputra.1.0 |
277 +--------------------------------------+--------------------------------+
278 | **Bottlenecks Docker image tag** | * brahmaputra.1.0 |
280 +--------------------------------------+--------------------------------+
281 | **Release designation** | * Brahmaputra 1.0 |
283 +--------------------------------------+--------------------------------+
284 | **Release date** | * February 25 2016 |
286 +--------------------------------------+--------------------------------+
287 | **Purpose of the delivery** | Brahmaputra stable release |
289 +--------------------------------------+--------------------------------+
295 Software Deliverables
296 ---------------------
298 **Bottlenecks source code**
300 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
303 Documentatiion Deliverables
304 ---------------------------
306 **Bottlenecks documentation <fraser>**
308 * Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
309 * User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
310 * Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html
312 **Bottlenecks documentation <euphrates>**
314 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
315 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
316 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
318 **Bottlenecks documentation <danube>**
320 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
321 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
322 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
324 **Bottlenecks documentation <colorado.1.0>**
326 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
327 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
328 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
329 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
330 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
335 * Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
336 * Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
337 * Introduction of multi-stack storage tests and Storperf storage test
338 * Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks
340 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
345 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
346 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
347 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
348 * Testing framework is revised to support installer-agnostic testing.
350 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
351 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
352 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
355 Known restrictions/issues
356 =========================
358 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
360 * Sometimes, Yardstick just waits for the test environment preparing.
361 This cause troubles since it seams to get Yardstick into a loop to keep waiting.
362 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.
364 * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
365 It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
367 * 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.
373 Test results are available in:
375 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
377 The test results are reported to MongoDB. An example is given below.
382 "project_name": "bottlenecks",
383 "scenario": "os-odl_l2-nofeature-ha",
385 "trust_indicator": null,
386 "case_name": "posca_stress_ping",
387 "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
389 "pod_name": "huawei-pod2",
391 "installer": "compass",
392 "_id": "58cf4d3e32c829000a1150a8",
393 "start_date": "2017-3-9 4:33:04",
397 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
398 - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
399 - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
404 +------------------+----------------------------------------------------+
405 | JIRA | Description |
406 +==================+====================================================+
407 | BOTTLENECK-147 | Investigting why calling remote docker client |
408 +------------------+----------------------------------------------------+
409 | BOTTLENECK-207 | Yardstick loop when executing test cases |
410 +------------------+----------------------------------------------------+
411 | BOTTLENECK-208 | Yardstick empty results when executing test cases |
412 +------------------+----------------------------------------------------+
413 | BOTTLENECK-209 | Sleep process when executing test cases |
414 +------------------+----------------------------------------------------+
420 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
422 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
424 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
426 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
428 - Bottlenecks IRC chanel: #opnfv-bottlenecks