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 | Dec 10th, 2018 |  1.8.0             | Bottlenecks Gambia release 7.0    |
  71 |                |                    |                                   |
  72 +----------------+--------------------+-----------------------------------+
  73 | May 10th, 2019 |  1.9.0             | Bottlenecks Hunter release 8.0    |
  74 |                |                    |                                   |
  75 +----------------+--------------------+-----------------------------------+
  76
  77 Summary
  78 =======
  79
  80 * Documentation generated with Sphinx
  81
  82   * Release
  83
  84     * Release Notes
  85
  86   * Testing
  87
  88     * User Guide
  89
  90     * Developer Guide
  91
  92 The *Bottlenecks software* is developed in the OPNFV community, by the
  93 Bottlenecks_ team.
  94
  95 Release Data
  96 ============
  97
  98 Hunter Release Data
  99 -----------------------
 100
 101 +--------------------------------------+--------------------------------+
 102 | **Project**                          | Bottlenecks                    |
 103 |                                      |                                |
 104 +--------------------------------------+--------------------------------+
 105 | **Repo/tag**                         | * Bottlenecks/8.0.0            |
 106 |                                      |                                |
 107 |                                      |                                |
 108 +--------------------------------------+--------------------------------+
 109 | **Bottlenecks Docker image tag**     | * 8.0.0                        |
 110 |                                      |                                |
 111 |                                      |                                |
 112 +--------------------------------------+--------------------------------+
 113 | **Release designation**              | * 8.0.0                        |
 114 |                                      |                                |
 115 |                                      |                                |
 116 +--------------------------------------+--------------------------------+
 117 | **Release date**                     | * May 10th 2019                |
 118 |                                      |                                |
 119 |                                      |                                |
 120 +--------------------------------------+--------------------------------+
 121 | **Purpose of the delivery**          | Hunter stable release          |
 122 |                                      |                                |
 123 +--------------------------------------+--------------------------------+
 124
 125 Fraser Release Data
 126 -----------------------
 127
 128 +--------------------------------------+--------------------------------+
 129 | **Project**                          | Bottlenecks                    |
 130 |                                      |                                |
 131 +--------------------------------------+--------------------------------+
 132 | **Repo/tag**                         | * Bottlenecks/6.2.0            |
 133 |                                      |                                |
 134 |                                      |                                |
 135 +--------------------------------------+--------------------------------+
 136 | **Bottlenecks Docker image tag**     | * 6.2.0                        |
 137 |                                      |                                |
 138 |                                      |                                |
 139 +--------------------------------------+--------------------------------+
 140 | **Release designation**              | * 6.2.0                        |
 141 |                                      |                                |
 142 |                                      |                                |
 143 +--------------------------------------+--------------------------------+
 144 | **Release date**                     | * Jul 2nd 2018                 |
 145 |                                      |                                |
 146 |                                      |                                |
 147 +--------------------------------------+--------------------------------+
 148 | **Purpose of the delivery**          | Fraser stable release          |
 149 |                                      |                                |
 150 +--------------------------------------+--------------------------------+
 151
 152 +--------------------------------------+--------------------------------+
 153 | **Project**                          | Bottlenecks                    |
 154 |                                      |                                |
 155 +--------------------------------------+--------------------------------+
 156 | **Repo/tag**                         | * Bottlenecks/6.1.0            |
 157 |                                      |                                |
 158 |                                      |                                |
 159 +--------------------------------------+--------------------------------+
 160 | **Bottlenecks Docker image tag**     | * 6.1.0                        |
 161 |                                      |                                |
 162 |                                      |                                |
 163 +--------------------------------------+--------------------------------+
 164 | **Release designation**              | * 6.1.0                        |
 165 |                                      |                                |
 166 |                                      |                                |
 167 +--------------------------------------+--------------------------------+
 168 | **Release date**                     | * May 26th 2018                |
 169 |                                      |                                |
 170 |                                      |                                |
 171 +--------------------------------------+--------------------------------+
 172 | **Purpose of the delivery**          | Fraser stable release          |
 173 |                                      |                                |
 174 +--------------------------------------+--------------------------------+
 175
 176 +--------------------------------------+--------------------------------+
 177 | **Project**                          | Bottlenecks                    |
 178 |                                      |                                |
 179 +--------------------------------------+--------------------------------+
 180 | **Repo/tag**                         | * Bottlenecks/6.0.0            |
 181 |                                      |                                |
 182 |                                      |                                |
 183 +--------------------------------------+--------------------------------+
 184 | **Bottlenecks Docker image tag**     | * 6.0.0                        |
 185 |                                      |                                |
 186 |                                      |                                |
 187 +--------------------------------------+--------------------------------+
 188 | **Release designation**              | * 6.0.0                        |
 189 |                                      |                                |
 190 |                                      |                                |
 191 +--------------------------------------+--------------------------------+
 192 | **Release date**                     | * Apr 10th 2018                |
 193 |                                      |                                |
 194 |                                      |                                |
 195 +--------------------------------------+--------------------------------+
 196 | **Purpose of the delivery**          | Fraser stable release          |
 197 |                                      |                                |
 198 +--------------------------------------+--------------------------------+
 199
 200 Euphrates Release Data
 201 -----------------------
 202
 203 +--------------------------------------+--------------------------------+
 204 | **Project**                          | Bottlenecks                    |
 205 |                                      |                                |
 206 +--------------------------------------+--------------------------------+
 207 | **Repo/tag**                         | * Bottlenecks/5.1.0            |
 208 |                                      |                                |
 209 |                                      |                                |
 210 +--------------------------------------+--------------------------------+
 211 | **Bottlenecks Docker image tag**     | * 5.1.0                        |
 212 |                                      |                                |
 213 |                                      |                                |
 214 +--------------------------------------+--------------------------------+
 215 | **Release designation**              | * 5.1.0                        |
 216 |                                      |                                |
 217 |                                      |                                |
 218 +--------------------------------------+--------------------------------+
 219 | **Release date**                     | * Nov 15th 2017                |
 220 |                                      |                                |
 221 |                                      |                                |
 222 +--------------------------------------+--------------------------------+
 223 | **Purpose of the delivery**          | Euphrates stable release       |
 224 |                                      |                                |
 225 +--------------------------------------+--------------------------------+
 226
 227 +--------------------------------------+--------------------------------+
 228 | **Project**                          | Bottlenecks                    |
 229 |                                      |                                |
 230 +--------------------------------------+--------------------------------+
 231 | **Repo/tag**                         | * Bottlenecks/5.0.0            |
 232 |                                      |                                |
 233 |                                      |                                |
 234 +--------------------------------------+--------------------------------+
 235 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 236 |                                      |                                |
 237 |                                      |                                |
 238 +--------------------------------------+--------------------------------+
 239 | **Release designation**              | * 5.0.0                        |
 240 |                                      |                                |
 241 |                                      |                                |
 242 +--------------------------------------+--------------------------------+
 243 | **Release date**                     | * Sept 15th 2017               |
 244 |                                      |                                |
 245 |                                      |                                |
 246 +--------------------------------------+--------------------------------+
 247 | **Purpose of the delivery**          | Euphrates stable release       |
 248 |                                      |                                |
 249 +--------------------------------------+--------------------------------+
 250
 251 Danube Release Data
 252 -----------------------
 253
 254 +--------------------------------------+--------------------------------+
 255 | **Project**                          | Bottlenecks                    |
 256 |                                      |                                |
 257 +--------------------------------------+--------------------------------+
 258 | **Repo/tag**                         | * Bottlenecks/danube.1.0       |
 259 |                                      | * Bottlenecks/danube.2.0       |
 260 |                                      |                                |
 261 +--------------------------------------+--------------------------------+
 262 | **Bottlenecks Docker image tag**     | * danube.1.0                   |
 263 |                                      | * danube.2.0                   |
 264 |                                      |                                |
 265 +--------------------------------------+--------------------------------+
 266 | **Release designation**              | * Danube 1.0                   |
 267 |                                      | * Danube 2.0                   |
 268 |                                      |                                |
 269 +--------------------------------------+--------------------------------+
 270 | **Release date**                     | * March 31st 2017              |
 271 |                                      | * May 1st 2017                 |
 272 |                                      |                                |
 273 +--------------------------------------+--------------------------------+
 274 | **Purpose of the delivery**          | Danube stable release          |
 275 |                                      |                                |
 276 +--------------------------------------+--------------------------------+
 277
 278 Colorado Release Data
 279 -----------------------
 280
 281 +--------------------------------------+--------------------------------+
 282 | **Project**                          | Bottlenecks                    |
 283 |                                      |                                |
 284 +--------------------------------------+--------------------------------+
 285 | **Repo/tag**                         | Bottlenecks/colorado.1.0       |
 286 |                                      |                                |
 287 +--------------------------------------+--------------------------------+
 288 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 289 |                                      |                                |
 290 +--------------------------------------+--------------------------------+
 291 | **Release designation**              | * Colorado 1.0                 |
 292 |                                      |                                |
 293 +--------------------------------------+--------------------------------+
 294 | **Release date**                     | * September 22 2016            |
 295 |                                      |                                |
 296 +--------------------------------------+--------------------------------+
 297 | **Purpose of the delivery**          | Colorado stable release        |
 298 |                                      |                                |
 299 +--------------------------------------+--------------------------------+
 300
 301 Bramaputra Release Data
 302 -----------------------
 303
 304 +--------------------------------------+--------------------------------+
 305 | **Project**                          | Bottlenecks                    |
 306 |                                      |                                |
 307 +--------------------------------------+--------------------------------+
 308 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
 309 |                                      |                                |
 310 +--------------------------------------+--------------------------------+
 311 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 312 |                                      |                                |
 313 +--------------------------------------+--------------------------------+
 314 | **Release designation**              | * Brahmaputra 1.0              |
 315 |                                      |                                |
 316 +--------------------------------------+--------------------------------+
 317 | **Release date**                     | * February 25 2016             |
 318 |                                      |                                |
 319 +--------------------------------------+--------------------------------+
 320 | **Purpose of the delivery**          | Brahmaputra stable release     |
 321 |                                      |                                |
 322 +--------------------------------------+--------------------------------+
 323
 324
 325 Release Deliverables
 326 ====================
 327
 328 Software Deliverables
 329 ---------------------
 330
 331 **Bottlenecks source code**
 332
 333 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 334
 335
 336 Documentatiion Deliverables
 337 ---------------------------
 338
 339 **Bottlenecks documentation <hunter>**
 340
 341 * Release Notes: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 342 * User Guide: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/testing/user/userguide/index.html
 343 * Developer Guide: http://docs.opnfv.org/en/stable-hunter/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 344
 345 **Bottlenecks documentation <fraser>**
 346
 347 * Release Notes: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 348 * User Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/user/userguide/index.html
 349 * Developer Guide: http://docs.opnfv.org/en/stable-fraser/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 350
 351 **Bottlenecks documentation <euphrates>**
 352
 353 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 354 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
 355 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 356
 357 **Bottlenecks documentation <danube>**
 358
 359 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 360 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
 361 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 362
 363 **Bottlenecks documentation <colorado.1.0>**
 364
 365 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
 366 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
 367 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
 368 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
 369 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
 370
 371 Reason for Fraser
 372 =================
 373
 374 * Introduction of data-plane soak tests aiming at benchmarking long duration stability of OPNFV platform
 375 * Introduction of security tests by cooperating with Moon project to validate the software security based authentication schemes
 376 * Introduction of multi-stack storage tests and Storperf storage test
 377 * Testing framework provides local supports for preparing images for openstack resulting in offline running supports for Bottlenecks
 378
 379 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
 380
 381 Reason for Euphrates
 382 ====================
 383
 384 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
 385 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
 386 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
 387 * Testing framework is revised to support installer-agnostic testing.
 388
 389 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
 390 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
 391 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
 392
 393
 394 Known restrictions/issues
 395 =========================
 396
 397 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 398
 399   * Sometimes, Yardstick just waits for the test environment preparing.
 400   This cause troubles since it seams to get Yardstick into a loop to keep waiting.
 401   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.
 402
 403   * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
 404   It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
 405
 406 * 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.
 407
 408
 409 Test results
 410 ============
 411
 412 Test results are available in:
 413
 414  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 415
 416 The test results are reported to MongoDB. An example is given below.
 417
 418 ::
 419
 420     {
 421       "project_name": "bottlenecks",
 422       "scenario": "os-odl_l2-nofeature-ha",
 423       "stop_date": null,
 424       "trust_indicator": null,
 425       "case_name": "posca_stress_ping",
 426       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 427       "version": "master",
 428       "pod_name": "huawei-pod2",
 429       "criteria": "PASS",
 430       "installer": "compass",
 431       "_id": "58cf4d3e32c829000a1150a8",
 432       "start_date": "2017-3-9 4:33:04",
 433       "details": {}
 434     }
 435
 436 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 437  - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 438  - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 439
 440 Open JIRA tickets
 441 =================
 442
 443 +------------------+----------------------------------------------------+
 444 |   JIRA           |         Description                                |
 445 +==================+====================================================+
 446 | BOTTLENECK-147   | Investigting why calling remote docker client      |
 447 +------------------+----------------------------------------------------+
 448 | BOTTLENECK-207   | Yardstick loop when executing test cases           |
 449 +------------------+----------------------------------------------------+
 450 | BOTTLENECK-208   | Yardstick empty results when executing test cases  |
 451 +------------------+----------------------------------------------------+
 452 | BOTTLENECK-209   | Sleep process when executing test cases            |
 453 +------------------+----------------------------------------------------+
 454
 455
 456 Useful links
 457 ============
 458
 459  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 460
 461  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 462
 463  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 464
 465  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 466
 467  - Bottlenecks IRC chanel: #opnfv-bottlenecks