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