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