[DMAAP-BC] Update release notes
[dmaap/buscontroller.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
4 .. _release_notes:
5
6 =============
7 Release Notes
8 =============
9
10 .. note
11 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
12 ..      * The scope of these Release Notes are for ONAP DMaaP Buscontroller. In other words, each ONAP component has its Release Notes.
13 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
14 ..      * this Release Notes.
15 ..      * Except the date and the version number, all the other sections are optional but there must be at least
16 ..      * one section describing the purpose of this new release.
17 ..      * This note must be removed after content has been added.
18
19
20 Istanbul
21 ========
22
23 Abstract
24 --------
25 This document provides the release notes for the Istanbul release.
26
27 Summary
28 -------
29 Repo merges, package updates and dbc-clients changes
30
31 Release Data
32 ------------
33 +--------------------------------------+--------------------------------------+
34 | **DMaaP Bus Controller Project**     |                                      |
35 |                                      |                                      |
36 +--------------------------------------+--------------------------------------+
37 | **Docker images**                    | - dmaap-bc 2.0.8                     |
38 |                                      | - dbc-client 2.0.7                   |
39 +--------------------------------------+--------------------------------------+
40 | **Release designation**              | 9.0.0 Istanbul                       |
41 |                                      |                                      |
42 +--------------------------------------+--------------------------------------+
43 | **Release date**                     | 2021-10-14                           |
44 |                                      |                                      |
45 +--------------------------------------+--------------------------------------+
46
47
48 New features
49 ------------
50 * Consolidated BC repos - DMAAP-1544
51 * Package upgrades  - DMAAP-1608
52 * Update dbc-client script - DMAAP-1561
53
54 Known Limitations, Issues and Workarounds
55 -----------------------------------------
56
57 System Limitations
58 ------------------
59
60
61 Known Vulnerabilities
62 ---------------------
63
64
65 Workarounds
66 -----------
67
68
69 Security Notes
70 --------------
71
72
73 References
74 ----------
75
76 For more information on the ONAP Honolulu release, please see:
77
78 #. `ONAP Home Page`_
79 #. `ONAP Documentation`_
80 #. `ONAP Release Downloads`_
81 #. `ONAP Wiki Page`_
82
83
84 .. _`ONAP Home Page`: https://www.onap.org
85 .. _`ONAP Wiki Page`: https://wiki.onap.org
86 .. _`ONAP Documentation`: https://docs.onap.org
87 .. _`ONAP Release Downloads`: https://git.onap.org
88
89
90 Quick Links:
91
92 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
93 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
94
95
96 Honolulu
97 ========
98
99
100 Abstract
101 --------
102
103 This document provides the release notes for the Honolulu release.
104
105
106 Summary
107 -------
108
109 Mainly Security changes to update Project Lead details, and update outdated packages
110
111 Release Data
112 ------------
113
114 +--------------------------------------+--------------------------------------+
115 | **DMaaP Bus Controller Project**     |                                      |
116 |                                      |                                      |
117 +--------------------------------------+--------------------------------------+
118 | **Docker images**                    | - dmaap-bc 2.0.5                     |
119 |                                      | - dbc-client 1.0.9                   |
120 +--------------------------------------+--------------------------------------+
121 | **Release designation**              | 8.0.0 Honolulu                       |
122 |                                      |                                      |
123 +--------------------------------------+--------------------------------------+
124 | **Release date**                     | 2021-04-01 (TBD)                     |
125 |                                      |                                      |
126 +--------------------------------------+--------------------------------------+
127
128
129 New features
130 ------------
131 * Updated log4j (Listed in "Known Vulternabilities" below) - DMAAP-1515
132 * Update Project Lead details - DMAAP-1538
133
134 Known Limitations, Issues and Workarounds
135 -----------------------------------------
136
137 System Limitations
138 ------------------
139
140
141 Known Vulnerabilities
142 ---------------------
143
144 * CVE-2019-17571
145
146 Workarounds
147 -----------
148
149
150 Security Notes
151 --------------
152
153
154 References
155 ----------
156
157 For more information on the ONAP Honolulu release, please see:
158
159 #. `ONAP Home Page`_
160 #. `ONAP Documentation`_
161 #. `ONAP Release Downloads`_
162 #. `ONAP Wiki Page`_
163
164
165 .. _`ONAP Home Page`: https://www.onap.org
166 .. _`ONAP Wiki Page`: https://wiki.onap.org
167 .. _`ONAP Documentation`: https://docs.onap.org
168 .. _`ONAP Release Downloads`: https://git.onap.org
169
170
171 Quick Links:
172
173 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
174
175 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
176
177 Guilin
178 ======
179
180 Abstract
181 --------
182
183
184 This document provides the release notes for the Guilin release.
185
186
187 Summary
188 -------
189
190 Release Data
191 ------------
192
193 +--------------------------------------+--------------------------------------+
194 | **DMaaP Bus Controller Project**     |                                      |
195 |                                      |                                      |
196 +--------------------------------------+--------------------------------------+
197 | **Docker images**                    | - dmaap-bc 2.0.4                     |
198 |                                      | - dbc-client 1.0.9                   |
199 +--------------------------------------+--------------------------------------+
200 | **Release designation**              | 7.0.0 guilin                         |
201 |                                      |                                      |
202 +--------------------------------------+--------------------------------------+
203 | **Release date**                     | 2020-11-18                           |
204 |                                      |                                      |
205 +--------------------------------------+--------------------------------------+
206
207
208 New features
209 ------------
210
211 Known Limitations, Issues and Workarounds
212 -----------------------------------------
213
214 System Limitations
215 ------------------
216
217
218 Known Vulnerabilities
219 ---------------------
220
221 * CVE-2018-11307
222 * CVE-2018-12022
223 * CVE-2018-12023
224 * CVE-2019-17571
225 * CVE-2016-2510
226 * CVE-2017-18640
227
228
229 Workarounds
230 -----------
231
232
233 Security Notes
234 --------------
235
236
237 References
238 ----------
239
240 For more information on the ONAP Guilin release, please see:
241
242 #. `ONAP Home Page`_
243 #. `ONAP Documentation`_
244 #. `ONAP Release Downloads`_
245 #. `ONAP Wiki Page`_
246
247
248 .. _`ONAP Home Page`: https://www.onap.org
249 .. _`ONAP Wiki Page`: https://wiki.onap.org
250 .. _`ONAP Documentation`: https://docs.onap.org
251 .. _`ONAP Release Downloads`: https://git.onap.org
252
253
254 Quick Links:
255
256 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
257
258 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
259
260 Frankfurt
261 =========
262
263
264 Abstract
265 --------
266
267
268 This document provides the release notes for the Frankfurt release.
269
270
271 Summary
272 -------
273
274 The Frankfurt release focused on improved packaging and deployment.
275
276 Release Data
277 ------------
278
279 +--------------------------------------+--------------------------------------+
280 | **DMaaP Bus Controller Project**     |                                      |
281 |                                      |                                      |
282 +--------------------------------------+--------------------------------------+
283 | **Docker images**                    | - dmaap-bc 2.0.4                     |
284 |                                      | - dbc-client 1.0.9                   |
285 +--------------------------------------+--------------------------------------+
286 | **Release designation**              | 6.0.0 frankfurt                      |
287 |                                      |                                      |
288 +--------------------------------------+--------------------------------------+
289 | **Release date**                     | 2020-05-14 (TBD)                     |
290 |                                      |                                      |
291 +--------------------------------------+--------------------------------------+
292
293
294 New features
295 ------------
296
297 * Implement boolean flag in OOM to disable HTTP ports
298 * Dynamic cert distribution from OOM AAF.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
299 * the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
300
301
302 Known Limitations, Issues and Workarounds
303 -----------------------------------------
304
305
306 System Limitations
307 ------------------
308
309
310 Known Vulnerabilities
311 ---------------------
312
313 * CVE-2018-11307
314 * CVE-2018-12022
315 * CVE-2018-12023
316 * CVE-2019-17571
317 * CVE-2016-2510
318 * CVE-2017-18640
319
320
321 Workarounds
322 -----------
323
324
325 Security Notes
326 --------------
327
328
329 References
330 ----------
331
332 For more information on the ONAP Frankfurt release, please see:
333
334 #. `ONAP Home Page`_
335 #. `ONAP Documentation`_
336 #. `ONAP Release Downloads`_
337 #. `ONAP Wiki Page`_
338
339
340 .. _`ONAP Home Page`: https://www.onap.org
341 .. _`ONAP Wiki Page`: https://wiki.onap.org
342 .. _`ONAP Documentation`: https://docs.onap.org
343 .. _`ONAP Release Downloads`: https://git.onap.org
344
345
346 Quick Links:
347
348 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
349
350 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
351
352 El Alto
353 =======
354
355 Version: 1.1.5 
356 --------------
357
358 :Release Date: 2019-06-06 (El Alto)
359
360 **New Features**
361
362  - No new features
363
364 **Bug Fixes**
365        NA
366
367 **Known Issues**
368        NA
369
370 **Security Notes**
371 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
372
373 Quick Links:
374
375 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
376
377 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
378
379 - `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
380
381 **Upgrade Notes**
382        NA
383
384 **Deprecation Notes**
385        NA
386         
387
388 Dublin
389 ======
390
391 Version: 1.1.5
392 --------------
393
394 :Release Date: 2019-06-06
395
396 **New Features**
397
398  - DMaaP Provisioning via Bus Controller
399
400 **Bug Fixes**
401        NA
402
403 **Known Issues**
404        NA
405
406 **Security Notes**
407 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
408
409 Quick Links:
410
411 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
412
413 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
414
415 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
416
417 **Upgrade Notes**
418 NA
419
420 **Deprecation Notes**
421
422
423 Casablanca
424 ==========
425
426 Version: 1.0.23
427 ---------------
428
429 :Release Date: 2018-10-18
430
431 **New Features**
432
433  - configMap for properties
434  - AAF integration
435
436 **Bug Fixes**
437        NA
438
439 **Known Issues**
440        NA
441
442 **Security Notes**
443 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_.
444
445 Quick Links:
446
447 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
448
449 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
450
451 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
452
453 **Upgrade Notes**
454 NA
455
456 **Deprecation Notes**