d92a77200393a1800cd96858f16bd8c3a98de233
[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 ..      * * *    JAKARTA    * * *
7 ..      ===========================
8
9 =============
10 Release Notes
11 =============
12
13 Jakarta
14 ========
15
16 Abstract
17 --------
18
19 This document provides the release notes for the DMaaP DR Jakarta release.
20
21 Summary
22 -------
23 No big changes for Jakarta Release.
24 Some bug fixes and sonar fixes.
25
26 Release Data
27 ------------
28
29 +--------------------------------------+--------------------------------------+
30 | **DMaaP Data Router Project**        |                                      |
31 +--------------------------------------+--------------------------------------+
32 | **Docker images**                    | - datarouter-prov 2.1.10             |
33 |                                      | - datarouter-node 2.1.10             |
34 +--------------------------------------+--------------------------------------+
35 | **Release designation**              | 10.0.0 Jakarta                       |
36 +--------------------------------------+--------------------------------------+
37 | **Release date**                     | 5/12/2022                            |
38 +--------------------------------------+--------------------------------------+
39
40 New features
41 ------------
42
43 * Patch DR certs - DMAAP-1726
44 * Cross Scripting sonar fix - DMAAP-1624
45 * SQL Injection Fix - DMAAP-1623
46 * Sonar Security hotspot fixes - DMAAP-1624
47
48
49 Known Limitations, Issues and Workarounds
50 -----------------------------------------
51
52 System Limitations
53 ------------------
54
55 Known Vulnerabilities
56 ---------------------
57
58 Workarounds
59 -----------
60
61 Security Notes
62 --------------
63
64 References
65 ----------
66
67 For more information on the ONAP Istanbul release, please see:
68
69 #. `ONAP Home Page`_
70 #. `ONAP Documentation`_
71 #. `ONAP Release Downloads`_
72 #. `ONAP Wiki Page`_
73
74 .. _`ONAP Home Page`: https://www.onap.org
75 .. _`ONAP Wiki Page`: https://wiki.onap.org
76 .. _`ONAP Documentation`: https://docs.onap.org
77 .. _`ONAP Release Downloads`: https://git.onap.org
78
79
80 ..      ===========================
81 ..      * * *    ISTANBUL    * * *
82 ..      ===========================
83
84 =============
85 Release Notes
86 =============
87
88 Istanbul
89 ========
90
91 Abstract
92 --------
93
94 This document provides the release notes for the DMaaP DR Istanbul release.
95
96 Summary
97 -------
98 No big changes for Istanbul Release.
99
100 Release Data
101 ------------
102
103 +--------------------------------------+--------------------------------------+
104 | **DMaaP Data Router Project**        |                                      |
105 +--------------------------------------+--------------------------------------+
106 | **Docker images**                    | - datarouter-prov 2.1.9              |
107 |                                      | - datarouter-node 2.1.9              |
108 +--------------------------------------+--------------------------------------+
109 | **Release designation**              | 9.0.0 Istanbul                       |
110 +--------------------------------------+--------------------------------------+
111 | **Release date**                     | 2021-10-14                           |
112 +--------------------------------------+--------------------------------------+
113
114 New features
115 ------------
116
117 * Package upgrades - DMAAP-1608
118 * Move csits to dr repo - DMAAP-1636
119 * Sonar fixes - DMAAP-1623
120
121
122 Known Limitations, Issues and Workarounds
123 -----------------------------------------
124
125 System Limitations
126 ------------------
127
128 Known Vulnerabilities
129 ---------------------
130
131 Workarounds
132 -----------
133
134 Security Notes
135 --------------
136
137 References
138 ----------
139
140 For more information on the ONAP Istanbul release, please see:
141
142 #. `ONAP Home Page`_
143 #. `ONAP Documentation`_
144 #. `ONAP Release Downloads`_
145 #. `ONAP Wiki Page`_
146
147 .. _`ONAP Home Page`: https://www.onap.org
148 .. _`ONAP Wiki Page`: https://wiki.onap.org
149 .. _`ONAP Documentation`: https://docs.onap.org
150 .. _`ONAP Release Downloads`: https://git.onap.org
151
152
153 ..      ===========================
154 ..      * * *    Honolulu    * * *
155 ..      ===========================
156
157
158 Honolulu
159 ========
160
161 Abstract
162 --------
163
164 This document provides the release notes for the DMaaP DR Honolulu release.
165
166 Summary
167 -------
168 No big changes for Honolulu Release.
169
170 Release Data
171 ------------
172
173 +--------------------------------------+--------------------------------------+
174 | **DMaaP Data Router Project**        |                                      |
175 +--------------------------------------+--------------------------------------+
176 | **Docker images**                    | - datarouter-prov 2.1.8              |
177 |                                      | - datarouter-node 2.1.8              |
178 +--------------------------------------+--------------------------------------+
179 | **Release designation**              | 8.0.0 Honolulu                       |
180 +--------------------------------------+--------------------------------------+
181 | **Release date**                     | 2021-04-01                           |
182 +--------------------------------------+--------------------------------------+
183
184 New features
185 ------------
186
187 * Update commons-codec (listed in "Known Vulnerabilities" below) - DMAAP-1515
188 * Change openjdk baseOS imgs to ONAP/integration- - INT-1864
189 * Update Project Lead Information - DMAAP-1538
190
191
192 Known Limitations, Issues and Workarounds
193 -----------------------------------------
194
195 System Limitations
196 ------------------
197
198 Known Vulnerabilities
199 ---------------------
200 * SONATYPE-2012-0050
201
202 Workarounds
203 -----------
204
205 Security Notes
206 --------------
207
208 References
209 ----------
210
211 For more information on the ONAP Honolulu release, please see:
212
213 #. `ONAP Home Page`_
214 #. `ONAP Documentation`_
215 #. `ONAP Release Downloads`_
216 #. `ONAP Wiki Page`_
217
218 .. _`ONAP Home Page`: https://www.onap.org
219 .. _`ONAP Wiki Page`: https://wiki.onap.org
220 .. _`ONAP Documentation`: https://docs.onap.org
221 .. _`ONAP Release Downloads`: https://git.onap.org
222
223
224 ..      ===========================
225 ..      * * *    GUILIN       * * *
226 ..      ===========================
227
228 Guilin
229 ======
230
231 Abstract
232 --------
233
234 This document provides the release notes for the DMaaP DR Guilin release.
235
236 Summary
237 -------
238
239 Release Data
240 ------------
241
242 +--------------------------------------+--------------------------------------+
243 | **DMaaP Data Router Project**        |                                      |
244 +--------------------------------------+--------------------------------------+
245 | **Docker images**                    | - datarouter-prov 2.1.7              |
246 |                                      | - datarouter-node 2.1.7              |
247 +--------------------------------------+--------------------------------------+
248 | **Release designation**              | 7.0.0 guilin                         |
249 +--------------------------------------+--------------------------------------+
250 | **Release date**                     | 2020-10-19 (TBD)                     |
251 +--------------------------------------+--------------------------------------+
252
253 New features
254 ------------
255
256 Known Limitations, Issues and Workarounds
257 -----------------------------------------
258
259 System Limitations
260 ------------------
261
262 Known Vulnerabilities
263 ---------------------
264
265 Workarounds
266 -----------
267
268 Security Notes
269 --------------
270
271
272 ..      ===========================
273 ..      * * *    FRANKFURT    * * *
274 ..      ===========================
275
276 Frankfurt
277 =========
278
279 Abstract
280 --------
281
282 This document provides the release notes for the DMaaP DR Frankfurt release.
283
284 Summary
285 -------
286
287 Release Data
288 ------------
289
290 +--------------------------------------+--------------------------------------+
291 | **DMaaP Data Router Project**        |                                      |
292 +--------------------------------------+--------------------------------------+
293 | **Docker images**                    | - datarouter-prov 2.1.6              |
294 |                                      | - datarouter-node 2.1.6              |
295 +--------------------------------------+--------------------------------------+
296 | **Release designation**              | 6.0.0 frankfurt                      |
297 +--------------------------------------+--------------------------------------+
298 | **Release date**                     | 2020-05-14 (TBD)                     |
299 +--------------------------------------+--------------------------------------+
300
301 New features
302 ------------
303
304 * Implement boolean flag in OOM to disable HTTP ports
305 * Dynamic cert distribution from OOM AAF
306
307 Known Limitations, Issues and Workarounds
308 -----------------------------------------
309
310 System Limitations
311 ------------------
312
313 Known Vulnerabilities
314 ---------------------
315 * CVE-2019-11358
316
317 Workarounds
318 -----------
319
320 Security Notes
321 --------------
322
323 References
324 ----------
325
326 For more information on the ONAP Frankfurt release, please see:
327
328 #. `ONAP Home Page`_
329 #. `ONAP Documentation`_
330 #. `ONAP Release Downloads`_
331 #. `ONAP Wiki Page`_
332
333 .. _`ONAP Home Page`: https://www.onap.org
334 .. _`ONAP Wiki Page`: https://wiki.onap.org
335 .. _`ONAP Documentation`: https://docs.onap.org
336 .. _`ONAP Release Downloads`: https://git.onap.org
337
338
339 El Alto
340 =======
341
342 Version: 2.1.2
343 --------------
344
345 :Release Date: 2019-09-05
346
347 New Features:
348
349 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
350 | JIRA ID        | Description                                                                                                                     |
351 +================+=================================================================================================================================+
352 | DMAAP-1227     | Updating logging functionality to log events into correct log files as specified in logging spec                                |
353 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
354 | DMAAP-1228     | Updating Logging pattern to match logging spec                                                                                  |
355 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
356 | DMAAP-1049     | [DR] Update DR logging to match Platform maturity Logging Spec                                                                  |
357 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
358
359 Bug Fixes:
360
361 +----------------+--------------------------------------------------------------------------------------------------+
362 | JIRA ID        | Description                                                                                      |
363 +================+==================================================================================================+
364 | DMAAP-1421     |  [DR] ElAlto AAF certs expired                                                                   |
365 +----------------+--------------------------------------------------------------------------------------------------+
366
367 Known Issues:
368 N/A
369
370 Security Issues:
371 N/A
372
373 Upgrade Notes:
374 N/A
375
376 Deprecation Notes:
377 N/A
378
379 Other:
380 N/A
381
382
383 Dublin
384 ======
385
386 Version: 2.1.0
387 --------------
388
389 :Release Date: 2019-06-06
390
391 New Features:
392
393 +--------------+-------------------------------------------------------------------------------+
394 | JIRA ID      | Description                                                                   |
395 +==============+===============================================================================+
396 | DMAAP-978    | [DR] Query of publication history (new API) for use by Data File Collector)   |
397 +--------------+-------------------------------------------------------------------------------+
398 | DMAAP-980    | [DR] Optional consumer compression feed handling                              |
399 +--------------+-------------------------------------------------------------------------------+
400 | DMAAP-1016   | DR provisioning AAF integration                                               |
401 +--------------+-------------------------------------------------------------------------------+
402
403 Bug Fixes:
404
405 +----------------+--------------------------------------------------------------------------------------------------+
406 | JIRA ID        | Description                                                                                      |
407 +================+==================================================================================================+
408 | DMAAP-964      | [DMAAP] DMAAP deployment failures starting 20190115 on casablanca branch                         |
409 +----------------+--------------------------------------------------------------------------------------------------+
410 | DMAAP-1010     | [DR] DMaaP Data Router fails healthcheck                                                         |
411 +----------------+--------------------------------------------------------------------------------------------------+
412 | DMAAP-1047     | [DR] Data Router docker version missing explicit version number                                  |
413 +----------------+--------------------------------------------------------------------------------------------------+
414 | DMAAP-1048     | [DR] AAF certs expired on dmaap-dr-prov and dmaap-dr-node                                        |
415 +----------------+--------------------------------------------------------------------------------------------------+
416 | DMAAP-1161     | [DR] filebeat container on DR-Node and DR-Prov are unable to publish to kibana                   |
417 +----------------+--------------------------------------------------------------------------------------------------+
418
419 Known Issues:
420 N/A
421
422 Security Issues:
423
424 *Fixed Security Issues*
425
426 *Known Security Issues*
427
428 - In default deployment DMAAP (dmaap-dr-prov) exposes HTTP port 30259 outside of cluster. [`OJSI-158 <https://jira.onap.org/browse/OJSI-158>`_]
429
430 *Known Vulnerabilities in Used Modules*
431
432 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
433 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
434 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
435
436 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
437 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
438 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
439
440 Upgrade Notes:
441 N/A
442
443 Deprecation Notes:
444 N/A
445
446 Other:
447 N/A
448
449
450 Casablanca Maintenance
451 ======================
452
453 Version: 1.0.8
454 --------------
455
456 :Release Date: 2019-02-28
457
458 New Features:
459
460 +--------------+------------------------------------------------------------------+
461 | JIRA ID      | Description                                                      |
462 +==============+==================================================================+
463 +--------------+------------------------------------------------------------------+
464
465 Bug Fixes:
466
467 +----------------+--------------------------------------------------------------------------------------------------+
468 | JIRA ID        | Description                                                                                      |
469 +================+==================================================================================================+
470 | DMAAP-1065     | [DR] Casablanca - AAF certs expired on dmaap-dr-prov and dmaap-dr-node                           |
471 +----------------+--------------------------------------------------------------------------------------------------+
472
473 Known Issues:
474 N/A
475
476 Security Issues:
477 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
478 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
479 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
480
481 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
482 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
483 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
484
485 Upgrade Notes:
486 N/A
487
488 Deprecation Notes:
489 N/A
490
491 Other:
492 N/A
493
494
495 Casablanca
496 ==========
497
498 Version: 1.0.3
499 --------------
500
501 :Release Date: 2018-11-30
502
503 New Features:
504
505 +--------------+------------------------------------------------------------------+
506 | JIRA ID      | Description                                                      |
507 +==============+==================================================================+
508 | DMAAP-20     | REST api for publishing data to DR                               |
509 +--------------+------------------------------------------------------------------+
510 | DMAAP-21     | REST api for subscribing to data in DR                           |
511 +--------------+------------------------------------------------------------------+
512
513 Bug Fixes:
514
515 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
516 | JIRA ID        | Description                                                                                                                     |
517 +================+=================================================================================================================================+
518 | DMAAP-877      | DR Logging API not storing Feed/Sub data                                                                                        |
519 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
520 | DMAAP-850      | Second subscriber not receiving the published file                                                                              |
521 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
522 | DMAAP-596      | DR - datarouter-prov container fails to come up successfully                                                                    |
523 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
524 | DMAAP-565      | Incorrect nexusUrl parameter in datarouter pom files                                                                            |
525 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
526
527 Known Issues:
528 N/A
529
530 Security Issues:
531 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
532 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
533 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
534
535 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
536 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
537 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
538
539 Upgrade Notes:
540 N/A
541
542 Deprecation Notes:
543 N/A
544
545 Other:
546 N/A