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