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 Bottlenecks Release Notes for OPNFV Danube Release
8 ==================================================
10 .. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
16 This document describes the release notes of Bottlenecks project.
22 OPNFV release notes for Bottlenecks Docs
23 are licensed under a Creative Commons Attribution 4.0 International License.
24 You should have received a copy of the license along with this.
25 If not, see <http://creativecommons.org/licenses/by/4.0/>.
27 The *Bottlenecks software* is opensource software, licensed under the terms of the
28 Apache License, Version 2.0.
34 +----------------+--------------------+-----------------------------------+
35 | *Date* | *Version* | *Comment* |
37 +----------------+--------------------+-----------------------------------+
38 | Sept 22nd, 2016| 1.0 | Bottlenecks Colorado release 1.0 |
40 +----------------+--------------------+-----------------------------------+
41 | Feb 17nd, 2017 | 1.1 | Bottlenecks Danube release 1.0 |
43 +----------------+--------------------+-----------------------------------+
44 | Mar 24nd, 2017 | 1.2 | Bottlenecks Danube release 1.0 |
46 +----------------+--------------------+-----------------------------------+
47 | Mar 24nd, 2017 | 1.3 | Bottlenecks Danube release 1.0 |
49 +----------------+--------------------+-----------------------------------+
50 | Apr 25th, 2017 | 1.4 | Bottlenecks Danube release 2.0 |
52 +----------------+--------------------+-----------------------------------+
53 | Jun 19th, 2017 | 1.5 | Bottlenecks Danube release 3.0 |
55 +----------------+--------------------+-----------------------------------+
56 | Sept 15th, 2017| 1.6 | Bottlenecks Euphrates release 5.0 |
58 +----------------+--------------------+-----------------------------------+
63 * Documentation generated with Sphinx
75 The *Bottlenecks software* is developed in the OPNFV community, by the
81 Euphrates Release Data
82 -----------------------
84 +--------------------------------------+--------------------------------+
85 | **Project** | Bottlenecks |
87 +--------------------------------------+--------------------------------+
88 | **Repo/tag** | * Bottlenecks/5.0.0 |
91 +--------------------------------------+--------------------------------+
92 | **Bottlenecks Docker image tag** | * 5.0.0 |
95 +--------------------------------------+--------------------------------+
96 | **Release designation** | * 5.0.0 |
99 +--------------------------------------+--------------------------------+
100 | **Release date** | * Sept 15th 2017 |
103 +--------------------------------------+--------------------------------+
104 | **Purpose of the delivery** | Euphrates stable release |
106 +--------------------------------------+--------------------------------+
109 -----------------------
111 +--------------------------------------+--------------------------------+
112 | **Project** | Bottlenecks |
114 +--------------------------------------+--------------------------------+
115 | **Repo/tag** | * Bottlenecks/danube.1.0 |
116 | | * Bottlenecks/danube.2.0 |
118 +--------------------------------------+--------------------------------+
119 | **Bottlenecks Docker image tag** | * danube.1.0 |
122 +--------------------------------------+--------------------------------+
123 | **Release designation** | * Danube 1.0 |
126 +--------------------------------------+--------------------------------+
127 | **Release date** | * March 31st 2017 |
130 +--------------------------------------+--------------------------------+
131 | **Purpose of the delivery** | Danube stable release |
133 +--------------------------------------+--------------------------------+
135 Colorado Release Data
136 -----------------------
138 +--------------------------------------+--------------------------------+
139 | **Project** | Bottlenecks |
141 +--------------------------------------+--------------------------------+
142 | **Repo/tag** | Bottlenecks/colorado.1.0 |
144 +--------------------------------------+--------------------------------+
145 | **Bottlenecks Docker image tag** | * colorado.1.0 |
147 +--------------------------------------+--------------------------------+
148 | **Release designation** | * Colorado 1.0 |
150 +--------------------------------------+--------------------------------+
151 | **Release date** | * September 22 2016 |
153 +--------------------------------------+--------------------------------+
154 | **Purpose of the delivery** | Colorado stable release |
156 +--------------------------------------+--------------------------------+
158 Bramaputra Release Data
159 -----------------------
161 +--------------------------------------+--------------------------------+
162 | **Project** | Bottlenecks |
164 +--------------------------------------+--------------------------------+
165 | **Repo/tag** | Bottlenecks/brahmaputra.1.0 |
167 +--------------------------------------+--------------------------------+
168 | **Bottlenecks Docker image tag** | * brahmaputra.1.0 |
170 +--------------------------------------+--------------------------------+
171 | **Release designation** | * Brahmaputra 1.0 |
173 +--------------------------------------+--------------------------------+
174 | **Release date** | * February 25 2016 |
176 +--------------------------------------+--------------------------------+
177 | **Purpose of the delivery** | Brahmaputra stable release |
179 +--------------------------------------+--------------------------------+
185 Software Deliverables
186 ---------------------
188 **Bottlenecks source code**
190 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
193 Documentatiion Deliverables
194 ---------------------------
196 **Bottlenecks documentation <euphrates>**
198 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
199 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
200 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
202 **Bottlenecks documentation <danube>**
204 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
205 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
206 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
208 **Bottlenecks documentation <colorado.1.0>**
210 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
211 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
212 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
213 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
214 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
219 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
220 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
221 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
222 * Testing framework is revised to support installer-agnostic testing.
224 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
225 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
226 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
229 Known restrictions/issues
230 =========================
232 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
234 * Sometimes, Yardstick just waits for the test environment preparing.
235 This cause troubles since it seams to get Yardstick into a loop to keep waiting.
236 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.
238 * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
239 It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
241 * 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.
247 Test results are available in:
249 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
251 The test results are reported to MongoDB. An example is given below.
256 "project_name": "bottlenecks",
257 "scenario": "os-odl_l2-nofeature-ha",
259 "trust_indicator": null,
260 "case_name": "posca_stress_ping",
261 "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
263 "pod_name": "huawei-pod2",
265 "installer": "compass",
266 "_id": "58cf4d3e32c829000a1150a8",
267 "start_date": "2017-3-9 4:33:04",
271 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
272 - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
273 - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
278 +------------------+----------------------------------------------------+
279 | JIRA | Description |
280 +==================+====================================================+
281 | BOTTLENECK-147 | Investigting why calling remote docker client |
282 +------------------+----------------------------------------------------+
283 | BOTTLENECK-207 | Yardstick loop when executing test cases |
284 +------------------+----------------------------------------------------+
285 | BOTTLENECK-208 | Yardstick empty results when executing test cases |
286 +------------------+----------------------------------------------------+
287 | BOTTLENECK-209 | Sleep process when executing test cases |
288 +------------------+----------------------------------------------------+
294 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
296 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
298 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
300 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
302 - Bottlenecks IRC chanel: #opnfv-bottlenecks