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