LOG-1057 Update release notes for Dublin
[logging-analytics.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Log Enhancements Release Notes
4 ==============================
5
6 Version: 4.0.0 Dublin Release
7 --------------
8 Dublin
9 --------------
10    - logging-analytics Version: 1.2.6
11
12 --------------
13 :Release Date: 2019-06-18
14
15 **New Features**
16
17 **Bug Fixes**
18    
19 **Known Issues**
20
21 **Security Notes**
22
23 LOG 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
24
25 Quick Links:
26         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
27
28         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
29
30         - `Project Vulnerability Review Table for LOG <TBD>`_
31
32 **Upgrade Notes**
33       None
34
35 **Deprecation Notes**
36       None
37
38 **Other**
39       None
40
41
42 POMBA Release Notes
43 --------------
44 POMBA is sub-project of the Logging Enhancements Project.
45
46 Dublin
47 --------------
48    - pomba-audit-common Version: 1.4.0
49    - pomba-aai-context-builder Version: 1.4.0
50    - pomba-context-aggregator Version: 1.4.0
51    - pomba-network-discovery-context-builder Version: 1.4.0
52    - pomba-sdc-context-builder Version: 1.4.0
53    - pomba-sdnc-context-builder Version: 1.4.0
54
55 --------------
56 :Release Date:  2019-06-18
57
58 **New Features**
59    - Version 2 of the audit common model
60    - Initial release of SDNC context builder
61
62 **Bug Fixes**
63
64
65 **Known Issues**
66
67    - `LOG-1017 <https://jira.onap.org/browse/LOG-1017>`_ Violations are thrown on attributes that are same (or missing)
68    - `LOG-1016 <https://jira.onap.org/browse/LOG-1016>`_ When comparing attributes from multiple sources, violations thrown do not accurately show the issue.
69    - `LOG-836 <https://jira.onap.org/browse/LOG-836>`_ Logging/POMBA CLM: fix/address/red-flag glassfish bean-validator-2.4.0-b34.jar SEC
70    - `LOG-874 <https://jira.onap.org/browse/LOG-874>`_ Logging CLM: fix/address/red-flag License org.json:json-20140107.jar
71    - `LOG-832 <https://jira.onap.org/browse/LOG-832>`_ Logging/POMBA CLM: fix/address/red-flag SEC jackson-databind-2.4.5.jar - auditcommon - even 2.9.7 is still red
72    - `LOG-831 <https://jira.onap.org/browse/LOG-831>`_ Logging/POMBA CLM: fix/address/red-flag License javax.jms:jms-1.1.jar
73    - `LOG-769 <https://jira.onap.org/browse/LOG-769>`_ POMBA aai ctx pod reports HD full - but DF shows HD is OK
74    - `LOG-826 <https://jira.onap.org/browse/LOG-826>`_ Logging/POMBA CLM: fix/address/red-flag jackson-databind-2.8.11.3 SEC
75    - `LOG-1060 <https://jira.onap.org/browse/LOG-1060>`_ Logging CLM: fix/address/red-flag jackson-databind-2.8.6 SEC
76    - `LOG-1061 <https://jira.onap.org/browse/LOG-1061>`_ POMBA-AUDIT-COMMON CLM: fix/address/red-flag jackson-databind-2.4.5 SEC
77    - `LOG-1063 <https://jira.onap.org/browse/LOG-1063>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag plexus-utils : 3.0.22 SEC
78    - `LOG-1064 <https://jira.onap.org/browse/LOG-1064>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag commons-beanutils : 1.9.3 SEC
79    - `LOG-1062 <https://jira.onap.org/browse/LOG-1062>`_ POMBA-SDNC-CONTEXT-BUILDER CLM: fix/address/red-flag struts-core : 1.3.8-2.4.5 SEC
80    - `LOG-827 <https://jira.onap.org/browse/LOG-827>`_ Logging/POMBA CLM: fix/address/red-flag handlebars-2.0.0.js SEC - upgrade to 4.0.0+
81    - `LOG-830 <https://jira.onap.org/browse/LOG-830>`_ Logging/POMBA CLM: fix/address/red-flag License org.json:json-20140107.jar
82
83 **Security Notes**
84    - all nodeports for Kibana, context builders and data-router are open by default for now
85
86 POMBA 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
87
88 Quick Links:
89    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
90    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
91    - `See the result from LOG <TBD>`_
92
93 **Upgrade Notes**
94       None
95
96 **Deprecation Notes**
97       None
98
99 **Other**
100       None
101
102 Version: 3.0.1 Casablanca Release
103 --------------
104 Casablanca
105 --------------
106    - logging-analytics Version: 1.2.6
107
108 --------------
109 :Release Date: 2019-02-08
110
111 **New Features**
112    - kubernetes installation upped to 1.11.5 in the Rancher 1.6.25 RI
113    - NFS support for AWS EFS
114
115 **Bug Fixes**
116    - `LOG-837 <https://jira.onap.org/browse/LOG-837>`_ Logging/POMBA CLM: fix/address/red-flag spring-mvc-5.1.2 pulls in spring-web-5.0.9
117
118 **Known Issues**
119
120    - `LOG-376 <https://jira.onap.org/browse/LOG-376>`_ Logstash load balancing is asymmetric wherever AAI is run
121    - `LOG-895 <https://jira.onap.org/browse/LOG-895>`_ Upgrade Rancher to 1.6.25 to address CVE-2018-1002105 and move to Kubernetes 1.11.5 (server side)
122
123 **Security Notes**
124
125 LOG 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
126
127 Quick Links:
128         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
129
130         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
131
132         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
133
134 **Upgrade Notes**
135       None
136
137 **Deprecation Notes**
138       None
139
140 **Other**
141       None
142
143
144 POMBA Release Notes
145 --------------
146 POMBA is sub-project of the Logging Enhancements Project.
147
148 Casablanca
149 --------------
150    - pomba-audit-common Version: 1.3.2
151    - pomba-aai-context-builder Version: 1.3.2
152    - pomba-context-aggregator Version: 1.3.4
153    - pomba-network-discovery-context-builder Version: 1.3.1
154    - pomba-sdc-context-builder Version: 1.3.2
155
156 --------------
157 :Release Date:  2019-02-08
158
159 **New Features**
160    - Version 1 of the audit common model
161    - Initial release of context aggregator and 3 context builders
162
163 **Bug Fixes**
164
165    - `LOG-892 <https://jira.onap.org/browse/LOG-892`_ PORT - POMBA Network Discovery Context Builder does not log
166
167 **Known Issues**
168
169    - `LOG-913 <https://jira.onap.org/browse/LOG-913>`_ POMBA: 1 of 11 pods failing on sequenced startup on 3.0.0-ONAP - pomba is 22 on the order - looks timing related
170    - `LOG-950 <https://jira.onap.org/browse/LOG-950>`_ LOG-950 upped the numbers from 10 to 30 – for intermittent deploy timing – this is an issue for several projects since 3.0.0-ONAP - the solution is a sequenced 5h deploy via `cd.sh <https://git.onap.org/logging-analytics/tree/deploy/cd.sh#n228>`_ and/or better vms for now until the `dependencies <https://wiki.onap.org/display/DW/Log+Streaming+Compliance+and+API#LogStreamingComplianceandAPI-DeploymentDependencyTree-Containerlevel>`_ and jobs are refactored into helm hooks
171
172 **Security Notes**
173    - all three nodeports for kibana, context builder and data-router are open by default for now
174
175 POMBA 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
176
177 Quick Links:
178    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
179    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
180    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
181
182 **Upgrade Notes**
183       None
184
185 **Deprecation Notes**
186       None
187
188 **Other**
189       None
190
191
192 Version: 1.2.2 Casablanca
193 --------------
194
195 :Release Date: 2018-11-30
196
197 **New Features**
198    - Demo slf4j library with marker/mdc support along with kubernetes, docker, war support projects.
199
200 **Bug Fixes**
201
202
203 **Known Issues**
204    - `Logstash load balancing is asymmetric wherever AAI is run <https://jira.onap.org/browse/LOG-376>`_
205
206 **Security Notes**
207
208 LOG 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_.
209
210 Quick Links:
211         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
212
213         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
214
215         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
216
217 **Upgrade Notes**
218       None
219
220 **Deprecation Notes**
221       None
222
223 **Other**
224       None
225
226
227 POMBA Release Notes
228 --------------
229 POMBA is sub-project of the Logging Enhancements Project.
230
231 Casablanca
232 --------------
233    - pomba-audit-common Version: 1.3.1
234    - pomba-aai-context-builder Version: 1.3.1
235    - pomba-context-aggregator Version: 1.3.3
236    - pomba-network-discovery-context-builder Version: 1.3.0
237    - pomba-sdc-context-builder Version: 1.3.1
238
239
240 --------------
241
242 :Release Date: 2018-11-15
243
244 **New Features**
245    - Version 1 of the audit common model
246    - Initial release of context aggregator and 3 context builders
247
248 **Bug Fixes**
249
250
251 **Known Issues**
252
253
254 **Security Notes**
255    - all three nodeports for kibana, context builder and data-router are open by default for now
256
257 POMBA 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
258
259 Quick Links:
260    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
261    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
262    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
263
264 **Upgrade Notes**
265       None
266
267 **Deprecation Notes**
268       None
269
270 **Other**
271       None
272
273 Version: Beijing
274 --------------
275
276 :Release Date: 2018-06-07
277
278 **New Features**
279    - Logstash is a daemonset (clustered at 1 container per VM)
280    - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
281
282 **Bug Fixes**
283
284
285 **Known Issues**
286    - Logstash load balancing is asymmetric
287
288 **Security Notes**
289    - all three nodeports for logstash, elasticsearch and kibana are open by default for now
290
291 LOG 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 LOG open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_.
292
293 Quick Links:
294         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
295
296         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
297
298         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
299
300 **Upgrade Notes**
301       None
302
303 **Deprecation Notes**
304       None
305
306 **Other**
307       Note: there was no released artifacts under 1.2.2 for Beijing - release was pushed to Casablanca
308
309
310
311 Version: 1.0.0
312 --------------
313
314 :Release Date: 2017-11-16
315
316 **New Features**
317
318 This release adds Elastic Stack analytics deployment to OOM, aligns logging provider configurations, and fixes issues with the propagation of transaction IDs and other contextual information.
319
320     - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
321     - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
322     - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
323     - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
324
325 **Bug Fixes**
326
327     - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
328     - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
329
330 **Known Issues**
331
332     - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
333       Unable to find logback xml for DMaaP component.
334       Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
335
336     - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
337       SO Logging Provider Config File need correction in Timestamp MDC.
338       Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
339       The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected  pattern is - 2017-09-25T05:30:07.832Z.
340
341     - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
342       The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
343
344     - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
345       SO log format error during Health Check - blocking tracking jira for SO-246.
346
347 **Security Issues**
348       None
349
350 **Upgrade Notes**
351       None
352
353 **Deprecation Notes**
354       None
355
356 **Other**
357       None
358
359 ===========
360
361 End of Release Notes