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
  54 Summary
  55 =======
  56
  57 * Documentation generated with Sphinx
  58
  59   * Release
  60
  61     * Release Notes
  62
  63   * Testing
  64
  65     * User Guide
  66
  67     * Development Guide
  68
  69 The *Bottlenecks software* is developed in the OPNFV community, by the
  70 Bottlenecks_ team.
  71
  72 Release Data
  73 ============
  74
  75 Danube Release Data
  76 -----------------------
  77
  78 +--------------------------------------+--------------------------------------+
  79 | **Project**                          | Bottlenecks                          |
  80 |                                      |                                      |
  81 +--------------------------------------+--------------------------------------+
  82 | **Repo/tag**                         | * Bottlenecks/danube.1.0             |
  83 |                                      | * Bottlenecks/danube.2.0             |
  84 |                                      |                                      |
  85 +--------------------------------------+--------------------------------------+
  86 | **Bottlenecks Docker image tag**     | * danube.1.0                         |
  87 |                                      | * danube.2.0                         |
  88 |                                      |                                      |
  89 +--------------------------------------+--------------------------------------+
  90 | **Release designation**              | * Danube 1.0                         |
  91 |                                      | * Danube 2.0                         |
  92 |                                      |                                      |
  93 +--------------------------------------+--------------------------------------+
  94 | **Release date**                     | * March 31st 2017                    |
  95 |                                      | * May 1st 2017                       |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98 | **Purpose of the delivery**          | Danube stable release                |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101
 102 Colorado Release Data
 103 -----------------------
 104
 105 +--------------------------------------+--------------------------------------+
 106 | **Project**                          | Bottlenecks                          |
 107 |                                      |                                      |
 108 +--------------------------------------+--------------------------------------+
 109 | **Repo/tag**                         | Bottlenecks/colorado.1.0             |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 | **Bottlenecks Docker image tag**     | * colorado.1.0                       |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115 | **Release designation**              | * Colorado 1.0                       |
 116 |                                      |                                      |
 117 +--------------------------------------+--------------------------------------+
 118 | **Release date**                     | * September 22 2016                  |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | **Purpose of the delivery**          | Colorado stable release              |
 122 |                                      |                                      |
 123 +--------------------------------------+--------------------------------------+
 124
 125 Bramaputra Release Data
 126 -----------------------
 127
 128 +--------------------------------------+--------------------------------------+
 129 | **Project**                          | Bottlenecks                          |
 130 |                                      |                                      |
 131 +--------------------------------------+--------------------------------------+
 132 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0          |
 133 |                                      |                                      |
 134 +--------------------------------------+--------------------------------------+
 135 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0                    |
 136 |                                      |                                      |
 137 +--------------------------------------+--------------------------------------+
 138 | **Release designation**              | * Brahmaputra 1.0                    |
 139 |                                      |                                      |
 140 +--------------------------------------+--------------------------------------+
 141 | **Release date**                     | * February 25 2016                   |
 142 |                                      |                                      |
 143 +--------------------------------------+--------------------------------------+
 144 | **Purpose of the delivery**          | Brahmaputra stable release           |
 145 |                                      |                                      |
 146 +--------------------------------------+--------------------------------------+
 147
 148
 149 Danube Deliverables
 150 ===================
 151
 152 Software Deliverables
 153 ---------------------
 154
 155 **Bottlenecks source code <danube.1.0>**
 156
 157 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 158
 159
 160 Documentatiion Deliverables
 161 ---------------------------
 162
 163 **Bottlenecks documentation <danube.1.0>**
 164
 165 * Release Notes: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/release/release-notes/release_notes.html
 166 * User Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/user/userguide/index.html
 167 * Development Guide: http://docs.opnfv.org/en/stable-danube/submodules/bottlenecks/docs/testing/developer/devguide/index.html
 168
 169 Colorado Deliverables
 170 =====================
 171
 172 Software Deliverables
 173 ---------------------
 174
 175 **Bottlenecks source code <colorado.1.0>**
 176
 177 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
 178
 179
 180 Documentatiion Deliverables
 181 ---------------------------
 182
 183 **Bottlenecks documentation <colorado.1.0>**
 184
 185 * Platformation Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
 186 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
 187 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
 188 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
 189 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
 190
 191 Reason for Version
 192 ==================
 193
 194 * In Danube, POSCA testsuite is introduced and two stress tests are implemented. Rubbos and vstf are
 195 not supported in this release.
 196 * In Colorado, rubbos is refactored by using puppet, which makes it quite flexible to configure with different number of load generator(Client), worker(tomcat).
 197 * In Colorado, vstf is refactored by extracting the test case's configuration information.
 198
 199
 200 Known restrictions/issues
 201 =========================
 202
 203 * In Danube, Bottlenecks use Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.
 204
 205   * Sometimes, Yardstick just waits for the test environment preparing.
 206   This cause troubles since it seams to get Yardstick into a loop to keep waiting.
 207   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.
 208
 209   * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
 210   It maybe because of the environment issue or poor internet connection causing testing tools are not installed successfully.
 211
 212 * Sometimes, a process will go to dormancy. In this case, if a tool is installed in the SUT and its process go dormancy, we try to call it twice. Normally, it will response.
 213
 214
 215 Test results
 216 ============
 217
 218 Test results are available in:
 219
 220  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
 221
 222 The test results are reported to MongoDB. An example is given below.
 223
 224 ::
 225
 226     {
 227       "project_name": "bottlenecks",
 228       "scenario": "os-odl_l2-nofeature-ha",
 229       "stop_date": null,
 230       "trust_indicator": null,
 231       "case_name": "posca_stress_ping",
 232       "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
 233       "version": "master",
 234       "pod_name": "huawei-pod2",
 235       "criteria": "PASS",
 236       "installer": "compass",
 237       "_id": "58cf4d3e32c829000a1150a8",
 238       "start_date": "2017-3-9 4:33:04",
 239       "details": {}
 240     }
 241
 242 For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing
 243
 244 Open JIRA tickets
 245 =================
 246
 247 +------------------+-----------------------------------------------+
 248 |   JIRA           |         Description                           |
 249 +==================+===============================================+
 250 | BOTTLENECK-103   | Refactoring the Bottlenecks tesing workflow   |
 251 +------------------+-----------------------------------------------+
 252 | BOTTLENECK-135   | Avoiding docker-compose building new image    |
 253 |                  | for Bottlenecks                               |
 254 +------------------+-----------------------------------------------+
 255 | BOTTLENECK-147   | Investigting why calling remote docker client |
 256 +------------------+-----------------------------------------------+
 257
 258
 259 Useful links
 260 ============
 261
 262  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
 263
 264  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
 265
 266  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
 267
 268  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
 269
 270  - Bottlenecks IRC chanel: #opnfv-bottlenecks