DMAAP-1578 - DataRouter Release Notes
[dmaap/datarouter.git] / docs / 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 DMaaP Data Router Release Notes
10 -------------------------------
11
12 Abstract
13 --------
14
15 This document provides the release notes for the DMaaP DR Honolulu release.
16
17 Summary
18 -------
19 No big changes for Honolulu Release.
20
21 Release Data
22 ------------
23
24 +--------------------------------------+--------------------------------------+
25 | **DMaaP Data Router Project**        |                                      |
26 +--------------------------------------+--------------------------------------+
27 | **Docker images**                    | - datarouter-prov 2.1.8              |
28 |                                      | - datarouter-node 2.1.8              |
29 +--------------------------------------+--------------------------------------+
30 | **Release designation**              | 8.0.0 Honolulu                       |
31 +--------------------------------------+--------------------------------------+
32 | **Release date**                     | 2021-04-01 (TBD)                     |
33 +--------------------------------------+--------------------------------------+
34
35 New features
36 ------------
37
38 * Update commons-codec (listed in "Known Vulnerabilities" below) - DMAAP-1515
39 * Change openjdk baseOS imgs to ONAP/integration- - INT-1864
40 * Update Project Lead Information - DMAAP-1538
41
42
43 Known Limitations, Issues and Workarounds
44 -----------------------------------------
45
46 System Limitations
47 ------------------
48
49 Known Vulnerabilities
50 ---------------------
51 * SONATYPE-2012-0050
52
53 Workarounds
54 -----------
55
56 Security Notes
57 --------------
58
59 References
60 ----------
61
62 For more information on the ONAP Frankfurt release, please see:
63
64 #. `ONAP Home Page`_
65 #. `ONAP Documentation`_
66 #. `ONAP Release Downloads`_
67 #. `ONAP Wiki Page`_
68
69 .. _`ONAP Home Page`: https://www.onap.org
70 .. _`ONAP Wiki Page`: https://wiki.onap.org
71 .. _`ONAP Documentation`: https://docs.onap.org
72 .. _`ONAP Release Downloads`: https://git.onap.org
73
74
75 ..      ===========================
76 ..      * * *    GUILIN       * * *
77 ..      ===========================
78
79 DMaaP Data Router Release Notes
80 ===============================
81
82 Abstract
83 --------
84
85 This document provides the release notes for the DMaaP DR Guilin release.
86
87 Summary
88 -------
89
90 Release Data
91 ------------
92
93 +--------------------------------------+--------------------------------------+
94 | **DMaaP Data Router Project**        |                                      |
95 +--------------------------------------+--------------------------------------+
96 | **Docker images**                    | - datarouter-prov 2.1.7              |
97 |                                      | - datarouter-node 2.1.7              |
98 +--------------------------------------+--------------------------------------+
99 | **Release designation**              | 7.0.0 guilin                         |
100 +--------------------------------------+--------------------------------------+
101 | **Release date**                     | 2020-10-19 (TBD)                     |
102 +--------------------------------------+--------------------------------------+
103
104 New features
105 ------------
106
107 Known Limitations, Issues and Workarounds
108 -----------------------------------------
109
110 System Limitations
111 ------------------
112
113 Known Vulnerabilities
114 ---------------------
115
116 Workarounds
117 -----------
118
119 Security Notes
120 --------------
121
122
123 ..      ===========================
124 ..      * * *    FRANKFURT    * * *
125 ..      ===========================
126
127 DMaaP Data Router Release Notes
128 -------------------------------
129
130 Abstract
131 --------
132
133 This document provides the release notes for the DMaaP DR Frankfurt release.
134
135 Summary
136 -------
137
138 Release Data
139 ------------
140
141 +--------------------------------------+--------------------------------------+
142 | **DMaaP Data Router Project**        |                                      |
143 +--------------------------------------+--------------------------------------+
144 | **Docker images**                    | - datarouter-prov 2.1.6              |
145 |                                      | - datarouter-node 2.1.6              |
146 +--------------------------------------+--------------------------------------+
147 | **Release designation**              | 6.0.0 frankfurt                      |
148 +--------------------------------------+--------------------------------------+
149 | **Release date**                     | 2020-05-14 (TBD)                     |
150 +--------------------------------------+--------------------------------------+
151
152 New features
153 ------------
154
155 * Implement boolean flag in OOM to disable HTTP ports
156 * Dynamic cert distribution from OOM AAF
157
158 Known Limitations, Issues and Workarounds
159 -----------------------------------------
160
161 System Limitations
162 ------------------
163
164 Known Vulnerabilities
165 ---------------------
166 * CVE-2019-11358
167
168 Workarounds
169 -----------
170
171 Security Notes
172 --------------
173
174 References
175 ----------
176
177 For more information on the ONAP Frankfurt release, please see:
178
179 #. `ONAP Home Page`_
180 #. `ONAP Documentation`_
181 #. `ONAP Release Downloads`_
182 #. `ONAP Wiki Page`_
183
184 .. _`ONAP Home Page`: https://www.onap.org
185 .. _`ONAP Wiki Page`: https://wiki.onap.org
186 .. _`ONAP Documentation`: https://docs.onap.org
187 .. _`ONAP Release Downloads`: https://git.onap.org
188
189
190 Version: 2.1.2 (El Alto)
191 ---------------------------
192
193 :Release Date: 2019-09-05
194
195 New Features:
196
197 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
198 | JIRA ID        | Description                                                                                                                     |
199 +================+=================================================================================================================================+
200 | DMAAP-1227     | Updating logging functionality to log events into correct log files as specified in logging spec                                |
201 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
202 | DMAAP-1228     | Updating Logging pattern to match logging spec                                                                                  |
203 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
204 | DMAAP-1049     | [DR] Update DR logging to match Platform maturity Logging Spec                                                                  |
205 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
206
207 Bug Fixes:
208
209 +----------------+--------------------------------------------------------------------------------------------------+
210 | JIRA ID        | Description                                                                                      |
211 +================+==================================================================================================+
212 | DMAAP-1421     |  [DR] ElAlto AAF certs expired                                                                   |
213 +----------------+--------------------------------------------------------------------------------------------------+
214
215 Known Issues:
216 N/A
217
218 Security Issues:
219 N/A
220
221 Upgrade Notes:
222 N/A
223
224 Deprecation Notes:
225 N/A
226
227 Other:
228 N/A
229
230
231 Version: 2.1.0 (Dublin)
232 ---------------------------
233
234 :Release Date: 2019-06-06
235
236 New Features:
237
238 +--------------+-------------------------------------------------------------------------------+
239 | JIRA ID      | Description                                                                   |
240 +==============+===============================================================================+
241 | DMAAP-978    | [DR] Query of publication history (new API) for use by Data File Collector)   |
242 +--------------+-------------------------------------------------------------------------------+
243 | DMAAP-980    | [DR] Optional consumer compression feed handling                              |
244 +--------------+-------------------------------------------------------------------------------+
245 | DMAAP-1016   | DR provisioning AAF integration                                               |
246 +--------------+-------------------------------------------------------------------------------+
247
248 Bug Fixes:
249
250 +----------------+--------------------------------------------------------------------------------------------------+
251 | JIRA ID        | Description                                                                                      |
252 +================+==================================================================================================+
253 | DMAAP-964      | [DMAAP] DMAAP deployment failures starting 20190115 on casablanca branch                         |
254 +----------------+--------------------------------------------------------------------------------------------------+
255 | DMAAP-1010     | [DR] DMaaP Data Router fails healthcheck                                                         |
256 +----------------+--------------------------------------------------------------------------------------------------+
257 | DMAAP-1047     | [DR] Data Router docker version missing explicit version number                                  |
258 +----------------+--------------------------------------------------------------------------------------------------+
259 | DMAAP-1048     | [DR] AAF certs expired on dmaap-dr-prov and dmaap-dr-node                                        |
260 +----------------+--------------------------------------------------------------------------------------------------+
261 | DMAAP-1161     | [DR] filebeat container on DR-Node and DR-Prov are unable to publish to kibana                   |
262 +----------------+--------------------------------------------------------------------------------------------------+
263
264 Known Issues:
265 N/A
266
267 Security Issues:
268
269 *Fixed Security Issues*
270
271 *Known Security Issues*
272
273 - In default deployment DMAAP (dmaap-dr-prov) exposes HTTP port 30259 outside of cluster. [`OJSI-158 <https://jira.onap.org/browse/OJSI-158>`_]
274
275 *Known Vulnerabilities in Used Modules*
276
277 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
278 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
279 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
280
281 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
282 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
283 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
284
285 Upgrade Notes:
286 N/A
287
288 Deprecation Notes:
289 N/A
290
291 Other:
292 N/A
293
294
295 Version: 1.0.8 (Casablanca)
296 ---------------------------
297
298 :Release Date: 2019-02-28
299
300 New Features:
301
302 +--------------+------------------------------------------------------------------+
303 | JIRA ID      | Description                                                      |
304 +==============+==================================================================+
305 +--------------+------------------------------------------------------------------+
306
307 Bug Fixes:
308
309 +----------------+--------------------------------------------------------------------------------------------------+
310 | JIRA ID        | Description                                                                                      |
311 +================+==================================================================================================+
312 | DMAAP-1065     | [DR] Casablanca - AAF certs expired on dmaap-dr-prov and dmaap-dr-node                           |
313 +----------------+--------------------------------------------------------------------------------------------------+
314
315 Known Issues:
316 N/A
317
318 Security Issues:
319 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
320 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
321 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
322
323 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
324 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
325 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
326
327 Upgrade Notes:
328 N/A
329
330 Deprecation Notes:
331 N/A
332
333 Other:
334 N/A
335
336
337 Version: 1.0.3 (Casablanca)
338 ---------------------------
339
340 :Release Date: 2018-11-30
341
342 New Features:
343
344 +--------------+------------------------------------------------------------------+
345 | JIRA ID      | Description                                                      |
346 +==============+==================================================================+
347 | DMAAP-20     | REST api for publishing data to DR                               |
348 +--------------+------------------------------------------------------------------+
349 | DMAAP-21     | REST api for subscribing to data in DR                           |
350 +--------------+------------------------------------------------------------------+
351
352 Bug Fixes:
353
354 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
355 | JIRA ID        | Description                                                                                                                     |
356 +================+=================================================================================================================================+
357 | DMAAP-877      | DR Logging API not storing Feed/Sub data                                                                                        |
358 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
359 | DMAAP-850      | Second subscriber not receiving the published file                                                                              |
360 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
361 | DMAAP-596      | DR - datarouter-prov container fails to come up successfully                                                                    |
362 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
363 | DMAAP-565      | Incorrect nexusUrl parameter in datarouter pom files                                                                            |
364 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
365
366 Known Issues:
367 N/A
368
369 Security Issues:
370 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
371 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
372 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
373
374 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
375 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
376 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
377
378 Upgrade Notes:
379 N/A
380
381 Deprecation Notes:
382 N/A
383
384 Other:
385 N/A