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