docs/release/release-notes/release_notes.rst

   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.
   4
   5
   6 ==================================================
   7 Bottlenecks Release Notes for OPNFV Danube Release
   8 ==================================================
   9
  10 .. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
  11
  12
  13 Abstract
  14 ========
  15
  16 This document describes the release notes of Bottlenecks project.
  17
  18
  19 License
  20 =======
  21
  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/>.
  26
  27 The *Bottlenecks software* is opensource software, licensed under the terms of the
  28 Apache License, Version 2.0.
  29
  30
  31 Version History
  32 ===============
  33
  34 +----------------+--------------------+-----------------------------------+
  35 | *Date*         | *Version*          | *Comment*                         |
  36 |                |                    |                                   |
  37 +----------------+--------------------+-----------------------------------+
  38 | Sept 22nd, 2016|  1.0               | Bottlenecks Colorado release 1.0  |
  39 |                |                    |                                   |
  40 +----------------+--------------------+-----------------------------------+
  41 | Feb 17nd, 2017 |  1.1               | Bottlenecks Danube release 1.0    |
  42 |                |                    |                                   |
  43 +----------------+--------------------+-----------------------------------+
  44 | Mar 24nd, 2017 |  1.2               | Bottlenecks Danube release 1.0    |
  45 |                |                    |                                   |
  46 +----------------+--------------------+-----------------------------------+
  47 | Mar 24nd, 2017 |  1.3               | Bottlenecks Danube release 1.0    |
  48 |                |                    |                                   |
  49 +----------------+--------------------+-----------------------------------+
  50 | Apr 25th, 2017 |  1.4               | Bottlenecks Danube release 2.0    |
  51 |                |                    |                                   |
  52 +----------------+--------------------+-----------------------------------+
  53 | Jun 19th, 2017 |  1.5               | Bottlenecks Danube release 3.0    |
  54 |                |                    |                                   |
  55 +----------------+--------------------+-----------------------------------+
  56 | Sept 15th, 2017|  1.6               | Bottlenecks Euphrates release 5.0 |
  57 |                |                    |                                   |
  58 +----------------+--------------------+-----------------------------------+
  59 | Nov 15th, 2017 |  1.6.1             | Bottlenecks Euphrates release 5.1 |
  60 |                |                    |                                   |
  61 +----------------+--------------------+-----------------------------------+
  62 | Apr 10th, 2018 |  1.7               | Bottlenecks Fraser release 6.0    |
  63 |                |                    |                                   |
  64 +----------------+--------------------+-----------------------------------+
  65
  66 Summary
  67 =======
  68
  69 * Documentation generated with Sphinx
  70
  71   * Release
  72
  73     * Release Notes
  74
  75   * Testing
  76
  77     * User Guide
  78
  79     * Developer Guide
  80
  81 The *Bottlenecks software* is developed in the OPNFV community, by the
  82 Bottlenecks_ team.
  83
  84 Release Data
  85 ============
  86
  87 Fraser Release Data
  88 -----------------------
  89
  90 +--------------------------------------+--------------------------------+
  91 | **Project**                          | Bottlenecks                    |
  92 |                                      |                                |
  93 +--------------------------------------+--------------------------------+
  94 | **Repo/tag**                         | * Bottlenecks/6.0.0            |
  95 |                                      |                                |
  96 |                                      |                                |
  97 +--------------------------------------+--------------------------------+
  98 | **Bottlenecks Docker image tag**     | * 6.0.0                        |
  99 |                                      |                                |
 100 |                                      |                                |
 101 +--------------------------------------+--------------------------------+
 102 | **Release designation**              | * 6.0.0                        |
 103 |                                      |                                |
 104 |                                      |                                |
 105 +--------------------------------------+--------------------------------+
 106 | **Release date**                     | * Apr 10th 2018                |
 107 |                                      |                                |
 108 |                                      |                                |
 109 +--------------------------------------+--------------------------------+
 110 | **Purpose of the delivery**          | Fraser stable release          |
 111 |                                      |                                |
 112 +--------------------------------------+--------------------------------+
 113
 114 Euphrates Release Data
 115 -----------------------
 116
 117 +--------------------------------------+--------------------------------+
 118 | **Project**                          | Bottlenecks                    |
 119 |                                      |                                |
 120 +--------------------------------------+--------------------------------+
 121 | **Repo/tag**                         | * Bottlenecks/5.1.0            |
 122 |                                      |                                |
 123 |                                      |                                |
 124 +--------------------------------------+--------------------------------+
 125 | **Bottlenecks Docker image tag**     | * 5.1.0                        |
 126 |                                      |                                |
 127 |                                      |                                |
 128 +--------------------------------------+--------------------------------+
 129 | **Release designation**              | * 5.1.0                        |
 130 |                                      |                                |
 131 |                                      |                                |
 132 +--------------------------------------+--------------------------------+
 133 | **Release date**                     | * Nov 15th 2017                |
 134 |                                      |                                |
 135 |                                      |                                |
 136 +--------------------------------------+--------------------------------+
 137 | **Purpose of the delivery**          | Euphrates stable release       |
 138 |                                      |                                |
 139 +--------------------------------------+--------------------------------+
 140
 141 +--------------------------------------+--------------------------------+
 142 | **Project**                          | Bottlenecks                    |
 143 |                                      |                                |
 144 +--------------------------------------+--------------------------------+
 145 | **Repo/tag**                         | * Bottlenecks/5.0.0            |
 146 |                                      |                                |
 147 |                                      |                                |
 148 +--------------------------------------+--------------------------------+
 149 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 150 |                                      |                                |
 151 |                                      |                                |
 152 +--------------------------------------+--------------------------------+
 153 | **Release designation**              | * 5.0.0                        |
 154 |                                      |                                |
 155 |                                      |                                |
 156 +--------------------------------------+--------------------------------+
 157 | **Release date**                     | * Sept 15th 2017               |
 158 |                                      |                                |
 159 |                                      |                                |
 160 +--------------------------------------+--------------------------------+
 161 | **Purpose of the delivery**          | Euphrates stable release       |
 162 |                                      |                                |
 163 +--------------------------------------+--------------------------------+
 164
 165 Danube Release Data
 166 -----------------------
 167
 168 +--------------------------------------+--------------------------------+
 169 | **Project**                          | Bottlenecks                    |
 170 |                                      |                                |
 171 +--------------------------------------+--------------------------------+
 172 | **Repo/tag**                         | * Bottlenecks/danube.1.0       |
 173 |                                      | * Bottlenecks/danube.2.0       |
 174 |                                      |                                |
 175 +--------------------------------------+--------------------------------+
 176 | **Bottlenecks Docker image tag**     | * danube.1.0                   |
 177 |                                      | * danube.2.0                   |
 178 |                                      |                                |
 179 +--------------------------------------+--------------------------------+
 180 | **Release designation**              | * Danube 1.0                   |
 181 |                                      | * Danube 2.0                   |
 182 |                                      |                                |
 183 +--------------------------------------+--------------------------------+
 184 | **Release date**                     | * March 31st 2017              |
 185 |                                      | * May 1st 2017                 |
 186 |                                      |                                |
 187 +--------------------------------------+--------------------------------+
 188 | **Purpose of the delivery**          | Danube stable release          |
 189 |                                      |                                |
 190 +--------------------------------------+--------------------------------+
 191
 192 Colorado Release Data
 193 -----------------------
 194
 195 +--------------------------------------+--------------------------------+
 196 | **Project**                          | Bottlenecks                    |
 197 |                                      |                                |
 198 +--------------------------------------+--------------------------------+
 199 | **Repo/tag**                         | Bottlenecks/colorado.1.0       |
 200 |                                      |                                |
 201 +--------------------------------------+--------------------------------+
 202 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 203 |                                      |                                |
 204 +--------------------------------------+--------------------------------+
 205 | **Release designation**              | * Colorado 1.0                 |
 206 |                                      |                                |
 207 +--------------------------------------+--------------------------------+
 208 | **Release date**                     | * September 22 2016            |
 209 |                                      |                                |
 210 +--------------------------------------+--------------------------------+
 211 | **Purpose of the delivery**          | Colorado stable release        |
 212 |                                      |                                |
 213 +--------------------------------------+--------------------------------+
 214
 215 Bramaputra Release Data
 216 -----------------------
 217
 218 +--------------------------------------+--------------------------------+
 219 | **Project**                          | Bottlenecks                    |
 220 |                                      |                                |
 221 +--------------------------------------+--------------------------------+
 222 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
 223 |                                      |                                |
 224 +--------------------------------------+--------------------------------+
 225 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 226 |                                      |                                |
 227 +--------------------------------------+--------------------------------+
 228 | **Release designation**              | * Brahmaputra 1.0              |
 229 |                                      |                                |
 230 +--------------------------------------+--------------------------------+
 231 | **Release date**                     | * February 25 2016             |
 232 |                                      |                                |
 233 +--------------------------------------+--------------------------------+
 234 | **Purpose of the delivery**          | Brahmaputra stable release     |
 235 |                                      |                                |
 236 +--------------------------------------+--------------------------------+
 237
 238
 239 Release Deliverables
 240 ====================
 241
 242 Software Deliverables
 243 ---------------------
 244
 245 **Bottlenecks source code**
 246
 247 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 248
 249
 250 Documentatiion Deliverables
 251 ---------------------------
 252
 253 **Bottlenecks documentation <fraser>**
 254
 255 * Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 256 * User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
 257 * Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 258
 259 **Bottlenecks documentation <euphrates>**
 260
 261 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 262 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
 263 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 264
 265 **Bottlenecks documentation <danube>**
 266
 267 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 268 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
 269 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 270
 271 **Bottlenecks documentation <colorado.1.0>**
 272
 273 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
 274 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
 275 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
 276 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
 277 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
 278
 279 Reason for Fraser
 280 =================
 281
 282 * Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
 283 * Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
 284 * Introduction of multi-stack storage tests and Storperf storage test
 285 * Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks
 286
 287 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
 288
 289 Reason for Euphrates
 290 ====================
 291
 292 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
 293 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
 294 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
 295 * Testing framework is revised to support installer-agnostic testing.
 296
 297 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
 298 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
 299 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
 300
 301
 302 Known restrictions/issues
 303 =========================
 304
 305 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 306
 307   * Sometimes, Yardstick just waits for the test environment preparing.
 308   This cause troubles since it seams to get Yardstick into a loop to keep waiting.
 309   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
 311   * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
 312   It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
 313
 314 * 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.
 315
 316
 317 Test results
 318 ============
 319
 320 Test results are available in:
 321
 322  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 323
 324 The test results are reported to MongoDB. An example is given below.
 325
 326 ::
 327
 328     {
 329       "project_name": "bottlenecks",
 330       "scenario": "os-odl_l2-nofeature-ha",
 331       "stop_date": null,
 332       "trust_indicator": null,
 333       "case_name": "posca_stress_ping",
 334       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 335       "version": "master",
 336       "pod_name": "huawei-pod2",
 337       "criteria": "PASS",
 338       "installer": "compass",
 339       "_id": "58cf4d3e32c829000a1150a8",
 340       "start_date": "2017-3-9 4:33:04",
 341       "details": {}
 342     }
 343
 344 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 345  - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 346  - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 347
 348 Open JIRA tickets
 349 =================
 350
 351 +------------------+----------------------------------------------------+
 352 |   JIRA           |         Description                                |
 353 +==================+====================================================+
 354 | BOTTLENECK-147   | Investigting why calling remote docker client      |
 355 +------------------+----------------------------------------------------+
 356 | BOTTLENECK-207   | Yardstick loop when executing test cases           |
 357 +------------------+----------------------------------------------------+
 358 | BOTTLENECK-208   | Yardstick empty results when executing test cases  |
 359 +------------------+----------------------------------------------------+
 360 | BOTTLENECK-209   | Sleep process when executing test cases            |
 361 +------------------+----------------------------------------------------+
 362
 363
 364 Useful links
 365 ============
 366
 367  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 368
 369  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 370
 371  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 372
 373  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 374
 375  - Bottlenecks IRC chanel: #opnfv-bottlenecks