[DMAAP-BC] Consolidate bus controller repos
[dmaap/buscontroller.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 .. DO NOT CHANGE THIS LABEL FOR RELEASE NOTES - EVEN THOUGH IT GIVES A WARNING
4 .. _release_notes:
5
6 =============
7 Release Notes
8 =============
9
10 .. note
11 ..      * This Release Notes must be updated each time the team decides to Release new artifacts.
12 ..      * The scope of these Release Notes are for ONAP DMaaP Buscontroller. In other words, each ONAP component has its Release Notes.
13 ..      * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of
14 ..      * this Release Notes.
15 ..      * Except the date and the version number, all the other sections are optional but there must be at least
16 ..      * one section describing the purpose of this new release.
17 ..      * This note must be removed after content has been added.
18
19
20
21 Honolulu
22 ========
23
24
25
26 Abstract
27 --------
28
29
30 This document provides the release notes for the Honolulu release.
31
32
33 Summary
34 -------
35
36 Mainly Security changes to update Project Lead details, and update outdated packages
37
38 Release Data
39 ------------
40
41 +--------------------------------------+--------------------------------------+
42 | **DMaaP Bus Controller Project**     |                                      |
43 |                                      |                                      |
44 +--------------------------------------+--------------------------------------+
45 | **Docker images**                    | - dmaap-bc 2.0.5                     |
46 |                                      | - dbc-client 1.0.9                   |
47 +--------------------------------------+--------------------------------------+
48 | **Release designation**              | 8.0.0 Honolulu                       |
49 |                                      |                                      |
50 +--------------------------------------+--------------------------------------+
51 | **Release date**                     | 2021-04-01 (TBD)                     |
52 |                                      |                                      |
53 +--------------------------------------+--------------------------------------+
54
55
56 New features
57 ------------
58 * Updated log4j (Listed in "Known Vulternabilities" below) - DMAAP-1515
59 * Update Project Lead details - DMAAP-1538
60
61 Known Limitations, Issues and Workarounds
62 -----------------------------------------
63
64 System Limitations
65 ------------------
66
67
68 Known Vulnerabilities
69 ---------------------
70
71 * CVE-2019-17571
72
73 Workarounds
74 -----------
75
76
77 Security Notes
78 --------------
79
80
81 References
82 ----------
83
84 For more information on the ONAP Honolulu release, please see:
85
86 #. `ONAP Home Page`_
87 #. `ONAP Documentation`_
88 #. `ONAP Release Downloads`_
89 #. `ONAP Wiki Page`_
90
91
92 .. _`ONAP Home Page`: https://www.onap.org
93 .. _`ONAP Wiki Page`: https://wiki.onap.org
94 .. _`ONAP Documentation`: https://docs.onap.org
95 .. _`ONAP Release Downloads`: https://git.onap.org
96
97
98 Quick Links:
99
100 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
101
102 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
103
104 Guilin
105 ======
106
107 Abstract
108 --------
109
110
111 This document provides the release notes for the Guilin release.
112
113
114 Summary
115 -------
116
117 Release Data
118 ------------
119
120 +--------------------------------------+--------------------------------------+
121 | **DMaaP Bus Controller Project**     |                                      |
122 |                                      |                                      |
123 +--------------------------------------+--------------------------------------+
124 | **Docker images**                    | - dmaap-bc 2.0.4                     |
125 |                                      | - dbc-client 1.0.9                   |
126 +--------------------------------------+--------------------------------------+
127 | **Release designation**              | 7.0.0 guilin                         |
128 |                                      |                                      |
129 +--------------------------------------+--------------------------------------+
130 | **Release date**                     | 2020-11-18                           |
131 |                                      |                                      |
132 +--------------------------------------+--------------------------------------+
133
134
135 New features
136 ------------
137
138 Known Limitations, Issues and Workarounds
139 -----------------------------------------
140
141 System Limitations
142 ------------------
143
144
145 Known Vulnerabilities
146 ---------------------
147
148 * CVE-2018-11307
149 * CVE-2018-12022
150 * CVE-2018-12023
151 * CVE-2019-17571
152 * CVE-2016-2510
153 * CVE-2017-18640
154
155
156 Workarounds
157 -----------
158
159
160 Security Notes
161 --------------
162
163
164 References
165 ----------
166
167 For more information on the ONAP Guilin release, please see:
168
169 #. `ONAP Home Page`_
170 #. `ONAP Documentation`_
171 #. `ONAP Release Downloads`_
172 #. `ONAP Wiki Page`_
173
174
175 .. _`ONAP Home Page`: https://www.onap.org
176 .. _`ONAP Wiki Page`: https://wiki.onap.org
177 .. _`ONAP Documentation`: https://docs.onap.org
178 .. _`ONAP Release Downloads`: https://git.onap.org
179
180
181 Quick Links:
182
183 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
184
185 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
186
187 Frankfurt
188 =========
189
190
191 Abstract
192 --------
193
194
195 This document provides the release notes for the Frankfurt release.
196
197
198 Summary
199 -------
200
201 The Frankfurt release focused on improved packaging and deployment.
202
203 Release Data
204 ------------
205
206 +--------------------------------------+--------------------------------------+
207 | **DMaaP Bus Controller Project**     |                                      |
208 |                                      |                                      |
209 +--------------------------------------+--------------------------------------+
210 | **Docker images**                    | - dmaap-bc 2.0.4                     |
211 |                                      | - dbc-client 1.0.9                   |
212 +--------------------------------------+--------------------------------------+
213 | **Release designation**              | 6.0.0 frankfurt                      |
214 |                                      |                                      |
215 +--------------------------------------+--------------------------------------+
216 | **Release date**                     | 2020-05-14 (TBD)                     |
217 |                                      |                                      |
218 +--------------------------------------+--------------------------------------+
219
220
221 New features
222 ------------
223
224 * Implement boolean flag in OOM to disable HTTP ports
225 * Dynamic cert distribution from OOM AAF.  The dmaap-bc pod now utilizes an initContainer to acquire SSL certificates from AAF 
226 * the core library, dbcapi, now utilizes Java 11 and new base images were required, so we consider this a major release increment.
227
228
229 Known Limitations, Issues and Workarounds
230 -----------------------------------------
231
232
233 System Limitations
234 ------------------
235
236
237 Known Vulnerabilities
238 ---------------------
239
240 * CVE-2018-11307
241 * CVE-2018-12022
242 * CVE-2018-12023
243 * CVE-2019-17571
244 * CVE-2016-2510
245 * CVE-2017-18640
246
247
248 Workarounds
249 -----------
250
251
252 Security Notes
253 --------------
254
255
256 References
257 ----------
258
259 For more information on the ONAP Frankfurt release, please see:
260
261 #. `ONAP Home Page`_
262 #. `ONAP Documentation`_
263 #. `ONAP Release Downloads`_
264 #. `ONAP Wiki Page`_
265
266
267 .. _`ONAP Home Page`: https://www.onap.org
268 .. _`ONAP Wiki Page`: https://wiki.onap.org
269 .. _`ONAP Documentation`: https://docs.onap.org
270 .. _`ONAP Release Downloads`: https://git.onap.org
271
272
273 Quick Links:
274
275 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
276
277 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
278
279 El Alto
280 =======
281
282 Version: 1.1.5 
283 --------------
284
285 : Release Date: 2019-06-06 (El Alto)
286
287 **New Features**
288
289  - No new features
290
291 **Bug Fixes**
292        NA
293
294 **Known Issues**
295        NA
296
297 **Security Notes**
298 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
299
300 Quick Links:
301
302 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
303
304 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
305
306 - `El Alto Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=71835817>`_
307
308 **Upgrade Notes**
309        NA
310
311 **Deprecation Notes**
312        NA
313         
314
315
316 Version: 1.1.5 (Dublin)
317 -----------------------
318 : Release Date: 2019-06-06
319
320 **New Features**
321
322  - DMaaP Provisioning via Bus Controller
323
324 **Bug Fixes**
325        NA
326
327 **Known Issues**
328        NA
329
330 **Security Notes**
331 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `Dublin <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_.
332
333 Quick Links:
334
335 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
336
337 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
338
339 - `Dublin Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=64003715>`_
340
341 **Upgrade Notes**
342 NA
343
344 **Deprecation Notes**
345
346
347 Version: 1.0.23
348 ---------------
349 : Release Date: 2018-10-18
350
351 **New Features**
352
353  - configMap for properties
354  - AAF integration
355
356 **Bug Fixes**
357        NA
358
359 **Known Issues**
360        NA
361
362 **Security Notes**
363 DMAAP code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The DMAAP open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_.
364
365 Quick Links:
366
367 - `DMAAP project page <https://wiki.onap.org/display/DW/DMaaP+Planning>`_
368
369 - `Passing Badge information for DMAAP <https://bestpractices.coreinfrastructure.org/en/projects/2147>`_
370
371 - `Project Vulnerability Review Table for DMAAP <https://wiki.onap.org/pages/viewpage.action?pageId=28379799>`_
372
373 **Upgrade Notes**
374 NA
375
376 **Deprecation Notes**