d35b9a2b67f799ca228ff78787d0a3e22a17ec9f
[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
101 Abstract
102 --------
103
104
105 This document provides the release notes for the Honolulu release.
106
107
108 Summary
109 -------
110
111 Mainly Security changes to update Project Lead details, and update outdated packages
112
113 Release Data
114 ------------
115
116 +--------------------------------------+--------------------------------------+
117 | **DMaaP Bus Controller Project**     |                                      |
118 |                                      |                                      |
119 +--------------------------------------+--------------------------------------+
120 | **Docker images**                    | - dmaap-bc 2.0.5                     |
121 |                                      | - dbc-client 1.0.9                   |
122 +--------------------------------------+--------------------------------------+
123 | **Release designation**              | 8.0.0 Honolulu                       |
124 |                                      |                                      |
125 +--------------------------------------+--------------------------------------+
126 | **Release date**                     | 2021-04-01 (TBD)                     |
127 |                                      |                                      |
128 +--------------------------------------+--------------------------------------+
129
130
131 New features
132 ------------
133 * Updated log4j (Listed in "Known Vulternabilities" below) - DMAAP-1515
134 * Update Project Lead details - DMAAP-1538
135
136 Known Limitations, Issues and Workarounds
137 -----------------------------------------
138
139 System Limitations
140 ------------------
141
142
143 Known Vulnerabilities
144 ---------------------
145
146 * CVE-2019-17571
147
148 Workarounds
149 -----------
150
151
152 Security Notes
153 --------------
154
155
156 References
157 ----------
158
159 For more information on the ONAP Honolulu release, please see:
160
161 #. `ONAP Home Page`_
162 #. `ONAP Documentation`_
163 #. `ONAP Release Downloads`_
164 #. `ONAP Wiki Page`_
165
166
167 .. _`ONAP Home Page`: https://www.onap.org
168 .. _`ONAP Wiki Page`: https://wiki.onap.org
169 .. _`ONAP Documentation`: https://docs.onap.org
170 .. _`ONAP Release Downloads`: https://git.onap.org
171
172
173 Quick Links:
174
175 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
176
177 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
178
179 Guilin
180 ======
181
182 Abstract
183 --------
184
185
186 This document provides the release notes for the Guilin release.
187
188
189 Summary
190 -------
191
192 Release Data
193 ------------
194
195 +--------------------------------------+--------------------------------------+
196 | **DMaaP Bus Controller Project**     |                                      |
197 |                                      |                                      |
198 +--------------------------------------+--------------------------------------+
199 | **Docker images**                    | - dmaap-bc 2.0.4                     |
200 |                                      | - dbc-client 1.0.9                   |
201 +--------------------------------------+--------------------------------------+
202 | **Release designation**              | 7.0.0 guilin                         |
203 |                                      |                                      |
204 +--------------------------------------+--------------------------------------+
205 | **Release date**                     | 2020-11-18                           |
206 |                                      |                                      |
207 +--------------------------------------+--------------------------------------+
208
209
210 New features
211 ------------
212
213 Known Limitations, Issues and Workarounds
214 -----------------------------------------
215
216 System Limitations
217 ------------------
218
219
220 Known Vulnerabilities
221 ---------------------
222
223 * CVE-2018-11307
224 * CVE-2018-12022
225 * CVE-2018-12023
226 * CVE-2019-17571
227 * CVE-2016-2510
228 * CVE-2017-18640
229
230
231 Workarounds
232 -----------
233
234
235 Security Notes
236 --------------
237
238
239 References
240 ----------
241
242 For more information on the ONAP Guilin release, please see:
243
244 #. `ONAP Home Page`_
245 #. `ONAP Documentation`_
246 #. `ONAP Release Downloads`_
247 #. `ONAP Wiki Page`_
248
249
250 .. _`ONAP Home Page`: https://www.onap.org
251 .. _`ONAP Wiki Page`: https://wiki.onap.org
252 .. _`ONAP Documentation`: https://docs.onap.org
253 .. _`ONAP Release Downloads`: https://git.onap.org
254
255
256 Quick Links:
257
258 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
259
260 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
261
262 Frankfurt
263 =========
264
265
266 Abstract
267 --------
268
269
270 This document provides the release notes for the Frankfurt release.
271
272
273 Summary
274 -------
275
276 The Frankfurt release focused on improved packaging and deployment.
277
278 Release Data
279 ------------
280
281 +--------------------------------------+--------------------------------------+
282 | **DMaaP Bus Controller Project**     |                                      |
283 |                                      |                                      |
284 +--------------------------------------+--------------------------------------+
285 | **Docker images**                    | - dmaap-bc 2.0.4                     |
286 |                                      | - dbc-client 1.0.9                   |
287 +--------------------------------------+--------------------------------------+
288 | **Release designation**              | 6.0.0 frankfurt                      |
289 |                                      |                                      |
290 +--------------------------------------+--------------------------------------+
291 | **Release date**                     | 2020-05-14 (TBD)                     |
292 |                                      |                                      |
293 +--------------------------------------+--------------------------------------+
294
295
296 New features
297 ------------
298
299 * Implement boolean flag in OOM to disable HTTP ports
300 * Dynamic cert distribution from OOM AAF.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
301 * the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
302
303
304 Known Limitations, Issues and Workarounds
305 -----------------------------------------
306
307
308 System Limitations
309 ------------------
310
311
312 Known Vulnerabilities
313 ---------------------
314
315 * CVE-2018-11307
316 * CVE-2018-12022
317 * CVE-2018-12023
318 * CVE-2019-17571
319 * CVE-2016-2510
320 * CVE-2017-18640
321
322
323 Workarounds
324 -----------
325
326
327 Security Notes
328 --------------
329
330
331 References
332 ----------
333
334 For more information on the ONAP Frankfurt release, please see:
335
336 #. `ONAP Home Page`_
337 #. `ONAP Documentation`_
338 #. `ONAP Release Downloads`_
339 #. `ONAP Wiki Page`_
340
341
342 .. _`ONAP Home Page`: https://www.onap.org
343 .. _`ONAP Wiki Page`: https://wiki.onap.org
344 .. _`ONAP Documentation`: https://docs.onap.org
345 .. _`ONAP Release Downloads`: https://git.onap.org
346
347
348 Quick Links:
349
350 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
351
352 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
353
354 El Alto
355 =======
356
357 Version: 1.1.5 
358 --------------
359
360 : Release Date: 2019-06-06 (El Alto)
361
362 **New Features**
363
364  - No new features
365
366 **Bug Fixes**
367        NA
368
369 **Known Issues**
370        NA
371
372 **Security Notes**
373 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>`_.
374
375 Quick Links:
376
377 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
378
379 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
380
381 - `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
382
383 **Upgrade Notes**
384        NA
385
386 **Deprecation Notes**
387        NA
388         
389
390
391 Version: 1.1.5 (Dublin)
392 -----------------------
393 : Release Date: 2019-06-06
394
395 **New Features**
396
397  - DMaaP Provisioning via Bus Controller
398
399 **Bug Fixes**
400        NA
401
402 **Known Issues**
403        NA
404
405 **Security Notes**
406 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>`_.
407
408 Quick Links:
409
410 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
411
412 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
413
414 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
415
416 **Upgrade Notes**
417 NA
418
419 **Deprecation Notes**
420
421
422 Version: 1.0.23
423 ---------------
424 : Release Date: 2018-10-18
425
426 **New Features**
427
428  - configMap for properties
429  - AAF integration
430
431 **Bug Fixes**
432        NA
433
434 **Known Issues**
435        NA
436
437 **Security Notes**
438 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>`_.
439
440 Quick Links:
441
442 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
443
444 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
445
446 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
447
448 **Upgrade Notes**
449 NA
450
451 **Deprecation Notes**