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