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