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