summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release_notes.rst
blob: d4a56703185e469c7a1101c91ddd6695f110ac34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Huawei Technologies Co.,Ltd and others.


==================================================
Bottlenecks Release Notes for OPNFV Danube Release
==================================================

.. _Bottlenecks: https://wiki.opnfv.org/display/bottlenecks


Abstract
========

This document describes the release notes of Bottlenecks project.


License
=======

OPNFV release notes for Bottlenecks Docs
are licensed under a Creative Commons Attribution 4.0 International License.
You should have received a copy of the license along with this.
If not, see <http://creativecommons.org/licenses/by/4.0/>.

The *Bottlenecks software* is opensource software, licensed under the terms of the
Apache License, Version 2.0.


Version History
===============

+----------------+--------------------+---------------------------------+
| *Date*         | *Version*          | *Comment*                       |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| Sept 22nd, 2016|  1.0               | Bottlenecks Colorado release 1.0|
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| Feb 17nd, 2017 |  1.1               | Bottlenecks Danube release 1.0  |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| Mar 24nd, 2017 |  1.2               | Bottlenecks Danube release 1.0  |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| Mar 24nd, 2017 |  1.3               | Bottlenecks Danube release 1.0  |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+

Summary
=======

* Documentation generated with Sphinx

  * Release

    * Release Notes

  * Testing

    * User Guide

    * Development Guide

The *Bottlenecks software* is developed in the OPNFV community, by the
Bottlenecks_ team.

Release Data
============

Danube Release Data
-----------------------

+--------------------------------------+--------------------------------------+
| **Project**                          | Bottlenecks                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | Bottlenecks/danube.1.0               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Bottlenecks Docker image tag**     | danube.1.0                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube 1.0                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | March 31 2017                        |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Danube base release                  |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Colorado Release Data
-----------------------

+--------------------------------------+--------------------------------------+
| **Project**                          | Bottlenecks                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | Bottlenecks/colorado.1.0             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Bottlenecks Docker image tag**     | colorado.1.0                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Colorado 1.0                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | September 22 2016                    |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Colorado base release                |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Bramaputra Release Data
-----------------------

+--------------------------------------+--------------------------------------+
| **Project**                          | Bottlenecks                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | Bottlenecks/brahmaputra.1.0          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Bottlenecks Docker image tag**     | brahmaputra.1.0                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Brahmaputra 1.0                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | February 25 2016                     |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Brahmaputra base release             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+


Danube Deliverables
===================

Software Deliverables
---------------------

**Bottlenecks source code <danube.1.0>**

* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary


Documentatiion Deliverables
---------------------------

**Bottlenecks documentation <danube.1.0>**

* Release Notes: TO-DO
* User Guide: TO-DO
* Development Guide: TO-DO

Colorado Deliverables
=====================

Software Deliverables
---------------------

**Bottlenecks source code <colorado.1.0>**

* https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary


Documentatiion Deliverables
---------------------------

**Bottlenecks documentation <colorado.1.0>**

* Platformation Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
* Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
* Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
* http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
* User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html

Reason for Version
==================

* In Danube, POSCA testsuite is introduced and two stress tests are implemented. Rubbos and vstf are
not supported in this release.
* In Colorado, rubbos is refactored by using puppet, which makes it quite flexible to configure with different number of load generator(Client), worker(tomcat).
* In Colorado, vstf is refactored by extracting the test case's configuration information.


Known restrictions/issues
=========================

* In Danube, Bottlenecks use Yardstick to do stress tests by iteratively calling yardstick running test cases and in the meantime increasing load.

  * Sometimes, Yardstick just waits for the test environment preparing.
  This cause troubles since it seams to get Yardstick into a loop to keep waiting.
  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.

  * Sometimes, Yardstick will return empty test results with test flag indicating test is excuted succefully.
  It maybe because of the environment issue or poor internet connection causing tools are not installed successfully.

* 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.


Test results
============

Test results are available in:

 - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/

The test results are reported to MongoDB. An example is given below.

::

    {
      "project_name": "bottlenecks",
      "scenario": "os-odl_l2-nofeature-ha",
      "stop_date": null,
      "trust_indicator": null,
      "case_name": "posca_stress_ping",
      "build_tag": "bottlenecks-compass-posca_stress_ping-baremetal-daily-master",
      "version": "master",
      "pod_name": "huawei-pod2",
      "criteria": "PASS",
      "installer": "compass",
      "_id": "58cf4d3e32c829000a1150a8",
      "start_date": "2017-3-9 4:33:04",
      "details": {}
    }

For more information, please refer to: https://wiki.opnfv.org/display/testing/Result+alignment+for+ELK+post-processing

Open JIRA tickets
=================

+------------------+-----------------------------------------------+
|   JIRA           |         Description                           |
+==================+===============================================+
| BOTTLENECK-103   | Refactoring the Bottlenecks tesing workflow   |
+------------------+-----------------------------------------------+
| BOTTLENECK-135   | Avoiding docker-compose building new image    |
|                  | for Bottlenecks                               |
+------------------+-----------------------------------------------+
| BOTTLENECK-147   | Investigting why calling remote docker client |
+------------------+-----------------------------------------------+


Useful links
============

 - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks

 - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/

 - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/

 - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks

 - Bottlenecks IRC chanel: #opnfv-bottlenecks