update link to upper-constraints.txt
[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 London
20 ======
21
22 Abstract
23 --------
24 This document provides the release notes for the London 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.12                    |
37 |                                      | - dbc-client 2.0.12                  |
38 +--------------------------------------+--------------------------------------+
39 | **Release designation**              | 12.0.0 London                        |
40 |                                      |                                      |
41 +--------------------------------------+--------------------------------------+
42 | **Release date**                     | TBD                                  |
43 |                                      |                                      |
44 +--------------------------------------+--------------------------------------+
45
46
47 New features
48 ------------
49 Vulnerability upgrades fro London - DMAAP-1844
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 London 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 Kohn
94 ====
95
96 Abstract
97 --------
98 This document provides the release notes for the Kohn 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.10                    |
111 |                                      | - dbc-client 2.0.10                  |
112 +--------------------------------------+--------------------------------------+
113 | **Release designation**              | 11.0.0 Kohn                          |
114 |                                      |                                      |
115 +--------------------------------------+--------------------------------------+
116 | **Release date**                     | 2022-12-05                           |
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 Kohn 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 Jakarta
168 =======
169
170 Abstract
171 --------
172 This document provides the release notes for the Jakarta release.
173
174 Summary
175 -------
176 No change
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.9                   |
186 +--------------------------------------+--------------------------------------+
187 | **Release designation**              | 10.0.0 Jakarta                       |
188 |                                      |                                      |
189 +--------------------------------------+--------------------------------------+
190 | **Release date**                     | 5/12/2022                            |
191 |                                      |                                      |
192 +--------------------------------------+--------------------------------------+
193
194
195 New features
196 ------------
197 NA
198
199 Known Limitations, Issues and Workarounds
200 -----------------------------------------
201
202 System Limitations
203 ------------------
204
205
206 Known Vulnerabilities
207 ---------------------
208
209
210 Workarounds
211 -----------
212
213
214 Security Notes
215 --------------
216
217
218 References
219 ----------
220
221 For more information on the ONAP Jakarta release, please see:
222
223 #. `ONAP Home Page`_
224 #. `ONAP Documentation`_
225 #. `ONAP Release Downloads`_
226 #. `ONAP Wiki Page`_
227
228
229 .. _`ONAP Home Page`: https://www.onap.org
230 .. _`ONAP Wiki Page`: https://wiki.onap.org
231 .. _`ONAP Documentation`: https://docs.onap.org
232 .. _`ONAP Release Downloads`: https://git.onap.org
233
234
235 Quick Links:
236
237 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
238 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
239
240
241 Istanbul
242 ========
243
244 Abstract
245 --------
246 This document provides the release notes for the Istanbul release.
247
248 Summary
249 -------
250 Repo merges, package updates and dbc-clients changes
251
252 Release Data
253 ------------
254 +--------------------------------------+--------------------------------------+
255 | **DMaaP Bus Controller Project**     |                                      |
256 |                                      |                                      |
257 +--------------------------------------+--------------------------------------+
258 | **Docker images**                    | - dmaap-bc 2.0.8                     |
259 |                                      | - dbc-client 2.0.7                   |
260 +--------------------------------------+--------------------------------------+
261 | **Release designation**              | 9.0.0 Istanbul                       |
262 |                                      |                                      |
263 +--------------------------------------+--------------------------------------+
264 | **Release date**                     | 2021-10-14                           |
265 |                                      |                                      |
266 +--------------------------------------+--------------------------------------+
267
268
269 New features
270 ------------
271 * Consolidated BC repos - DMAAP-1544
272 * Package upgrades  - DMAAP-1608
273 * Update dbc-client script - DMAAP-1561
274
275 Known Limitations, Issues and Workarounds
276 -----------------------------------------
277
278 System Limitations
279 ------------------
280
281
282 Known Vulnerabilities
283 ---------------------
284
285
286 Workarounds
287 -----------
288
289
290 Security Notes
291 --------------
292
293
294 References
295 ----------
296
297 For more information on the ONAP Honolulu release, please see:
298
299 #. `ONAP Home Page`_
300 #. `ONAP Documentation`_
301 #. `ONAP Release Downloads`_
302 #. `ONAP Wiki Page`_
303
304
305 .. _`ONAP Home Page`: https://www.onap.org
306 .. _`ONAP Wiki Page`: https://wiki.onap.org
307 .. _`ONAP Documentation`: https://docs.onap.org
308 .. _`ONAP Release Downloads`: https://git.onap.org
309
310
311 Quick Links:
312
313 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
314 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
315
316
317 Honolulu
318 ========
319
320
321 Abstract
322 --------
323
324 This document provides the release notes for the Honolulu release.
325
326
327 Summary
328 -------
329
330 Mainly Security changes to update Project Lead details, and update outdated packages
331
332 Release Data
333 ------------
334
335 +--------------------------------------+--------------------------------------+
336 | **DMaaP Bus Controller Project**     |                                      |
337 |                                      |                                      |
338 +--------------------------------------+--------------------------------------+
339 | **Docker images**                    | - dmaap-bc 2.0.5                     |
340 |                                      | - dbc-client 1.0.9                   |
341 +--------------------------------------+--------------------------------------+
342 | **Release designation**              | 8.0.0 Honolulu                       |
343 |                                      |                                      |
344 +--------------------------------------+--------------------------------------+
345 | **Release date**                     | 2021-04-01 (TBD)                     |
346 |                                      |                                      |
347 +--------------------------------------+--------------------------------------+
348
349
350 New features
351 ------------
352 * Updated log4j (Listed in "Known Vulnerabilities" below) - DMAAP-1515
353 * Update Project Lead details - DMAAP-1538
354
355 Known Limitations, Issues and Workarounds
356 -----------------------------------------
357
358 System Limitations
359 ------------------
360
361
362 Known Vulnerabilities
363 ---------------------
364
365 * CVE-2019-17571
366
367 Workarounds
368 -----------
369
370
371 Security Notes
372 --------------
373
374
375 References
376 ----------
377
378 For more information on the ONAP Honolulu release, please see:
379
380 #. `ONAP Home Page`_
381 #. `ONAP Documentation`_
382 #. `ONAP Release Downloads`_
383 #. `ONAP Wiki Page`_
384
385
386 .. _`ONAP Home Page`: https://www.onap.org
387 .. _`ONAP Wiki Page`: https://wiki.onap.org
388 .. _`ONAP Documentation`: https://docs.onap.org
389 .. _`ONAP Release Downloads`: https://git.onap.org
390
391
392 Quick Links:
393
394 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
395
396 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
397
398 Guilin
399 ======
400
401 Abstract
402 --------
403
404
405 This document provides the release notes for the Guilin release.
406
407
408 Summary
409 -------
410
411 Release Data
412 ------------
413
414 +--------------------------------------+--------------------------------------+
415 | **DMaaP Bus Controller Project**     |                                      |
416 |                                      |                                      |
417 +--------------------------------------+--------------------------------------+
418 | **Docker images**                    | - dmaap-bc 2.0.4                     |
419 |                                      | - dbc-client 1.0.9                   |
420 +--------------------------------------+--------------------------------------+
421 | **Release designation**              | 7.0.0 guilin                         |
422 |                                      |                                      |
423 +--------------------------------------+--------------------------------------+
424 | **Release date**                     | 2020-11-18                           |
425 |                                      |                                      |
426 +--------------------------------------+--------------------------------------+
427
428
429 New features
430 ------------
431
432 Known Limitations, Issues and Workarounds
433 -----------------------------------------
434
435 System Limitations
436 ------------------
437
438
439 Known Vulnerabilities
440 ---------------------
441
442 * CVE-2018-11307
443 * CVE-2018-12022
444 * CVE-2018-12023
445 * CVE-2019-17571
446 * CVE-2016-2510
447 * CVE-2017-18640
448
449
450 Workarounds
451 -----------
452
453
454 Security Notes
455 --------------
456
457
458 References
459 ----------
460
461 For more information on the ONAP Guilin release, please see:
462
463 #. `ONAP Home Page`_
464 #. `ONAP Documentation`_
465 #. `ONAP Release Downloads`_
466 #. `ONAP Wiki Page`_
467
468
469 .. _`ONAP Home Page`: https://www.onap.org
470 .. _`ONAP Wiki Page`: https://wiki.onap.org
471 .. _`ONAP Documentation`: https://docs.onap.org
472 .. _`ONAP Release Downloads`: https://git.onap.org
473
474
475 Quick Links:
476
477 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
478
479 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
480
481 Frankfurt
482 =========
483
484
485 Abstract
486 --------
487
488
489 This document provides the release notes for the Frankfurt release.
490
491
492 Summary
493 -------
494
495 The Frankfurt release focused on improved packaging and deployment.
496
497 Release Data
498 ------------
499
500 +--------------------------------------+--------------------------------------+
501 | **DMaaP Bus Controller Project**     |                                      |
502 |                                      |                                      |
503 +--------------------------------------+--------------------------------------+
504 | **Docker images**                    | - dmaap-bc 2.0.4                     |
505 |                                      | - dbc-client 1.0.9                   |
506 +--------------------------------------+--------------------------------------+
507 | **Release designation**              | 6.0.0 frankfurt                      |
508 |                                      |                                      |
509 +--------------------------------------+--------------------------------------+
510 | **Release date**                     | 2020-05-14 (TBD)                     |
511 |                                      |                                      |
512 +--------------------------------------+--------------------------------------+
513
514
515 New features
516 ------------
517
518 * Implement boolean flag in OOM to disable HTTP ports
519 * Dynamic cert distribution from OOM AAF.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
520 * the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
521
522
523 Known Limitations, Issues and Workarounds
524 -----------------------------------------
525
526
527 System Limitations
528 ------------------
529
530
531 Known Vulnerabilities
532 ---------------------
533
534 * CVE-2018-11307
535 * CVE-2018-12022
536 * CVE-2018-12023
537 * CVE-2019-17571
538 * CVE-2016-2510
539 * CVE-2017-18640
540
541
542 Workarounds
543 -----------
544
545
546 Security Notes
547 --------------
548
549
550 References
551 ----------
552
553 For more information on the ONAP Frankfurt release, please see:
554
555 #. `ONAP Home Page`_
556 #. `ONAP Documentation`_
557 #. `ONAP Release Downloads`_
558 #. `ONAP Wiki Page`_
559
560
561 .. _`ONAP Home Page`: https://www.onap.org
562 .. _`ONAP Wiki Page`: https://wiki.onap.org
563 .. _`ONAP Documentation`: https://docs.onap.org
564 .. _`ONAP Release Downloads`: https://git.onap.org
565
566
567 Quick Links:
568
569 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
570
571 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
572
573 El Alto
574 =======
575
576 Version: 1.1.5 
577 --------------
578
579 :Release Date: 2019-06-06 (El Alto)
580
581 **New Features**
582
583  - No new features
584
585 **Bug Fixes**
586        NA
587
588 **Known Issues**
589        NA
590
591 **Security Notes**
592 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>`_.
593
594 Quick Links:
595
596 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
597
598 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
599
600 - `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
601
602 **Upgrade Notes**
603        NA
604
605 **Deprecation Notes**
606        NA
607         
608
609 Dublin
610 ======
611
612 Version: 1.1.5
613 --------------
614
615 :Release Date: 2019-06-06
616
617 **New Features**
618
619  - DMaaP Provisioning via Bus Controller
620
621 **Bug Fixes**
622        NA
623
624 **Known Issues**
625        NA
626
627 **Security Notes**
628 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>`_.
629
630 Quick Links:
631
632 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
633
634 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
635
636 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
637
638 **Upgrade Notes**
639 NA
640
641 **Deprecation Notes**
642
643
644 Casablanca
645 ==========
646
647 Version: 1.0.23
648 ---------------
649
650 :Release Date: 2018-10-18
651
652 **New Features**
653
654  - configMap for properties
655  - AAF integration
656
657 **Bug Fixes**
658        NA
659
660 **Known Issues**
661        NA
662
663 **Security Notes**
664 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>`_.
665
666 Quick Links:
667
668 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
669
670 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
671
672 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
673
674 **Upgrade Notes**
675 NA
676
677 **Deprecation Notes**