[DMAAP-BC] Release notes for kohn
[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 Kohn
20 ====
21
22 Abstract
23 --------
24 This document provides the release notes for the Kohn release.
25
26 Summary
27 -------
28 No change
29
30 Release Data
31 ------------
32 +--------------------------------------+--------------------------------------+
33 | **DMaaP Bus Controller Project**     |                                      |
34 |                                      |                                      |
35 +--------------------------------------+--------------------------------------+
36 | **Docker images**                    | - dmaap-bc 2.0.10                    |
37 |                                      | - dbc-client 2.0.10                  |
38 +--------------------------------------+--------------------------------------+
39 | **Release designation**              | 11.0.0 Kohn                          |
40 |                                      |                                      |
41 +--------------------------------------+--------------------------------------+
42 | **Release date**                     | TBD                                  |
43 |                                      |                                      |
44 +--------------------------------------+--------------------------------------+
45
46
47 New features
48 ------------
49 NA
50
51 Known Limitations, Issues and Workarounds
52 -----------------------------------------
53
54 System Limitations
55 ------------------
56
57
58 Known Vulnerabilities
59 ---------------------
60
61
62 Workarounds
63 -----------
64
65
66 Security Notes
67 --------------
68
69
70 References
71 ----------
72
73 For more information on the ONAP Kohn release, please see:
74
75 #. `ONAP Home Page`_
76 #. `ONAP Documentation`_
77 #. `ONAP Release Downloads`_
78 #. `ONAP Wiki Page`_
79
80
81 .. _`ONAP Home Page`: https://www.onap.org
82 .. _`ONAP Wiki Page`: https://wiki.onap.org
83 .. _`ONAP Documentation`: https://docs.onap.org
84 .. _`ONAP Release Downloads`: https://git.onap.org
85
86
87 Quick Links:
88
89 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
90 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
91
92
93 Jakarta
94 =======
95
96 Abstract
97 --------
98 This document provides the release notes for the Jakarta release.
99
100 Summary
101 -------
102 No change
103
104 Release Data
105 ------------
106 +--------------------------------------+--------------------------------------+
107 | **DMaaP Bus Controller Project**     |                                      |
108 |                                      |                                      |
109 +--------------------------------------+--------------------------------------+
110 | **Docker images**                    | - dmaap-bc 2.0.8                     |
111 |                                      | - dbc-client 2.0.9                   |
112 +--------------------------------------+--------------------------------------+
113 | **Release designation**              | 10.0.0 Jakarta                       |
114 |                                      |                                      |
115 +--------------------------------------+--------------------------------------+
116 | **Release date**                     | 5/12/2022                            |
117 |                                      |                                      |
118 +--------------------------------------+--------------------------------------+
119
120
121 New features
122 ------------
123 NA
124
125 Known Limitations, Issues and Workarounds
126 -----------------------------------------
127
128 System Limitations
129 ------------------
130
131
132 Known Vulnerabilities
133 ---------------------
134
135
136 Workarounds
137 -----------
138
139
140 Security Notes
141 --------------
142
143
144 References
145 ----------
146
147 For more information on the ONAP Jakarta release, please see:
148
149 #. `ONAP Home Page`_
150 #. `ONAP Documentation`_
151 #. `ONAP Release Downloads`_
152 #. `ONAP Wiki Page`_
153
154
155 .. _`ONAP Home Page`: https://www.onap.org
156 .. _`ONAP Wiki Page`: https://wiki.onap.org
157 .. _`ONAP Documentation`: https://docs.onap.org
158 .. _`ONAP Release Downloads`: https://git.onap.org
159
160
161 Quick Links:
162
163 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
164 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
165
166
167 Istanbul
168 ========
169
170 Abstract
171 --------
172 This document provides the release notes for the Istanbul release.
173
174 Summary
175 -------
176 Repo merges, package updates and dbc-clients changes
177
178 Release Data
179 ------------
180 +--------------------------------------+--------------------------------------+
181 | **DMaaP Bus Controller Project**     |                                      |
182 |                                      |                                      |
183 +--------------------------------------+--------------------------------------+
184 | **Docker images**                    | - dmaap-bc 2.0.8                     |
185 |                                      | - dbc-client 2.0.7                   |
186 +--------------------------------------+--------------------------------------+
187 | **Release designation**              | 9.0.0 Istanbul                       |
188 |                                      |                                      |
189 +--------------------------------------+--------------------------------------+
190 | **Release date**                     | 2021-10-14                           |
191 |                                      |                                      |
192 +--------------------------------------+--------------------------------------+
193
194
195 New features
196 ------------
197 * Consolidated BC repos - DMAAP-1544
198 * Package upgrades  - DMAAP-1608
199 * Update dbc-client script - DMAAP-1561
200
201 Known Limitations, Issues and Workarounds
202 -----------------------------------------
203
204 System Limitations
205 ------------------
206
207
208 Known Vulnerabilities
209 ---------------------
210
211
212 Workarounds
213 -----------
214
215
216 Security Notes
217 --------------
218
219
220 References
221 ----------
222
223 For more information on the ONAP Honolulu release, please see:
224
225 #. `ONAP Home Page`_
226 #. `ONAP Documentation`_
227 #. `ONAP Release Downloads`_
228 #. `ONAP Wiki Page`_
229
230
231 .. _`ONAP Home Page`: https://www.onap.org
232 .. _`ONAP Wiki Page`: https://wiki.onap.org
233 .. _`ONAP Documentation`: https://docs.onap.org
234 .. _`ONAP Release Downloads`: https://git.onap.org
235
236
237 Quick Links:
238
239 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
240 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
241
242
243 Honolulu
244 ========
245
246
247 Abstract
248 --------
249
250 This document provides the release notes for the Honolulu release.
251
252
253 Summary
254 -------
255
256 Mainly Security changes to update Project Lead details, and update outdated packages
257
258 Release Data
259 ------------
260
261 +--------------------------------------+--------------------------------------+
262 | **DMaaP Bus Controller Project**     |                                      |
263 |                                      |                                      |
264 +--------------------------------------+--------------------------------------+
265 | **Docker images**                    | - dmaap-bc 2.0.5                     |
266 |                                      | - dbc-client 1.0.9                   |
267 +--------------------------------------+--------------------------------------+
268 | **Release designation**              | 8.0.0 Honolulu                       |
269 |                                      |                                      |
270 +--------------------------------------+--------------------------------------+
271 | **Release date**                     | 2021-04-01 (TBD)                     |
272 |                                      |                                      |
273 +--------------------------------------+--------------------------------------+
274
275
276 New features
277 ------------
278 * Updated log4j (Listed in "Known Vulternabilities" below) - DMAAP-1515
279 * Update Project Lead details - DMAAP-1538
280
281 Known Limitations, Issues and Workarounds
282 -----------------------------------------
283
284 System Limitations
285 ------------------
286
287
288 Known Vulnerabilities
289 ---------------------
290
291 * CVE-2019-17571
292
293 Workarounds
294 -----------
295
296
297 Security Notes
298 --------------
299
300
301 References
302 ----------
303
304 For more information on the ONAP Honolulu release, please see:
305
306 #. `ONAP Home Page`_
307 #. `ONAP Documentation`_
308 #. `ONAP Release Downloads`_
309 #. `ONAP Wiki Page`_
310
311
312 .. _`ONAP Home Page`: https://www.onap.org
313 .. _`ONAP Wiki Page`: https://wiki.onap.org
314 .. _`ONAP Documentation`: https://docs.onap.org
315 .. _`ONAP Release Downloads`: https://git.onap.org
316
317
318 Quick Links:
319
320 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
321
322 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
323
324 Guilin
325 ======
326
327 Abstract
328 --------
329
330
331 This document provides the release notes for the Guilin release.
332
333
334 Summary
335 -------
336
337 Release Data
338 ------------
339
340 +--------------------------------------+--------------------------------------+
341 | **DMaaP Bus Controller Project**     |                                      |
342 |                                      |                                      |
343 +--------------------------------------+--------------------------------------+
344 | **Docker images**                    | - dmaap-bc 2.0.4                     |
345 |                                      | - dbc-client 1.0.9                   |
346 +--------------------------------------+--------------------------------------+
347 | **Release designation**              | 7.0.0 guilin                         |
348 |                                      |                                      |
349 +--------------------------------------+--------------------------------------+
350 | **Release date**                     | 2020-11-18                           |
351 |                                      |                                      |
352 +--------------------------------------+--------------------------------------+
353
354
355 New features
356 ------------
357
358 Known Limitations, Issues and Workarounds
359 -----------------------------------------
360
361 System Limitations
362 ------------------
363
364
365 Known Vulnerabilities
366 ---------------------
367
368 * CVE-2018-11307
369 * CVE-2018-12022
370 * CVE-2018-12023
371 * CVE-2019-17571
372 * CVE-2016-2510
373 * CVE-2017-18640
374
375
376 Workarounds
377 -----------
378
379
380 Security Notes
381 --------------
382
383
384 References
385 ----------
386
387 For more information on the ONAP Guilin release, please see:
388
389 #. `ONAP Home Page`_
390 #. `ONAP Documentation`_
391 #. `ONAP Release Downloads`_
392 #. `ONAP Wiki Page`_
393
394
395 .. _`ONAP Home Page`: https://www.onap.org
396 .. _`ONAP Wiki Page`: https://wiki.onap.org
397 .. _`ONAP Documentation`: https://docs.onap.org
398 .. _`ONAP Release Downloads`: https://git.onap.org
399
400
401 Quick Links:
402
403 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
404
405 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
406
407 Frankfurt
408 =========
409
410
411 Abstract
412 --------
413
414
415 This document provides the release notes for the Frankfurt release.
416
417
418 Summary
419 -------
420
421 The Frankfurt release focused on improved packaging and deployment.
422
423 Release Data
424 ------------
425
426 +--------------------------------------+--------------------------------------+
427 | **DMaaP Bus Controller Project**     |                                      |
428 |                                      |                                      |
429 +--------------------------------------+--------------------------------------+
430 | **Docker images**                    | - dmaap-bc 2.0.4                     |
431 |                                      | - dbc-client 1.0.9                   |
432 +--------------------------------------+--------------------------------------+
433 | **Release designation**              | 6.0.0 frankfurt                      |
434 |                                      |                                      |
435 +--------------------------------------+--------------------------------------+
436 | **Release date**                     | 2020-05-14 (TBD)                     |
437 |                                      |                                      |
438 +--------------------------------------+--------------------------------------+
439
440
441 New features
442 ------------
443
444 * Implement boolean flag in OOM to disable HTTP ports
445 * Dynamic cert distribution from OOM AAF.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
446 * the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
447
448
449 Known Limitations, Issues and Workarounds
450 -----------------------------------------
451
452
453 System Limitations
454 ------------------
455
456
457 Known Vulnerabilities
458 ---------------------
459
460 * CVE-2018-11307
461 * CVE-2018-12022
462 * CVE-2018-12023
463 * CVE-2019-17571
464 * CVE-2016-2510
465 * CVE-2017-18640
466
467
468 Workarounds
469 -----------
470
471
472 Security Notes
473 --------------
474
475
476 References
477 ----------
478
479 For more information on the ONAP Frankfurt release, please see:
480
481 #. `ONAP Home Page`_
482 #. `ONAP Documentation`_
483 #. `ONAP Release Downloads`_
484 #. `ONAP Wiki Page`_
485
486
487 .. _`ONAP Home Page`: https://www.onap.org
488 .. _`ONAP Wiki Page`: https://wiki.onap.org
489 .. _`ONAP Documentation`: https://docs.onap.org
490 .. _`ONAP Release Downloads`: https://git.onap.org
491
492
493 Quick Links:
494
495 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
496
497 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
498
499 El Alto
500 =======
501
502 Version: 1.1.5 
503 --------------
504
505 :Release Date: 2019-06-06 (El Alto)
506
507 **New Features**
508
509  - No new features
510
511 **Bug Fixes**
512        NA
513
514 **Known Issues**
515        NA
516
517 **Security Notes**
518 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>`_.
519
520 Quick Links:
521
522 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
523
524 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
525
526 - `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
527
528 **Upgrade Notes**
529        NA
530
531 **Deprecation Notes**
532        NA
533         
534
535 Dublin
536 ======
537
538 Version: 1.1.5
539 --------------
540
541 :Release Date: 2019-06-06
542
543 **New Features**
544
545  - DMaaP Provisioning via Bus Controller
546
547 **Bug Fixes**
548        NA
549
550 **Known Issues**
551        NA
552
553 **Security Notes**
554 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>`_.
555
556 Quick Links:
557
558 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
559
560 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
561
562 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
563
564 **Upgrade Notes**
565 NA
566
567 **Deprecation Notes**
568
569
570 Casablanca
571 ==========
572
573 Version: 1.0.23
574 ---------------
575
576 :Release Date: 2018-10-18
577
578 **New Features**
579
580  - configMap for properties
581  - AAF integration
582
583 **Bug Fixes**
584        NA
585
586 **Known Issues**
587        NA
588
589 **Security Notes**
590 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>`_.
591
592 Quick Links:
593
594 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
595
596 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
597
598 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
599
600 **Upgrade Notes**
601 NA
602
603 **Deprecation Notes**