[DMAAP-MR] Istanbul maintenance release notes
[dmaap/messagerouter/messageservice.git] / docs / 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 .. _release_notes:
4
5 ..      ======================================
6 ..      * * *    ISTANBUL MAINTENANCE    * * *
7 ..      ======================================
8
9 =============
10 Release Notes
11 =============
12
13 Istanbul Maintenance
14 ========
15
16 Abstract
17 --------
18
19 This document provides the DMaaP Message Router release notes for the Istanbul release.
20
21 Summary
22 -------
23
24 Securities Issues addressed
25
26 Release Data
27 ------------
28
29 +--------------------------------------+--------------------------------------+
30 | **DMaaP Message Router Project**     |                                      |
31 |                                      |                                      |
32 +--------------------------------------+--------------------------------------+
33 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.3.2          |
34 |                                      | - onap/dmaap/kafka111:1.1.1          |
35 |                                      | - onap/dmaap/zookeeper:6.1.0         |
36 |                                      |                                      |
37 +--------------------------------------+--------------------------------------+
38 | **Release designation**              | 9.0.1 Istanbul Maintenance           |
39 |                                      |                                      |
40 +--------------------------------------+--------------------------------------+
41 | **Release date**                     | 2022-02-17                           |
42 |                                      |                                      |
43 +--------------------------------------+--------------------------------------+
44
45
46 New features
47 ------------
48 * Remediate log4j bug (DMAAP-1691)
49
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 Guilin 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 Quick Links:
87 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
88 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
89
90
91 ..      ===========================
92 ..      * * *    ISTANBUL     * * *
93 ..      ===========================
94
95 =============
96 Release Notes
97 =============
98
99 Istanbul
100 ========
101
102 Abstract
103 --------
104
105 This document provides the DMaaP Message Router release notes for the Istanbul release.
106
107 Summary
108 -------
109
110 Securities Issues addressed
111
112 Release Data
113 ------------
114
115 +--------------------------------------+--------------------------------------+
116 | **DMaaP Message Router Project**     |                                      |
117 |                                      |                                      |
118 +--------------------------------------+--------------------------------------+
119 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.3.0          |
120 |                                      | - onap/dmaap/kafka111:1.1.1          |
121 |                                      | - onap/dmaap/zookeeper:6.1.0         |
122 |                                      |                                      |
123 +--------------------------------------+--------------------------------------+
124 | **Release designation**              | 9.0.0 Istanbul                       |
125 |                                      |                                      |
126 +--------------------------------------+--------------------------------------+
127 | **Release date**                     | 2021-10-14                           |
128 |                                      |                                      |
129 +--------------------------------------+--------------------------------------+
130
131
132 New features
133 ------------
134 * Consolidate msgrtr and message-service repos (DMAAP-1582)
135 * Remove redundant data (DMAAP-1638)
136 * Sonar fixes (DMAAP-1564)
137 * Remove Python 2.7 (DMAAP-1489)
138 * Sec vulnerabilities fix (DMAAP-1608)
139
140 Known Limitations, Issues and Workarounds
141 -----------------------------------------
142
143 System Limitations
144 ------------------
145
146
147 Known Vulnerabilities
148 ---------------------
149
150
151 Workarounds
152 -----------
153
154
155 Security Notes
156 --------------
157
158
159 References
160 ----------
161
162 For more information on the ONAP Guilin release, please see:
163
164 #. `ONAP Home Page`_
165 #. `ONAP Documentation`_
166 #. `ONAP Release Downloads`_
167 #. `ONAP Wiki Page`_
168
169
170 .. _`ONAP Home Page`: https://www.onap.org
171 .. _`ONAP Wiki Page`: https://wiki.onap.org
172 .. _`ONAP Documentation`: https://docs.onap.org
173 .. _`ONAP Release Downloads`: https://git.onap.org
174
175 Quick Links:
176 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
177 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
178
179
180 ..      ===========================
181 ..      * * *    HONOLULU    * * *
182 ..      ===========================
183
184 Honolulu
185 ========
186
187 Abstract
188 --------
189
190 This document provides the DMaaP Message Router release notes for the Honolulu release.
191
192 Summary
193 -------
194
195 Securities Issues addressed
196
197 Release Data
198 ------------
199
200 +--------------------------------------+--------------------------------------+
201 | **DMaaP Message Router Project**     |                                      |
202 |                                      |                                      |
203 +--------------------------------------+--------------------------------------+
204 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.1.20         |
205 |                                      | - onap/dmaap/kafka111:1.0.5          |
206 |                                      | - onap/dmaap/zookeeper:6.0.3         |
207 |                                      |                                      |
208 +--------------------------------------+--------------------------------------+
209 | **Release designation**              | 8.0.0 Honolulu                       |
210 |                                      |                                      |
211 +--------------------------------------+--------------------------------------+
212 | **Release date**                     | 2021-04-01                           |
213 |                                      |                                      |
214 +--------------------------------------+--------------------------------------+
215
216
217 New features
218 ------------
219 * Fix Security Vulnerabilities (listed in "Known Vulnerabilities" below) - DMAAP-1515
220 * Alter Project Lead information - DMAAP-1538
221 * Update certs - DMAAP-1565
222 * Update AAF Artifacts - DMAAP-1565
223
224 Known Limitations, Issues and Workarounds
225 -----------------------------------------
226
227 System Limitations
228 ------------------
229
230
231 Known Vulnerabilities
232 ---------------------
233 * CVE-2018-11307
234 * CVE-2018-12022
235 * CVE-2018-12023
236 * CVE-2019-17571
237 * SONATYPE-2010-0053
238 * CVE-2020-11994
239 * SONATYPE-2015-0174
240 * CVE-2020-5397
241 * SONATYPE-2012-0050
242
243 Workarounds
244 -----------
245
246
247 Security Notes
248 --------------
249
250
251 References
252 ----------
253
254 For more information on the ONAP Guilin release, please see:
255
256 #. `ONAP Home Page`_
257 #. `ONAP Documentation`_
258 #. `ONAP Release Downloads`_
259 #. `ONAP Wiki Page`_
260
261
262 .. _`ONAP Home Page`: https://www.onap.org
263 .. _`ONAP Wiki Page`: https://wiki.onap.org
264 .. _`ONAP Documentation`: https://docs.onap.org
265 .. _`ONAP Release Downloads`: https://git.onap.org
266
267 Quick Links:
268 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
269 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
270
271
272 ..      ===================================
273 ..      * * *    GUILIN  MAINTENANCE  * * *
274 ..      ===================================
275
276
277 Guilin maintenance
278 ==================
279
280 Version: 7.0.1
281 --------------
282
283 Abstract
284 --------
285
286 This document provides the release notes for the Guilin Maintenance release
287
288
289 Summary
290 -------
291
292 This maintenance release is primarily to resolve bugs identified during Guilin release testing.
293
294
295 Release Data
296 ------------
297
298 +--------------------------------------+--------------------------------------+
299 | **DMaaP Message Router Project**     |                                      |
300 |                                      |                                      |
301 +--------------------------------------+--------------------------------------+
302 | **Docker images**                    | Same as Guilin Release               |
303 +--------------------------------------+--------------------------------------+
304 | **Release designation**              | Guilin Maintenance Release           |
305 |                                      |                                      |
306 +--------------------------------------+--------------------------------------+
307 | **Release date**                     | 2021/04/19                           |
308 |                                      |                                      |
309 +--------------------------------------+--------------------------------------+
310
311 New features
312 ------------
313
314 None
315
316 **Bug fixes**
317
318 - `DMAAP-1547 <https://jira.onap.org/browse/DMAAP-1547>`_ Update certificats for DMaaP message router
319
320 **Known Issues**
321
322 Same as Guilin Release
323
324
325 ..      ===========================
326 ..      * * *    GUILIN    * * *
327 ..      ===========================
328
329 Guilin
330 ======
331
332 Abstract
333 --------
334
335 This document provides the DMaaP Message Router release notes for the Guilin release.
336
337 Summary
338 -------
339
340
341 Release Data
342 ------------
343
344 +--------------------------------------+--------------------------------------+
345 | **DMaaP Message Router Project**     |                                      |
346 |                                      |                                      |
347 +--------------------------------------+--------------------------------------+
348 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.1.18         |
349 |                                      | - onap/dmaap/kafka111:1.0.4          |
350 |                                      | - onap/dmaap/zookeeper:6.0.3         |
351 |                                      |                                      |
352 +--------------------------------------+--------------------------------------+
353 | **Release designation**              | 7.0.0 guilin                         |
354 |                                      |                                      |
355 +--------------------------------------+--------------------------------------+
356 | **Release date**                     | 2020-11-18                           |
357 |                                      |                                      |
358 +--------------------------------------+--------------------------------------+
359
360
361 New features
362 ------------
363
364 Known Limitations, Issues and Workarounds
365 -----------------------------------------
366
367 System Limitations
368 ------------------
369
370
371 Known Vulnerabilities
372 ---------------------
373 * CVE-2016-1000027
374 * CVE-2018-11307
375 * CVE-2019-13990
376 * SONATYPE-2018-0624
377 * CVE-2018-12022
378 * SONATYPE-2019-0414
379 * SONATYPE-2019-0808
380 * CVE-2019-10241
381 * CVE-2019-12406
382 * CVE-2020-5408
383 * CVE-2019-10246
384 * CVE-2019-10247
385 * CVE-2020-5397
386 * SONATYPE-2012-0050
387 * SONATYPE-2017-0507
388 * SONATYPE-2019-0469
389 * CVE-2018-12023
390 * SONATYPE-2018-0624
391 * CVE-2019-20444
392 * CVE-2019-20445
393 * CVE-2019-16869
394 * SONATYPE-2020-0029
395 * SONATYPE-2020-0103
396 * CVE-2019-17571
397 * CVE-2020-5398
398 * CVE-2018-17196
399
400
401 Workarounds
402 -----------
403
404
405 Security Notes
406 --------------
407
408
409 References
410 ----------
411
412 For more information on the ONAP Guilin release, please see:
413
414 #. `ONAP Home Page`_
415 #. `ONAP Documentation`_
416 #. `ONAP Release Downloads`_
417 #. `ONAP Wiki Page`_
418
419
420 .. _`ONAP Home Page`: https://www.onap.org
421 .. _`ONAP Wiki Page`: https://wiki.onap.org
422 .. _`ONAP Documentation`: https://docs.onap.org
423 .. _`ONAP Release Downloads`: https://git.onap.org
424
425 Quick Links:
426 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
427 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
428
429 ..      ===========================
430 ..      * * *    FRANKFURT    * * *
431 ..      ===========================
432
433 Frankfurt
434 =========
435
436 Abstract
437 --------
438
439 This document provides the DMaaP Message Router release notes for the Frankfurt release.
440
441 Summary
442 -------
443
444
445 Release Data
446 ------------
447
448 +--------------------------------------+--------------------------------------+
449 | **DMaaP Message Router Project**     |                                      |
450 |                                      |                                      |
451 +--------------------------------------+--------------------------------------+
452 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.1.18         |
453 |                                      | - onap/dmaap/kafka111:1.0.4          |
454 |                                      | - onap/dmaap/zookeeper:6.0.3         |
455 |                                      |                                      |
456 +--------------------------------------+--------------------------------------+
457 | **Release designation**              | 6.0.0 frankfurt                      |
458 |                                      |                                      |
459 +--------------------------------------+--------------------------------------+
460 | **Release date**                     | 2020-06-04                           |
461 |                                      |                                      |
462 +--------------------------------------+--------------------------------------+
463
464
465 New features
466 ------------
467 * Kafka and Zookeeper images are created using confluent community edition 5.3.0 
468 * Prometheus monitoring
469 * Protected all the Kafka operations using AAF
470 * Remove the AAF dependency by toggling  a flag
471
472
473 Known Limitations, Issues and Workarounds
474 -----------------------------------------
475
476 System Limitations
477 ------------------
478
479
480 Known Vulnerabilities
481 ---------------------
482 * CVE-2016-1000027
483 * CVE-2018-11307
484 * CVE-2019-13990
485 * SONATYPE-2018-0624
486 * CVE-2018-12022
487 * SONATYPE-2019-0414
488 * SONATYPE-2019-0808
489 * CVE-2019-10241
490 * CVE-2019-12406
491 * CVE-2020-5408
492 * CVE-2019-10246
493 * CVE-2019-10247
494 * CVE-2020-5397
495 * SONATYPE-2012-0050
496 * SONATYPE-2017-0507
497 * SONATYPE-2019-0469
498 * CVE-2018-12023
499 * SONATYPE-2018-0624
500 * CVE-2019-20444
501 * CVE-2019-20445
502 * CVE-2019-16869
503 * SONATYPE-2020-0029
504 * SONATYPE-2020-0103
505 * CVE-2019-17571
506 * CVE-2020-5398
507 * CVE-2018-17196
508
509
510 Workarounds
511 -----------
512
513
514 Security Notes
515 --------------
516
517
518 References
519 ----------
520
521 For more information on the ONAP Frankfurt release, please see:
522
523 #. `ONAP Home Page`_
524 #. `ONAP Documentation`_
525 #. `ONAP Release Downloads`_
526 #. `ONAP Wiki Page`_
527
528
529 .. _`ONAP Home Page`: https://www.onap.org
530 .. _`ONAP Wiki Page`: https://wiki.onap.org
531 .. _`ONAP Documentation`: https://docs.onap.org
532 .. _`ONAP Release Downloads`: https://git.onap.org
533
534 Quick Links:
535 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
536 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
537
538 ElAlto
539 ======
540
541 Version: 1.1.16
542 ---------------
543
544 :Release Date: 2019-10-10
545
546 **New Features**
547
548 - Cert based authentication support in Message Router
549 - Improved Kafka and Zookeeper cluster lookup
550 - Pluggable Kafka server.properties,log4j.properties  and Message Router logback.xml
551
552
553 **Bug Fixes**
554
555 - Fixed for security vulnerabilities in Message Router
556 - Fixed  authorization issues in Message Router
557
558 **Known Issues**
559         NA
560
561 **Security Notes**
562
563 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>`_.
564
565 Quick Links:
566
567 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
568 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
569 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
570
571 **Upgrade Notes**
572   NA
573
574 **Deprecation Notes**
575
576 Dublin
577 ======
578
579 Version: 1.1.14
580 ---------------
581
582 :Release Date: 2019-06-06
583
584 **New Features**
585
586 - Upgrade Kafka to v1.1.1
587 - Support for Authenticated topics
588 - Add Scaling support
589 - Support for multi-site applications 
590 - Add MirrorMaker to allow for message replication across Kafka clusters
591
592 **Bug Fixes**
593         NA
594 **Known Issues**
595         NA
596
597 **Security Notes**
598
599 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>`_.
600
601 Quick Links:
602
603 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
604 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
605 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
606
607 **Upgrade Notes**
608   NA
609
610 **Deprecation Notes**
611
612 Casablanca
613 ==========
614
615 Version: 1.1.8
616 --------------
617
618 :Release Date: 2018-11-30
619
620 **New Features**
621
622  - DMaaP client changes to fix some known issues
623  - Kafka upgrade  to 0.11.0.1 and corresponding changes in the Message Router
624  - New Kafka image was created instead of using the publicly available Kafka image
625
626 **Bug Fixes**
627         NA
628         
629 **Known Issues**
630
631 If the ZooKeeper  is restarted, Message Router works as expected only after restarting the Message Router . Refer  `Jira <https://jira.onap.org/browse/DMAAP-893>`_  for more details
632
633 **Security Notes**
634
635 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 `Casablanca <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
636
637 Quick Links:
638
639 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
640 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
641 - `Casablanca Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
642
643 **Upgrade Notes**
644   NA
645
646 **Deprecation Notes**
647
648
649 Beijing
650 =======
651
652 Version: 1.1.4
653 --------------
654
655 :Release Date: 2018-06-07
656
657 **New Features**
658
659  - Topic creation with out AAF
660  - DMaaP client changes to call the message Router with out authentication
661  - Kafka upgrade from 0.8.11 to 1.1.0
662  - Fixes for docker image packaging issues
663
664 **Bug Fixes**
665         NA
666 **Known Issues**
667         NA
668
669 **Security Notes**
670
671 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>`_.
672
673 Quick Links:
674 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
675 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
676 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
677
678 **Upgrade Notes**
679   NA
680
681 **Deprecation Notes**
682
683 Amsterdam
684 =========
685
686 Version: 1.0.1
687 --------------
688
689 :Release Date: 2017-11-16
690
691
692 New Features:
693
694  - Pub/sub messaging metaphor to broaden data processing opportunities
695  - A single solution for most event distribution needs to support a range of environments
696  - Standardized topic names
697  - Implements a RESTful HTTP API for provisioning
698  - Implements a RESTful HTTP API for message transactions (i.e. pub, sub)
699  - Implements a RESTful HTTP API for transaction metrics
700  - Topic registry and discovery
701
702
703
704 Bug Fixes
705    - `DMAAP-165 <https://jira.onap.org/browse/DMAAP-165>`_ Correct documentation rst file errors and warnings
706    - `DMAAP-160 <https://jira.onap.org/browse/DMAAP-160>`_ DMaaP periodically loses connection to Kafka
707    - `DMAAP-157 <https://jira.onap.org/browse/DMAAP-157>`_ SDC service models distribution fails
708    - `DMAAP-151 <https://jira.onap.org/browse/DMAAP-151>`_ Fix docker image bug
709    - `DMAAP-1 <https://jira.onap.org/browse/DMAAP-1>`_ MSO DB is not populated with the models from SDC
710    
711 Known Issues
712    - `DMAAP-164 <https://jira.onap.org/browse/DMAAP-164>`_ The dependency from kafka for zookeeper created issues when the vm is restarted
713
714 Other
715