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 +----------------+--------------------+-----------------------------------+
68 * Documentation generated with Sphinx
80 The *Bottlenecks software* is developed in the OPNFV community, by the
87 -----------------------
89 +--------------------------------------+--------------------------------+
90 | **Project** | Bottlenecks |
92 +--------------------------------------+--------------------------------+
93 | **Repo/tag** | * Bottlenecks/6.0.0 |
96 +--------------------------------------+--------------------------------+
97 | **Bottlenecks Docker image tag** | * 6.0.0 |
100 +--------------------------------------+--------------------------------+
101 | **Release designation** | * 6.0.0 |
104 +--------------------------------------+--------------------------------+
105 | **Release date** | * Apr 10th 2018 |
108 +--------------------------------------+--------------------------------+
109 | **Purpose of the delivery** | Fraser stable release |
111 +--------------------------------------+--------------------------------+
113 Euphrates Release Data
114 -----------------------
116 +--------------------------------------+--------------------------------+
117 | **Project** | Bottlenecks |
119 +--------------------------------------+--------------------------------+
120 | **Repo/tag** | * Bottlenecks/5.1.0 |
123 +--------------------------------------+--------------------------------+
124 | **Bottlenecks Docker image tag** | * 5.1.0 |
127 +--------------------------------------+--------------------------------+
128 | **Release designation** | * 5.1.0 |
131 +--------------------------------------+--------------------------------+
132 | **Release date** | * Nov 15th 2017 |
135 +--------------------------------------+--------------------------------+
136 | **Purpose of the delivery** | Euphrates stable release |
138 +--------------------------------------+--------------------------------+
140 +--------------------------------------+--------------------------------+
141 | **Project** | Bottlenecks |
143 +--------------------------------------+--------------------------------+
144 | **Repo/tag** | * Bottlenecks/5.0.0 |
147 +--------------------------------------+--------------------------------+
148 | **Bottlenecks Docker image tag** | * 5.0.0 |
151 +--------------------------------------+--------------------------------+
152 | **Release designation** | * 5.0.0 |
155 +--------------------------------------+--------------------------------+
156 | **Release date** | * Sept 15th 2017 |
159 +--------------------------------------+--------------------------------+
160 | **Purpose of the delivery** | Euphrates stable release |
162 +--------------------------------------+--------------------------------+
165 -----------------------
167 +--------------------------------------+--------------------------------+
168 | **Project** | Bottlenecks |
170 +--------------------------------------+--------------------------------+
171 | **Repo/tag** | * Bottlenecks/danube.1.0 |
172 | | * Bottlenecks/danube.2.0 |
174 +--------------------------------------+--------------------------------+
175 | **Bottlenecks Docker image tag** | * danube.1.0 |
178 +--------------------------------------+--------------------------------+
179 | **Release designation** | * Danube 1.0 |
182 +--------------------------------------+--------------------------------+
183 | **Release date** | * March 31st 2017 |
186 +--------------------------------------+--------------------------------+
187 | **Purpose of the delivery** | Danube stable release |
189 +--------------------------------------+--------------------------------+
191 Colorado Release Data
192 -----------------------
194 +--------------------------------------+--------------------------------+
195 | **Project** | Bottlenecks |
197 +--------------------------------------+--------------------------------+
198 | **Repo/tag** | Bottlenecks/colorado.1.0 |
200 +--------------------------------------+--------------------------------+
201 | **Bottlenecks Docker image tag** | * colorado.1.0 |
203 +--------------------------------------+--------------------------------+
204 | **Release designation** | * Colorado 1.0 |
206 +--------------------------------------+--------------------------------+
207 | **Release date** | * September 22 2016 |
209 +--------------------------------------+--------------------------------+
210 | **Purpose of the delivery** | Colorado stable release |
212 +--------------------------------------+--------------------------------+
214 Bramaputra Release Data
215 -----------------------
217 +--------------------------------------+--------------------------------+
218 | **Project** | Bottlenecks |
220 +--------------------------------------+--------------------------------+
221 | **Repo/tag** | Bottlenecks/brahmaputra.1.0 |
223 +--------------------------------------+--------------------------------+
224 | **Bottlenecks Docker image tag** | * brahmaputra.1.0 |
226 +--------------------------------------+--------------------------------+
227 | **Release designation** | * Brahmaputra 1.0 |
229 +--------------------------------------+--------------------------------+
230 | **Release date** | * February 25 2016 |
232 +--------------------------------------+--------------------------------+
233 | **Purpose of the delivery** | Brahmaputra stable release |
235 +--------------------------------------+--------------------------------+
241 Software Deliverables
242 ---------------------
244 **Bottlenecks source code**
246 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
249 Documentatiion Deliverables
250 ---------------------------
252 **Bottlenecks documentation <fraser>**
254 * Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
255 * User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
256 * Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html
258 **Bottlenecks documentation <euphrates>**
260 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
261 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
262 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
264 **Bottlenecks documentation <danube>**
266 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
267 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
268 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
270 **Bottlenecks documentation <colorado.1.0>**
272 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
273 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
274 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
275 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
276 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
281 * Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
282 * Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
283 * Introduction of multi-stack storage tests and Storperf storage test
284 * Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks
286 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
291 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
292 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
293 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
294 * Testing framework is revised to support installer-agnostic testing.
296 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
297 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
298 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
301 Known restrictions/issues
302 =========================
304 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
306 * Sometimes, Yardstick just waits for the test environment preparing.
307 This cause troubles since it seams to get Yardstick into a loop to keep waiting.
308 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.
310 * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
311 It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
313 * 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.
319 Test results are available in:
321 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
323 The test results are reported to MongoDB. An example is given below.
328 "project_name": "bottlenecks",
329 "scenario": "os-odl_l2-nofeature-ha",
331 "trust_indicator": null,
332 "case_name": "posca_stress_ping",
333 "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
335 "pod_name": "huawei-pod2",
337 "installer": "compass",
338 "_id": "58cf4d3e32c829000a1150a8",
339 "start_date": "2017-3-9 4:33:04",
343 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
344 - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
345 - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
350 +------------------+----------------------------------------------------+
351 | JIRA | Description |
352 +==================+====================================================+
353 | BOTTLENECK-147 | Investigting why calling remote docker client |
354 +------------------+----------------------------------------------------+
355 | BOTTLENECK-207 | Yardstick loop when executing test cases |
356 +------------------+----------------------------------------------------+
357 | BOTTLENECK-208 | Yardstick empty results when executing test cases |
358 +------------------+----------------------------------------------------+
359 | BOTTLENECK-209 | Sleep process when executing test cases |
360 +------------------+----------------------------------------------------+
366 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
368 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
370 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
372 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
374 - Bottlenecks IRC chanel: #opnfv-bottlenecks