Apply docs strucutre to Danube agreement
[bottlenecks.git] / 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, 2016 |  1.1               | Bottlenecks Danube release 1.0  |
42 |                |                    |                                 |
43 +----------------+--------------------+---------------------------------+
44
45
46 Summary
47 =======
48
49 * Documentation generated with Sphinx
50
51   * User guide
52
53   * Installation Procedure
54
55   * Release Notes (this document)
56
57   * Platform Overview
58
59   * Configuration Guide
60
61 * Bottlenecks test suite
62
63   * Jenkins Jobs for OPNFV community labs
64
65 * Bottlenecks framework
66
67 * Bottlenecks test cases
68
69 The *Bottlenecks software* is developed in the OPNFV community, by the
70 Bottlenecks_ team.
71
72 Release Data
73 ============
74
75 Bramaputra Release Data
76 -----------------------
77
78 +--------------------------------------+--------------------------------------+
79 | **Project**                          | Bottlenecks                          |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82 | **Repo/tag**                         | Bottlenecks/brahmaputra.1.0          |
83 |                                      |                                      |
84 +--------------------------------------+--------------------------------------+
85 | **Bottlenecks Docker image tag**     | brahmaputra.1.0                      |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 | **Release designation**              | Brahmaputra base release             |
89 |                                      |                                      |
90 +--------------------------------------+--------------------------------------+
91 | **Release date**                     | February 25 2016                     |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94 | **Purpose of the delivery**          | Brahmaputra base release             |
95 |                                      |                                      |
96 +--------------------------------------+--------------------------------------+
97
98 Colorado Release Data
99 -----------------------
100
101 +--------------------------------------+--------------------------------------+
102 | **Project**                          | Bottlenecks                          |
103 |                                      |                                      |
104 +--------------------------------------+--------------------------------------+
105 | **Repo/tag**                         | Bottlenecks/colorado.1.0             |
106 |                                      |                                      |
107 +--------------------------------------+--------------------------------------+
108 | **Bottlenecks Docker image tag**     | colorado.1.0                         |
109 |                                      |                                      |
110 +--------------------------------------+--------------------------------------+
111 | **Release designation**              | Colorado base release                |
112 |                                      |                                      |
113 +--------------------------------------+--------------------------------------+
114 | **Release date**                     | September 22 2016                    |
115 |                                      |                                      |
116 +--------------------------------------+--------------------------------------+
117 | **Purpose of the delivery**          | Colorado base release                |
118 |                                      |                                      |
119 +--------------------------------------+--------------------------------------+
120
121 Colorado Release Data
122 -----------------------
123 * TODO
124
125 Danube Deliverables
126 ===================
127
128 Software Deliverables
129 ---------------------
130
131 **Bottlenecks source code <danube.1.0>**
132
133 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
134
135
136 Documentatiion Deliverables
137 ---------------------------
138
139 **Bottlenecks documentation <danube.1.0>**
140
141 * Platformation Overview: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/platformoverview/index.html
142 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/configurationguide/index.html
143 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/danube/docs/installationprocedure/index.html
144 * http://artifacts.opnfv.org/bottlenecks/danube/1.0/releasenotes/index.html
145 * User Guide: http://artifacts.opnfv.org/bottlenecks/danube/1.0/docs/userguide/index.html
146
147 Colorado Deliverables
148 =====================
149
150 Software Deliverables
151 ---------------------
152
153 **Bottlenecks source code <colorado.1.0>**
154
155 * https://gerrit.opnfv.org/gerrit/gitweb?p=bottlenecks.git;a=summary
156
157
158 Documentatiion Deliverables
159 ---------------------------
160
161 **Bottlenecks documentation <colorado.1.0>**
162
163 * Platformation Overview: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/platformoverview/index.html
164 * Configuration Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/configurationguide/index.html
165 * Installation Guide: http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html
166 * http://artifacts.opnfv.org/bottlenecks/colorado/1.0/releasenotes/index.html
167 * User Guide: http://artifacts.opnfv.org/bottlenecks/colorado/1.0/docs/userguide/index.html
168
169 Reason for Version
170 ==================
171
172 * In Danube, POSCA testsuite is introduced and two stress tests are implemented.
173 * In Colorado, rubbos is refactored by using puppet, which makes it quite flexible to configure with different number of load generator(Client), worker(tomcat).
174 * In Colorado, vstf is refactored by extracting the test case's configuration information.
175
176
177 Known restrictions/issues
178 =========================
179
180 * TODO
181
182
183 Test results
184 ============
185
186 Test results are available in:
187
188  - jenkins logs on CI: https://build.opnfv.org/ci/view/bottlenecks/
189
190
191 Open JIRA tickets
192 =================
193
194 +------------------+-----------------------------------------------+
195 |   JIRA           |         Description                           |
196 +==================+===============================================+
197 +------------------+-----------------------------------------------+
198 +------------------+-----------------------------------------------+
199 +------------------+-----------------------------------------------+
200 +------------------+-----------------------------------------------+
201 +------------------+-----------------------------------------------+
202
203
204 Useful links
205 ============
206
207  - WIKI project page: https://wiki.opnfv.org/display/Bottlenecks
208
209  - Bottlenecks jira page: https://jira.opnfv.org/projects/BOTTLENECK/issues/
210
211  - Bottlenecks repo: https://git.opnfv.org/cgit/bottlenecks/
212
213  - Bottlenecks CI dashboard: https://build.opnfv.org/ci/view/bottlenecks
214
215  - Bottlenecks IRC chanel: #opnfv-bottlenecks
216
217