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