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