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