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 OPNFV Bottlenecks Release Notes
   8 ===============================
   9 .. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks
  10
  11
  12 Abstract
  13 ========
  14
  15 This document describes the release notes of Bottlenecks project.
  16
  17
  18 License
  19 =======
  20
  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/>.
  25
  26 The *Bottlenecks software* is opensource software, licensed under the terms of the
  27 Apache License, Version 2.0.
  28
  29
  30 Version History
  31 ===============
  32
  33 +----------------+--------------------+-----------------------------------+
  34 | *Date*         | *Version*          | *Comment*                         |
  35 |                |                    |                                   |
  36 +----------------+--------------------+-----------------------------------+
  37 | Sept 22nd, 2016|  1.0               | Bottlenecks Colorado release 1.0  |
  38 |                |                    |                                   |
  39 +----------------+--------------------+-----------------------------------+
  40 | Feb 17nd, 2017 |  1.1               | Bottlenecks Danube release 1.0    |
  41 |                |                    |                                   |
  42 +----------------+--------------------+-----------------------------------+
  43 | Mar 24nd, 2017 |  1.2               | Bottlenecks Danube release 1.0    |
  44 |                |                    |                                   |
  45 +----------------+--------------------+-----------------------------------+
  46 | Mar 24nd, 2017 |  1.3               | Bottlenecks Danube release 1.0    |
  47 |                |                    |                                   |
  48 +----------------+--------------------+-----------------------------------+
  49 | Apr 25th, 2017 |  1.4               | Bottlenecks Danube release 2.0    |
  50 |                |                    |                                   |
  51 +----------------+--------------------+-----------------------------------+
  52 | Jun 19th, 2017 |  1.5               | Bottlenecks Danube release 3.0    |
  53 |                |                    |                                   |
  54 +----------------+--------------------+-----------------------------------+
  55 | Sept 15th, 2017|  1.6               | Bottlenecks Euphrates release 5.0 |
  56 |                |                    |                                   |
  57 +----------------+--------------------+-----------------------------------+
  58 | Nov 15th, 2017 |  1.6.1             | Bottlenecks Euphrates release 5.1 |
  59 |                |                    |                                   |
  60 +----------------+--------------------+-----------------------------------+
  61 | Apr 10th, 2018 |  1.7               | Bottlenecks Fraser release 6.0    |
  62 |                |                    |                                   |
  63 +----------------+--------------------+-----------------------------------+
  64 | May 26th, 2018 |  1.7.1             | Bottlenecks Fraser release 6.1    |
  65 |                |                    |                                   |
  66 +----------------+--------------------+-----------------------------------+
  67 | Jul 2nd, 2018  |  1.7.2             | Bottlenecks Fraser release 6.2    |
  68 |                |                    |                                   |
  69 +----------------+--------------------+-----------------------------------+
  70
  71 Summary
  72 =======
  73
  74 * Documentation generated with Sphinx
  75
  76   * Release
  77
  78     * Release Notes
  79
  80   * Testing
  81
  82     * User Guide
  83
  84     * Developer Guide
  85
  86 The *Bottlenecks software* is developed in the OPNFV community, by the
  87 Bottlenecks_ team.
  88
  89 Release Data
  90 ============
  91
  92 Fraser Release Data
  93 -----------------------
  94
  95 +--------------------------------------+--------------------------------+
  96 | **Project**                          | Bottlenecks                    |
  97 |                                      |                                |
  98 +--------------------------------------+--------------------------------+
  99 | **Repo/tag**                         | * Bottlenecks/6.2.0            |
 100 |                                      |                                |
 101 |                                      |                                |
 102 +--------------------------------------+--------------------------------+
 103 | **Bottlenecks Docker image tag**     | * 6.2.0                        |
 104 |                                      |                                |
 105 |                                      |                                |
 106 +--------------------------------------+--------------------------------+
 107 | **Release designation**              | * 6.2.0                        |
 108 |                                      |                                |
 109 |                                      |                                |
 110 +--------------------------------------+--------------------------------+
 111 | **Release date**                     | * Jul 2nd 2018                 |
 112 |                                      |                                |
 113 |                                      |                                |
 114 +--------------------------------------+--------------------------------+
 115 | **Purpose of the delivery**          | Fraser stable release          |
 116 |                                      |                                |
 117 +--------------------------------------+--------------------------------+
 118
 119 +--------------------------------------+--------------------------------+
 120 | **Project**                          | Bottlenecks                    |
 121 |                                      |                                |
 122 +--------------------------------------+--------------------------------+
 123 | **Repo/tag**                         | * Bottlenecks/6.1.0            |
 124 |                                      |                                |
 125 |                                      |                                |
 126 +--------------------------------------+--------------------------------+
 127 | **Bottlenecks Docker image tag**     | * 6.1.0                        |
 128 |                                      |                                |
 129 |                                      |                                |
 130 +--------------------------------------+--------------------------------+
 131 | **Release designation**              | * 6.1.0                        |
 132 |                                      |                                |
 133 |                                      |                                |
 134 +--------------------------------------+--------------------------------+
 135 | **Release date**                     | * May 26th 2018                |
 136 |                                      |                                |
 137 |                                      |                                |
 138 +--------------------------------------+--------------------------------+
 139 | **Purpose of the delivery**          | Fraser stable release          |
 140 |                                      |                                |
 141 +--------------------------------------+--------------------------------+
 142
 143 +--------------------------------------+--------------------------------+
 144 | **Project**                          | Bottlenecks                    |
 145 |                                      |                                |
 146 +--------------------------------------+--------------------------------+
 147 | **Repo/tag**                         | * Bottlenecks/6.0.0            |
 148 |                                      |                                |
 149 |                                      |                                |
 150 +--------------------------------------+--------------------------------+
 151 | **Bottlenecks Docker image tag**     | * 6.0.0                        |
 152 |                                      |                                |
 153 |                                      |                                |
 154 +--------------------------------------+--------------------------------+
 155 | **Release designation**              | * 6.0.0                        |
 156 |                                      |                                |
 157 |                                      |                                |
 158 +--------------------------------------+--------------------------------+
 159 | **Release date**                     | * Apr 10th 2018                |
 160 |                                      |                                |
 161 |                                      |                                |
 162 +--------------------------------------+--------------------------------+
 163 | **Purpose of the delivery**          | Fraser stable release          |
 164 |                                      |                                |
 165 +--------------------------------------+--------------------------------+
 166
 167 Euphrates Release Data
 168 -----------------------
 169
 170 +--------------------------------------+--------------------------------+
 171 | **Project**                          | Bottlenecks                    |
 172 |                                      |                                |
 173 +--------------------------------------+--------------------------------+
 174 | **Repo/tag**                         | * Bottlenecks/5.1.0            |
 175 |                                      |                                |
 176 |                                      |                                |
 177 +--------------------------------------+--------------------------------+
 178 | **Bottlenecks Docker image tag**     | * 5.1.0                        |
 179 |                                      |                                |
 180 |                                      |                                |
 181 +--------------------------------------+--------------------------------+
 182 | **Release designation**              | * 5.1.0                        |
 183 |                                      |                                |
 184 |                                      |                                |
 185 +--------------------------------------+--------------------------------+
 186 | **Release date**                     | * Nov 15th 2017                |
 187 |                                      |                                |
 188 |                                      |                                |
 189 +--------------------------------------+--------------------------------+
 190 | **Purpose of the delivery**          | Euphrates stable release       |
 191 |                                      |                                |
 192 +--------------------------------------+--------------------------------+
 193
 194 +--------------------------------------+--------------------------------+
 195 | **Project**                          | Bottlenecks                    |
 196 |                                      |                                |
 197 +--------------------------------------+--------------------------------+
 198 | **Repo/tag**                         | * Bottlenecks/5.0.0            |
 199 |                                      |                                |
 200 |                                      |                                |
 201 +--------------------------------------+--------------------------------+
 202 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 203 |                                      |                                |
 204 |                                      |                                |
 205 +--------------------------------------+--------------------------------+
 206 | **Release designation**              | * 5.0.0                        |
 207 |                                      |                                |
 208 |                                      |                                |
 209 +--------------------------------------+--------------------------------+
 210 | **Release date**                     | * Sept 15th 2017               |
 211 |                                      |                                |
 212 |                                      |                                |
 213 +--------------------------------------+--------------------------------+
 214 | **Purpose of the delivery**          | Euphrates stable release       |
 215 |                                      |                                |
 216 +--------------------------------------+--------------------------------+
 217
 218 Danube Release Data
 219 -----------------------
 220
 221 +--------------------------------------+--------------------------------+
 222 | **Project**                          | Bottlenecks                    |
 223 |                                      |                                |
 224 +--------------------------------------+--------------------------------+
 225 | **Repo/tag**                         | * Bottlenecks/danube.1.0       |
 226 |                                      | * Bottlenecks/danube.2.0       |
 227 |                                      |                                |
 228 +--------------------------------------+--------------------------------+
 229 | **Bottlenecks Docker image tag**     | * danube.1.0                   |
 230 |                                      | * danube.2.0                   |
 231 |                                      |                                |
 232 +--------------------------------------+--------------------------------+
 233 | **Release designation**              | * Danube 1.0                   |
 234 |                                      | * Danube 2.0                   |
 235 |                                      |                                |
 236 +--------------------------------------+--------------------------------+
 237 | **Release date**                     | * March 31st 2017              |
 238 |                                      | * May 1st 2017                 |
 239 |                                      |                                |
 240 +--------------------------------------+--------------------------------+
 241 | **Purpose of the delivery**          | Danube stable release          |
 242 |                                      |                                |
 243 +--------------------------------------+--------------------------------+
 244
 245 Colorado Release Data
 246 -----------------------
 247
 248 +--------------------------------------+--------------------------------+
 249 | **Project**                          | Bottlenecks                    |
 250 |                                      |                                |
 251 +--------------------------------------+--------------------------------+
 252 | **Repo/tag**                         | Bottlenecks/colorado.1.0       |
 253 |                                      |                                |
 254 +--------------------------------------+--------------------------------+
 255 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 256 |                                      |                                |
 257 +--------------------------------------+--------------------------------+
 258 | **Release designation**              | * Colorado 1.0                 |
 259 |                                      |                                |
 260 +--------------------------------------+--------------------------------+
 261 | **Release date**                     | * September 22 2016            |
 262 |                                      |                                |
 263 +--------------------------------------+--------------------------------+
 264 | **Purpose of the delivery**          | Colorado stable release        |
 265 |                                      |                                |
 266 +--------------------------------------+--------------------------------+
 267
 268 Bramaputra Release Data
 269 -----------------------
 270
 271 +--------------------------------------+--------------------------------+
 272 | **Project**                          | Bottlenecks                    |
 273 |                                      |                                |
 274 +--------------------------------------+--------------------------------+
 275 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
 276 |                                      |                                |
 277 +--------------------------------------+--------------------------------+
 278 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 279 |                                      |                                |
 280 +--------------------------------------+--------------------------------+
 281 | **Release designation**              | * Brahmaputra 1.0              |
 282 |                                      |                                |
 283 +--------------------------------------+--------------------------------+
 284 | **Release date**                     | * February 25 2016             |
 285 |                                      |                                |
 286 +--------------------------------------+--------------------------------+
 287 | **Purpose of the delivery**          | Brahmaputra stable release     |
 288 |                                      |                                |
 289 +--------------------------------------+--------------------------------+
 290
 291
 292 Release Deliverables
 293 ====================
 294
 295 Software Deliverables
 296 ---------------------
 297
 298 **Bottlenecks source code**
 299
 300 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 301
 302
 303 Documentatiion Deliverables
 304 ---------------------------
 305
 306 **Bottlenecks documentation <fraser>**
 307
 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
 311
 312 **Bottlenecks documentation <euphrates>**
 313
 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
 317
 318 **Bottlenecks documentation <danube>**
 319
 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
 323
 324 **Bottlenecks documentation <colorado.1.0>**
 325
 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
 331
 332 Reason for Fraser
 333 =================
 334
 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
 339
 340 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
 341
 342 Reason for Euphrates
 343 ====================
 344
 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.
 349
 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.
 353
 354
 355 Known restrictions/issues
 356 =========================
 357
 358 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 359
 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.
 363
 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.
 366
 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.
 368
 369
 370 Test results
 371 ============
 372
 373 Test results are available in:
 374
 375  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 376
 377 The test results are reported to MongoDB. An example is given below.
 378
 379 ::
 380
 381     {
 382       "project_name": "bottlenecks",
 383       "scenario": "os-odl_l2-nofeature-ha",
 384       "stop_date": null,
 385       "trust_indicator": null,
 386       "case_name": "posca_stress_ping",
 387       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 388       "version": "master",
 389       "pod_name": "huawei-pod2",
 390       "criteria": "PASS",
 391       "installer": "compass",
 392       "_id": "58cf4d3e32c829000a1150a8",
 393       "start_date": "2017-3-9 4:33:04",
 394       "details": {}
 395     }
 396
 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
 400
 401 Open JIRA tickets
 402 =================
 403
 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 +------------------+----------------------------------------------------+
 415
 416
 417 Useful links
 418 ============
 419
 420  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 421
 422  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 423
 424  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 425
 426  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 427
 428  - Bottlenecks IRC chanel: #opnfv-bottlenecks