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
  63 Summary
  64 =======
  65
  66 * Documentation generated with Sphinx
  67
  68   * Release
  69
  70     * Release Notes
  71
  72   * Testing
  73
  74     * User Guide
  75
  76     * Developer Guide
  77
  78 The *Bottlenecks software* is developed in the OPNFV community, by the
  79 Bottlenecks_ team.
  80
  81 Release Data
  82 ============
  83
  84 Euphrates Release Data
  85 -----------------------
  86
  87 +--------------------------------------+--------------------------------+
  88 | **Project**                          | Bottlenecks                    |
  89 |                                      |                                |
  90 +--------------------------------------+--------------------------------+
  91 | **Repo/tag**                         | * Bottlenecks/5.1.0            |
  92 |                                      |                                |
  93 |                                      |                                |
  94 +--------------------------------------+--------------------------------+
  95 | **Bottlenecks Docker image tag**     | * 5.1.0                        |
  96 |                                      |                                |
  97 |                                      |                                |
  98 +--------------------------------------+--------------------------------+
  99 | **Release designation**              | * 5.1.0                        |
 100 |                                      |                                |
 101 |                                      |                                |
 102 +--------------------------------------+--------------------------------+
 103 | **Release date**                     | * Nov 15th 2017                |
 104 |                                      |                                |
 105 |                                      |                                |
 106 +--------------------------------------+--------------------------------+
 107 | **Purpose of the delivery**          | Euphrates stable release       |
 108 |                                      |                                |
 109 +--------------------------------------+--------------------------------+
 110
 111 +--------------------------------------+--------------------------------+
 112 | **Project**                          | Bottlenecks                    |
 113 |                                      |                                |
 114 +--------------------------------------+--------------------------------+
 115 | **Repo/tag**                         | * Bottlenecks/5.0.0            |
 116 |                                      |                                |
 117 |                                      |                                |
 118 +--------------------------------------+--------------------------------+
 119 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 120 |                                      |                                |
 121 |                                      |                                |
 122 +--------------------------------------+--------------------------------+
 123 | **Release designation**              | * 5.0.0                        |
 124 |                                      |                                |
 125 |                                      |                                |
 126 +--------------------------------------+--------------------------------+
 127 | **Release date**                     | * Sept 15th 2017               |
 128 |                                      |                                |
 129 |                                      |                                |
 130 +--------------------------------------+--------------------------------+
 131 | **Purpose of the delivery**          | Euphrates stable release       |
 132 |                                      |                                |
 133 +--------------------------------------+--------------------------------+
 134
 135 Danube Release Data
 136 -----------------------
 137
 138 +--------------------------------------+--------------------------------+
 139 | **Project**                          | Bottlenecks                    |
 140 |                                      |                                |
 141 +--------------------------------------+--------------------------------+
 142 | **Repo/tag**                         | * Bottlenecks/danube.1.0       |
 143 |                                      | * Bottlenecks/danube.2.0       |
 144 |                                      |                                |
 145 +--------------------------------------+--------------------------------+
 146 | **Bottlenecks Docker image tag**     | * danube.1.0                   |
 147 |                                      | * danube.2.0                   |
 148 |                                      |                                |
 149 +--------------------------------------+--------------------------------+
 150 | **Release designation**              | * Danube 1.0                   |
 151 |                                      | * Danube 2.0                   |
 152 |                                      |                                |
 153 +--------------------------------------+--------------------------------+
 154 | **Release date**                     | * March 31st 2017              |
 155 |                                      | * May 1st 2017                 |
 156 |                                      |                                |
 157 +--------------------------------------+--------------------------------+
 158 | **Purpose of the delivery**          | Danube stable release          |
 159 |                                      |                                |
 160 +--------------------------------------+--------------------------------+
 161
 162 Colorado Release Data
 163 -----------------------
 164
 165 +--------------------------------------+--------------------------------+
 166 | **Project**                          | Bottlenecks                    |
 167 |                                      |                                |
 168 +--------------------------------------+--------------------------------+
 169 | **Repo/tag**                         | Bottlenecks/colorado.1.0       |
 170 |                                      |                                |
 171 +--------------------------------------+--------------------------------+
 172 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 173 |                                      |                                |
 174 +--------------------------------------+--------------------------------+
 175 | **Release designation**              | * Colorado 1.0                 |
 176 |                                      |                                |
 177 +--------------------------------------+--------------------------------+
 178 | **Release date**                     | * September 22 2016            |
 179 |                                      |                                |
 180 +--------------------------------------+--------------------------------+
 181 | **Purpose of the delivery**          | Colorado stable release        |
 182 |                                      |                                |
 183 +--------------------------------------+--------------------------------+
 184
 185 Bramaputra Release Data
 186 -----------------------
 187
 188 +--------------------------------------+--------------------------------+
 189 | **Project**                          | Bottlenecks                    |
 190 |                                      |                                |
 191 +--------------------------------------+--------------------------------+
 192 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0    |
 193 |                                      |                                |
 194 +--------------------------------------+--------------------------------+
 195 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 196 |                                      |                                |
 197 +--------------------------------------+--------------------------------+
 198 | **Release designation**              | * Brahmaputra 1.0              |
 199 |                                      |                                |
 200 +--------------------------------------+--------------------------------+
 201 | **Release date**                     | * February 25 2016             |
 202 |                                      |                                |
 203 +--------------------------------------+--------------------------------+
 204 | **Purpose of the delivery**          | Brahmaputra stable release     |
 205 |                                      |                                |
 206 +--------------------------------------+--------------------------------+
 207
 208
 209 Danube Deliverables
 210 ===================
 211
 212 Software Deliverables
 213 ---------------------
 214
 215 **Bottlenecks source code**
 216
 217 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 218
 219
 220 Documentatiion Deliverables
 221 ---------------------------
 222
 223 **Bottlenecks documentation <euphrates>**
 224
 225 * Release Notes: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 226 * User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/user/userguide/index.html
 227 * Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 228
 229 **Bottlenecks documentation <danube>**
 230
 231 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 232 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
 233 * Developer Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 234
 235 **Bottlenecks documentation <colorado.1.0>**
 236
 237 * Platform Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
 238 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
 239 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
 240 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
 241 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
 242
 243 Reason for Euphrates
 244 ====================
 245
 246 * Introduction of a simple monitoring module, i.e., Prometheus+Collectd+Node+Grafana to monitor the system behavior when executing stress tests.
 247 * Support VNF scale up/out tests to verify NFVI capability to adapt the resource consuming.
 248 * Extend Life-cycle test to data-plane to validate the system capability to handle concurrent networks usage.
 249 * Testing framework is revised to support installer-agnostic testing.
 250
 251 These enhancements and test cases help the end users to gain more comprehensive understanding of the SUT.
 252 Graphic reports of the system behavior additional to test cases are provided to indicate the confidence level of SUT.
 253 Installer-agnostic testing framework allow end user to do stress testing adaptively over either Open Source or commercial deployments.
 254
 255
 256 Known restrictions/issues
 257 =========================
 258
 259 * Bottlenecks uses Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 260
 261   * Sometimes, Yardstick just waits for the test environment preparing.
 262   This cause troubles since it seams to get Yardstick into a loop to keep waiting.
 263   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.
 264
 265   * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
 266   It maybe due to the environment issue or poor internet connection causing testing tools are not installed successfully.
 267
 268 * 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.
 269
 270
 271 Test results
 272 ============
 273
 274 Test results are available in:
 275
 276  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 277
 278 The test results are reported to MongoDB. An example is given below.
 279
 280 ::
 281
 282     {
 283       "project_name": "bottlenecks",
 284       "scenario": "os-odl_l2-nofeature-ha",
 285       "stop_date": null,
 286       "trust_indicator": null,
 287       "case_name": "posca_stress_ping",
 288       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 289       "version": "master",
 290       "pod_name": "huawei-pod2",
 291       "criteria": "PASS",
 292       "installer": "compass",
 293       "_id": "58cf4d3e32c829000a1150a8",
 294       "start_date": "2017-3-9 4:33:04",
 295       "details": {}
 296     }
 297
 298 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 299  - Results reported in MongoDB could find at http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 300  - Test Cases are defined in http://testresults.opnfv.org/test/api/v1/results?project=bottlenecks
 301
 302 Open JIRA tickets
 303 =================
 304
 305 +------------------+----------------------------------------------------+
 306 |   JIRA           |         Description                                |
 307 +==================+====================================================+
 308 | BOTTLENECK-147   | Investigting why calling remote docker client      |
 309 +------------------+----------------------------------------------------+
 310 | BOTTLENECK-207   | Yardstick loop when executing test cases           |
 311 +------------------+----------------------------------------------------+
 312 | BOTTLENECK-208   | Yardstick empty results when executing test cases  |
 313 +------------------+----------------------------------------------------+
 314 | BOTTLENECK-209   | Sleep process when executing test cases            |
 315 +------------------+----------------------------------------------------+
 316
 317
 318 Useful links
 319 ============
 320
 321  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 322
 323  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 324
 325  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 326
 327  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 328
 329  - Bottlenecks IRC chanel: #opnfv-bottlenecks