72bb3c0619ba227125d3f522838c092b3220e7b5
[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 ..      * * *    GUILIN       * * *
8 ..      ===========================
9
10 DMaaP Data Router Release Notes
11 ===============================
12
13 Abstract
14 --------
15
16 This document provides the release notes for the DMaaP DR Guilin release.
17
18 Summary
19 -------
20
21 Release Data
22 ------------
23
24 +--------------------------------------+--------------------------------------+
25 | **DMaaP Data Router Project**        |                                      |
26 +--------------------------------------+--------------------------------------+
27 | **Docker images**                    | - datarouter-prov 2.1.7              |
28 |                                      | - datarouter-node 2.1.7              |
29 +--------------------------------------+--------------------------------------+
30 | **Release designation**              | 7.0.0 guilin                         |
31 +--------------------------------------+--------------------------------------+
32 | **Release date**                     | 2020-10-19 (TBD)                     |
33 +--------------------------------------+--------------------------------------+
34
35 New features
36 ------------
37
38 Known Limitations, Issues and Workarounds
39 -----------------------------------------
40
41 System Limitations
42 ------------------
43
44 Known Vulnerabilities
45 ---------------------
46
47 Workarounds
48 -----------
49
50 Security Notes
51 --------------
52
53
54 ..      ===========================
55 ..      * * *    FRANKFURT    * * *
56 ..      ===========================
57
58 DMaaP Data Router Release Notes
59 -------------------------------
60
61 Abstract
62 --------
63
64 This document provides the release notes for the DMaaP DR Frankfurt release.
65
66 Summary
67 -------
68
69 Release Data
70 ------------
71
72 +--------------------------------------+--------------------------------------+
73 | **DMaaP Data Router Project**        |                                      |
74 +--------------------------------------+--------------------------------------+
75 | **Docker images**                    | - datarouter-prov 2.1.6              |
76 |                                      | - datarouter-node 2.1.6              |
77 +--------------------------------------+--------------------------------------+
78 | **Release designation**              | 6.0.0 frankfurt                      |
79 +--------------------------------------+--------------------------------------+
80 | **Release date**                     | 2020-05-14 (TBD)                     |
81 +--------------------------------------+--------------------------------------+
82
83 New features
84 ------------
85
86 * Implement boolean flag in OOM to disable HTTP ports
87 * Dynamic cert distribution from OOM AAF
88
89 Known Limitations, Issues and Workarounds
90 -----------------------------------------
91
92 System Limitations
93 ------------------
94
95 Known Vulnerabilities
96 ---------------------
97 * CVE-2019-11358
98
99 Workarounds
100 -----------
101
102 Security Notes
103 --------------
104
105 References
106 ----------
107
108 For more information on the ONAP Frankfurt release, please see:
109
110 #. `ONAP Home Page`_
111 #. `ONAP Documentation`_
112 #. `ONAP Release Downloads`_
113 #. `ONAP Wiki Page`_
114
115 .. _`ONAP Home Page`: https://www.onap.org
116 .. _`ONAP Wiki Page`: https://wiki.onap.org
117 .. _`ONAP Documentation`: https://docs.onap.org
118 .. _`ONAP Release Downloads`: https://git.onap.org
119
120
121 Version: 2.1.2 (El Alto)
122 ---------------------------
123
124 :Release Date: 2019-09-05
125
126 New Features:
127
128 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
129 | JIRA ID        | Description                                                                                                                     |
130 +================+=================================================================================================================================+
131 | DMAAP-1227     | Updating logging functionality to log events into correct log files as specified in logging spec                                |
132 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
133 | DMAAP-1228     | Updating Logging pattern to match logging spec                                                                                  |
134 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
135 | DMAAP-1049     | [DR] Update DR logging to match Platform maturity Logging Spec                                                                  |
136 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
137
138 Bug Fixes:
139
140 +----------------+--------------------------------------------------------------------------------------------------+
141 | JIRA ID        | Description                                                                                      |
142 +================+==================================================================================================+
143 | DMAAP-1421     |  [DR] ElAlto AAF certs expired                                                                   |
144 +----------------+--------------------------------------------------------------------------------------------------+
145
146 Known Issues:
147 N/A
148
149 Security Issues:
150 N/A
151
152 Upgrade Notes:
153 N/A
154
155 Deprecation Notes:
156 N/A
157
158 Other:
159 N/A
160
161
162 Version: 2.1.0 (Dublin)
163 ---------------------------
164
165 :Release Date: 2019-06-06
166
167 New Features:
168
169 +--------------+-------------------------------------------------------------------------------+
170 | JIRA ID      | Description                                                                   |
171 +==============+===============================================================================+
172 | DMAAP-978    | [DR] Query of publication history (new API) for use by Data File Collector)   |
173 +--------------+-------------------------------------------------------------------------------+
174 | DMAAP-980    | [DR] Optional consumer compression feed handling                              |
175 +--------------+-------------------------------------------------------------------------------+
176 | DMAAP-1016   | DR provisioning AAF integration                                               |
177 +--------------+-------------------------------------------------------------------------------+
178
179 Bug Fixes:
180
181 +----------------+--------------------------------------------------------------------------------------------------+
182 | JIRA ID        | Description                                                                                      |
183 +================+==================================================================================================+
184 | DMAAP-964      | [DMAAP] DMAAP deployment failures starting 20190115 on casablanca branch                         |
185 +----------------+--------------------------------------------------------------------------------------------------+
186 | DMAAP-1010     | [DR] DMaaP Data Router fails healthcheck                                                         |
187 +----------------+--------------------------------------------------------------------------------------------------+
188 | DMAAP-1047     | [DR] Data Router docker version missing explicit version number                                  |
189 +----------------+--------------------------------------------------------------------------------------------------+
190 | DMAAP-1048     | [DR] AAF certs expired on dmaap-dr-prov and dmaap-dr-node                                        |
191 +----------------+--------------------------------------------------------------------------------------------------+
192 | DMAAP-1161     | [DR] filebeat container on DR-Node and DR-Prov are unable to publish to kibana                   |
193 +----------------+--------------------------------------------------------------------------------------------------+
194
195 Known Issues:
196 N/A
197
198 Security Issues:
199
200 *Fixed Security Issues*
201
202 *Known Security Issues*
203
204 - In default deployment DMAAP (dmaap-dr-prov) exposes HTTP port 30259 outside of cluster. [`OJSI-158 <https://jira.onap.org/browse/OJSI-158>`_]
205
206 *Known Vulnerabilities in Used Modules*
207
208 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
209 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
210 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
211
212 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
213 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
214 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
215
216 Upgrade Notes:
217 N/A
218
219 Deprecation Notes:
220 N/A
221
222 Other:
223 N/A
224
225
226 Version: 1.0.8 (Casablanca)
227 ---------------------------
228
229 :Release Date: 2019-02-28
230
231 New Features:
232
233 +--------------+------------------------------------------------------------------+
234 | JIRA ID      | Description                                                      |
235 +==============+==================================================================+
236 +--------------+------------------------------------------------------------------+
237
238 Bug Fixes:
239
240 +----------------+--------------------------------------------------------------------------------------------------+
241 | JIRA ID        | Description                                                                                      |
242 +================+==================================================================================================+
243 | DMAAP-1065     | [DR] Casablanca - AAF certs expired on dmaap-dr-prov and dmaap-dr-node                           |
244 +----------------+--------------------------------------------------------------------------------------------------+
245
246 Known Issues:
247 N/A
248
249 Security Issues:
250 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
251 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
252 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
253
254 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
255 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
256 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
257
258 Upgrade Notes:
259 N/A
260
261 Deprecation Notes:
262 N/A
263
264 Other:
265 N/A
266
267
268 Version: 1.0.3 (Casablanca)
269 ---------------------------
270
271 :Release Date: 2018-11-30
272
273 New Features:
274
275 +--------------+------------------------------------------------------------------+
276 | JIRA ID      | Description                                                      |
277 +==============+==================================================================+
278 | DMAAP-20     | REST api for publishing data to DR                               |
279 +--------------+------------------------------------------------------------------+
280 | DMAAP-21     | REST api for subscribing to data in DR                           |
281 +--------------+------------------------------------------------------------------+
282
283 Bug Fixes:
284
285 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
286 | JIRA ID        | Description                                                                                                                     |
287 +================+=================================================================================================================================+
288 | DMAAP-877      | DR Logging API not storing Feed/Sub data                                                                                        |
289 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
290 | DMAAP-850      | Second subscriber not receiving the published file                                                                              |
291 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
292 | DMAAP-596      | DR - datarouter-prov container fails to come up successfully                                                                    |
293 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
294 | DMAAP-565      | Incorrect nexusUrl parameter in datarouter pom files                                                                            |
295 +----------------+---------------------------------------------------------------------------------------------------------------------------------+
296
297 Known Issues:
298 N/A
299
300 Security Issues:
301 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been
302 addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open
303 Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_.
304
305 - `DMAAP Project Page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
306 - `Passing Badge information for DMAAP DataRouter <https://bestpractices.coreinfrastructure.org/en/projects/2192>`_
307 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=42598688>`_
308
309 Upgrade Notes:
310 N/A
311
312 Deprecation Notes:
313 N/A
314
315 Other:
316 N/A