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