update guilin 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 ..      * * *    GUILIN    * * *
7 ..      ===========================
8
9 Release Notes
10 =============
11
12 Abstract
13 --------
14
15 This document provides the DMaaP Message Router release notes for the Guilin release.
16
17 Summary
18 -------
19
20
21 Release Data
22 ------------
23
24 +--------------------------------------+--------------------------------------+
25 | **DMaaP Message Router Project**     |                                      |
26 |                                      |                                      |
27 +--------------------------------------+--------------------------------------+
28 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.1.18         |
29 |                                      | - onap/dmaap/kafka111:1.0.4          |
30 |                                      | - onap/dmaap/zookeeper:6.0.3         |
31 |                                      |                                      |
32 +--------------------------------------+--------------------------------------+
33 | **Release designation**              | 7.0.0 guilin                         |
34 |                                      |                                      |
35 +--------------------------------------+--------------------------------------+
36 | **Release date**                     | 2020-11-18                           |
37 |                                      |                                      |
38 +--------------------------------------+--------------------------------------+
39
40
41 New features
42 ------------
43
44 Known Limitations, Issues and Workarounds
45 -----------------------------------------
46
47 System Limitations
48 ------------------
49
50
51 Known Vulnerabilities
52 ---------------------
53 * CVE-2016-1000027
54 * CVE-2018-11307
55 * CVE-2019-13990
56 * SONATYPE-2018-0624
57 * CVE-2018-12022
58 * SONATYPE-2019-0414
59 * SONATYPE-2019-0808
60 * CVE-2019-10241
61 * CVE-2019-12406
62 * CVE-2020-5408
63 * CVE-2019-10246
64 * CVE-2019-10247
65 * CVE-2020-5397
66 * SONATYPE-2012-0050
67 * SONATYPE-2017-0507
68 * SONATYPE-2019-0469
69 * CVE-2018-12023
70 * SONATYPE-2018-0624
71 * CVE-2019-20444
72 * CVE-2019-20445
73 * CVE-2019-16869
74 * SONATYPE-2020-0029
75 * SONATYPE-2020-0103
76 * CVE-2019-17571
77 * CVE-2020-5398
78 * CVE-2018-17196
79
80
81 Workarounds
82 -----------
83
84
85 Security Notes
86 --------------
87
88
89 References
90 ----------
91
92 For more information on the ONAP Guilin release, please see:
93
94 #. `ONAP Home Page`_
95 #. `ONAP Documentation`_
96 #. `ONAP Release Downloads`_
97 #. `ONAP Wiki Page`_
98
99
100 .. _`ONAP Home Page`: https://www.onap.org
101 .. _`ONAP Wiki Page`: https://wiki.onap.org
102 .. _`ONAP Documentation`: https://docs.onap.org
103 .. _`ONAP Release Downloads`: https://git.onap.org
104
105 Quick Links:
106 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
107 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
108
109 ..      ===========================
110 ..      * * *    FRANKFURT    * * *
111 ..      ===========================
112
113 Release Notes
114 -------------
115
116 Abstract
117 --------
118
119 This document provides the DMaaP Message Router release notes for the Frankfurt release.
120
121 Summary
122 -------
123
124
125 Release Data
126 ------------
127
128 +--------------------------------------+--------------------------------------+
129 | **DMaaP Message Router Project**     |                                      |
130 |                                      |                                      |
131 +--------------------------------------+--------------------------------------+
132 | **Docker images**                    | - onap/dmaap/dmaap-mr:1.1.18         |
133 |                                      | - onap/dmaap/kafka111:1.0.4          |
134 |                                      | - onap/dmaap/zookeeper:6.0.3         |
135 |                                      |                                      |
136 +--------------------------------------+--------------------------------------+
137 | **Release designation**              | 6.0.0 frankfurt                      |
138 |                                      |                                      |
139 +--------------------------------------+--------------------------------------+
140 | **Release date**                     | 2020-06-04                           |
141 |                                      |                                      |
142 +--------------------------------------+--------------------------------------+
143
144
145 New features
146 ------------
147 * Kafka and Zookeeper images are created using confluent community edition 5.3.0 
148 * Prometheus monitoring
149 * Protected all the Kafka operations using AAF
150 * Remove the AAF dependency by toggling  a flag
151
152
153 Known Limitations, Issues and Workarounds
154 -----------------------------------------
155
156 System Limitations
157 ------------------
158
159
160 Known Vulnerabilities
161 ---------------------
162 * CVE-2016-1000027
163 * CVE-2018-11307
164 * CVE-2019-13990
165 * SONATYPE-2018-0624
166 * CVE-2018-12022
167 * SONATYPE-2019-0414
168 * SONATYPE-2019-0808
169 * CVE-2019-10241
170 * CVE-2019-12406
171 * CVE-2020-5408
172 * CVE-2019-10246
173 * CVE-2019-10247
174 * CVE-2020-5397
175 * SONATYPE-2012-0050
176 * SONATYPE-2017-0507
177 * SONATYPE-2019-0469
178 * CVE-2018-12023
179 * SONATYPE-2018-0624
180 * CVE-2019-20444
181 * CVE-2019-20445
182 * CVE-2019-16869
183 * SONATYPE-2020-0029
184 * SONATYPE-2020-0103
185 * CVE-2019-17571
186 * CVE-2020-5398
187 * CVE-2018-17196
188
189
190 Workarounds
191 -----------
192
193
194 Security Notes
195 --------------
196
197
198 References
199 ----------
200
201 For more information on the ONAP Frankfurt release, please see:
202
203 #. `ONAP Home Page`_
204 #. `ONAP Documentation`_
205 #. `ONAP Release Downloads`_
206 #. `ONAP Wiki Page`_
207
208
209 .. _`ONAP Home Page`: https://www.onap.org
210 .. _`ONAP Wiki Page`: https://wiki.onap.org
211 .. _`ONAP Documentation`: https://docs.onap.org
212 .. _`ONAP Release Downloads`: https://git.onap.org
213
214 Quick Links:
215 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
216 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
217
218
219 Version: 1.1.16 (ElAlto)
220 ------------------------
221
222 :Release Date: 2019-10-10
223
224 **New Features**
225
226 - Cert based authentication support in Message Router
227 - Improved Kafka and Zookeeper cluster lookup
228 - Pluggable Kafka server.properties,log4j.properties  and Message Router logback.xml
229
230
231 **Bug Fixes**
232
233 - Fixed for security vulnerabilities in Message Router
234 - Fixed  authorization issues in Message Router
235
236 **Known Issues**
237         NA
238
239 **Security Notes**
240
241 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>`_.
242
243 Quick Links:
244
245 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
246 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
247 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
248
249 **Upgrade Notes**
250   NA
251
252 **Deprecation Notes**
253
254 Version: 1.1.14 (Dublin)
255 ------------------------
256
257 :Release Date: 2019-06-06
258
259 **New Features**
260
261 - Upgrade Kafka to v1.1.1
262 - Support for Authenticated topics
263 - Add Scaling support
264 - Support for multi-site applications 
265 - Add MirrorMaker to allow for message replication across Kafka clusters
266
267 **Bug Fixes**
268         NA
269 **Known Issues**
270         NA
271
272 **Security Notes**
273
274 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>`_.
275
276 Quick Links:
277
278 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
279 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
280 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
281
282 **Upgrade Notes**
283   NA
284
285 **Deprecation Notes**
286
287
288 Version: 1.1.8 (Casablanca)
289 ---------------------------
290
291 :Release Date: 2018-11-30
292
293 **New Features**
294
295  - DMaaP client changes to fix some known issues
296  - Kafka upgrade  to 0.11.0.1 and corresponding changes in the Message Router
297  - New Kafka image was created instead of using the publicly available Kafka image
298
299 **Bug Fixes**
300         NA
301         
302 **Known Issues**
303
304 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
305
306 **Security Notes**
307
308 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>`_.
309
310 Quick Links:
311
312 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
313 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
314 - `Casablanca Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
315
316 **Upgrade Notes**
317   NA
318
319 **Deprecation Notes**
320
321
322
323 Version: 1.1.4
324 --------------
325
326 :Release Date: 2018-06-07
327
328 **New Features**
329
330  - Topic creation with out AAF
331  - DMaaP client changes to call the message Router with out authentication
332  - Kafka upgrade from 0.8.11 to 1.1.0
333  - Fixes for docker image packaging issues
334
335 **Bug Fixes**
336         NA
337 **Known Issues**
338         NA
339
340 **Security Notes**
341
342 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>`_.
343
344 Quick Links:
345 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
346 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/1751>`_
347 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
348
349 **Upgrade Notes**
350   NA
351
352 **Deprecation Notes**
353
354 Version: 1.0.1
355 --------------
356
357 :Release Date: 2017-11-16
358
359
360 New Features:
361
362  - Pub/sub messaging metaphor to broaden data processing opportunities
363  - A single solution for most event distribution needs to support a range of environments
364  - Standardized topic names
365  - Implements a RESTful HTTP API for provisioning
366  - Implements a RESTful HTTP API for message transactions (i.e. pub, sub)
367  - Implements a RESTful HTTP API for transaction metrics
368  - Topic registry and discovery
369
370
371
372 Bug Fixes
373    - `DMAAP-165 <https://jira.onap.org/browse/DMAAP-165>`_ Correct documentation rst file errors and warnings
374    - `DMAAP-160 <https://jira.onap.org/browse/DMAAP-160>`_ DMaaP periodically loses connection to Kafka
375    - `DMAAP-157 <https://jira.onap.org/browse/DMAAP-157>`_ SDC service models distribution fails
376    - `DMAAP-151 <https://jira.onap.org/browse/DMAAP-151>`_ Fix docker image bug
377    - `DMAAP-1 <https://jira.onap.org/browse/DMAAP-1>`_ MSO DB is not populated with the models from SDC
378    
379 Known Issues
380    - `DMAAP-164 <https://jira.onap.org/browse/DMAAP-164>`_ The dependency from kafka for zookeeper created issues when the vm is restarted
381
382 Other
383