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
  65 Summary
  66 =======
  67
  68 * Documentation generated with Sphinx
  69
  70   * Release
  71
  72     * Release Notes
  73
  74   * Testing
  75
  76     * User Guide
  77
  78     * Developer Guide
  79
  80 The *Bottlenecks software* is developed in the OPNFV community, by the
  81 Bottlenecks_ team.
  82
  83 Release Data
  84 ============
  85
  86 Fraser Release Data
  87 -----------------------
  88
  89 +--------------------------------------+--------------------------------+
  90 | **Project**                          | Bottlenecks                    |
  91 |                                      |                                |
  92 +--------------------------------------+--------------------------------+
  93 | **Repo/tag**                         | * Bottlenecks/6.0.0            |
  94 |                                      |                                |
  95 |                                      |                                |
  96 +--------------------------------------+--------------------------------+
  97 | **Bottlenecks Docker image tag**     | * 6.0.0                        |
  98 |                                      |                                |
  99 |                                      |                                |
 100 +--------------------------------------+--------------------------------+
 101 | **Release designation**              | * 6.0.0                        |
 102 |                                      |                                |
 103 |                                      |                                |
 104 +--------------------------------------+--------------------------------+
 105 | **Release date**                     | * Apr 10th 2018                |
 106 |                                      |                                |
 107 |                                      |                                |
 108 +--------------------------------------+--------------------------------+
 109 | **Purpose of the delivery**          | Fraser stable release          |
 110 |                                      |                                |
 111 +--------------------------------------+--------------------------------+
 112
 113 Euphrates Release Data
 114 -----------------------
 115
 116 +--------------------------------------+--------------------------------+
 117 | **Project**                          | Bottlenecks                    |
 118 |                                      |                                |
 119 +--------------------------------------+--------------------------------+
 120 | **Repo/tag**                         | * Bottlenecks/5.1.0            |
 121 |                                      |                                |
 122 |                                      |                                |
 123 +--------------------------------------+--------------------------------+
 124 | **Bottlenecks Docker image tag**     | * 5.1.0                        |
 125 |                                      |                                |
 126 |                                      |                                |
 127 +--------------------------------------+--------------------------------+
 128 | **Release designation**              | * 5.1.0                        |
 129 |                                      |                                |
 130 |                                      |                                |
 131 +--------------------------------------+--------------------------------+
 132 | **Release date**                     | * Nov 15th 2017                |
 133 |                                      |                                |
 134 |                                      |                                |
 135 +--------------------------------------+--------------------------------+
 136 | **Purpose of the delivery**          | Euphrates stable release       |
 137 |                                      |                                |
 138 +--------------------------------------+--------------------------------+
 139
 140 +--------------------------------------+--------------------------------+
 141 | **Project**                          | Bottlenecks                    |
 142 |                                      |                                |
 143 +--------------------------------------+--------------------------------+
 144 | **Repo/tag**                         | * Bottlenecks/5.0.0            |
 145 |                                      |                                |
 146 |                                      |                                |
 147 +--------------------------------------+--------------------------------+
 148 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 149 |                                      |                                |
 150 |                                      |                                |
 151 +--------------------------------------+--------------------------------+
 152 | **Release designation**              | * 5.0.0                        |
 153 |                                      |                                |
 154 |                                      |                                |
 155 +--------------------------------------+--------------------------------+
 156 | **Release date**                     | * Sept 15th 2017               |
 157 |                                      |                                |
 158 |                                      |                                |
 159 +--------------------------------------+--------------------------------+
 160 | **Purpose of the delivery**          | Euphrates stable release       |
 161 |                                      |                                |
 162 +--------------------------------------+--------------------------------+
 163
 164 Danube Release Data
 165 -----------------------
 166
 167 +--------------------------------------+--------------------------------+
 168 | **Project**                          | Bottlenecks                    |
 169 |                                      |                                |
 170 +--------------------------------------+--------------------------------+
 171 | **Repo/tag**                         | * Bottlenecks/danube.1.0       |
 172 |                                      | * Bottlenecks/danube.2.0       |
 173 |                                      |                                |
 174 +--------------------------------------+--------------------------------+
 175 | **Bottlenecks Docker image tag**     | * danube.1.0                   |
 176 |                                      | * danube.2.0                   |
 177 |                                      |                                |
 178 +--------------------------------------+--------------------------------+
 179 | **Release designation**              | * Danube 1.0                   |
 180 |                                      | * Danube 2.0                   |
 181 |                                      |                                |
 182 +--------------------------------------+--------------------------------+
 183 | **Release date**                     | * March 31st 2017              |
 184 |                                      | * May 1st 2017                 |
 185 |                                      |                                |
 186 +--------------------------------------+--------------------------------+
 187 | **Purpose of the delivery**          | Danube stable release          |
 188 |                                      |                                |
 189 +--------------------------------------+--------------------------------+
 190
 191 Colorado Release Data
 192 -----------------------
 193
 194 +--------------------------------------+--------------------------------+
 195 | **Project**                          | Bottlenecks                    |
 196 |                                      |                                |
 197 +--------------------------------------+--------------------------------+
 198 | **Repo/tag**                         | Bottlenecks/colorado.1.0       |
 199 |                                      |                                |
 200 +--------------------------------------+--------------------------------+
 201 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 202 |                                      |                                |
 203 +--------------------------------------+--------------------------------+
 204 | **Release designation**              | * Colorado 1.0                 |
 205 |                                      |                                |
 206 +--------------------------------------+--------------------------------+
 207 | **Release date**                     | * September 22 2016            |
 208 |                                      |                                |
 209 +--------------------------------------+--------------------------------+
 210 | **Purpose of the delivery**          | Colorado stable release        |
 211 |                                      |                                |
 212 +--------------------------------------+--------------------------------+
 213
 214 Bramaputra Release Data
 215 -----------------------
 216
 217 +--------------------------------------+--------------------------------+
 218 | **Project**                          | Bottlenecks                    |
 219 |                                      |                                |
 220 +--------------------------------------+--------------------------------+
 221 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
 222 |                                      |                                |
 223 +--------------------------------------+--------------------------------+
 224 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 225 |                                      |                                |
 226 +--------------------------------------+--------------------------------+
 227 | **Release designation**              | * Brahmaputra 1.0              |
 228 |                                      |                                |
 229 +--------------------------------------+--------------------------------+
 230 | **Release date**                     | * February 25 2016             |
 231 |                                      |                                |
 232 +--------------------------------------+--------------------------------+
 233 | **Purpose of the delivery**          | Brahmaputra stable release     |
 234 |                                      |                                |
 235 +--------------------------------------+--------------------------------+
 236
 237
 238 Release Deliverables
 239 ====================
 240
 241 Software Deliverables
 242 ---------------------
 243
 244 **Bottlenecks source code**
 245
 246 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 247
 248
 249 Documentatiion Deliverables
 250 ---------------------------
 251
 252 **Bottlenecks documentation <fraser>**
 253
 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
 257
 258 **Bottlenecks documentation <euphrates>**
 259
 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
 263
 264 **Bottlenecks documentation <danube>**
 265
 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
 269
 270 **Bottlenecks documentation <colorado.1.0>**
 271
 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
 277
 278 Reason for Fraser
 279 =================
 280
 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
 285
 286 These tests cases and refactoring further enhance the capability of Bottlenecks project and let it be adaptable to different usages.
 287
 288 Reason for Euphrates
 289 ====================
 290
 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.
 295
 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.
 299
 300
 301 Known restrictions/issues
 302 =========================
 303
 304 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 305
 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.
 309
 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.
 312
 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.
 314
 315
 316 Test results
 317 ============
 318
 319 Test results are available in:
 320
 321  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 322
 323 The test results are reported to MongoDB. An example is given below.
 324
 325 ::
 326
 327     {
 328       "project_name": "bottlenecks",
 329       "scenario": "os-odl_l2-nofeature-ha",
 330       "stop_date": null,
 331       "trust_indicator": null,
 332       "case_name": "posca_stress_ping",
 333       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 334       "version": "master",
 335       "pod_name": "huawei-pod2",
 336       "criteria": "PASS",
 337       "installer": "compass",
 338       "_id": "58cf4d3e32c829000a1150a8",
 339       "start_date": "2017-3-9 4:33:04",
 340       "details": {}
 341     }
 342
 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
 346
 347 Open JIRA tickets
 348 =================
 349
 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 +------------------+----------------------------------------------------+
 361
 362
 363 Useful links
 364 ============
 365
 366  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 367
 368  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 369
 370  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 371
 372  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 373
 374  - Bottlenecks IRC chanel: #opnfv-bottlenecks