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