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