Michael OBrien committer status off
[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: 3.0.1 Casablanca Release
7 --------------
8 Casablanca
9 --------------
10    - logging-analytics Version: 1.2.6
11
12 --------------
13 :Release Date: 2019-02-08
14
15 **New Features**
16    - kubernetes installation upped to 1.11.5 in the Rancher 1.6.25 RI
17    - NFS support for AWS EFS
18
19 **Bug Fixes**
20    - `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
21
22 **Known Issues**
23
24    - `LOG-376 <https://jira.onap.org/browse/LOG-376>`_ Logstash load balancing is asymmetric wherever AAI is run
25    - `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)
26
27 **Security Notes**
28
29 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>`_.
30
31 Quick Links:
32         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
33
34         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
35
36         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
37
38 **Upgrade Notes**
39       None
40
41 **Deprecation Notes**
42       None
43
44 **Other**
45       None
46
47
48 POMBA Release Notes
49 --------------
50 POMBA is sub-project of the Logging Enhancements Project.
51
52 Casablanca
53 --------------
54    - pomba-audit-common Version: 1.3.2
55    - pomba-aai-context-builder Version: 1.3.2
56    - pomba-context-aggregator Version: 1.3.4
57    - pomba-network-discovery-context-builder Version: 1.3.1
58    - pomba-sdc-context-builder Version: 1.3.2
59
60 --------------
61 :Release Date:  2019-02-08
62
63 **New Features**
64    - Version 1 of the audit common model
65    - Initial release of context aggregator and 3 context builders
66
67 **Bug Fixes**
68
69    - `LOG-892 <https://jira.onap.org/browse/LOG-892`_ PORT - POMBA Network Discovery Context Builder does not log
70
71 **Known Issues**
72
73    - `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
74    - `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
75
76 **Security Notes**
77    - all three nodeports for kibana, context builder and data-router are open by default for now
78
79 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>`_.
80
81 Quick Links:
82    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
83    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
84    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
85
86 **Upgrade Notes**
87       None
88
89 **Deprecation Notes**
90       None
91
92 **Other**
93       None
94
95
96 Version: 1.2.2 Casablanca
97 --------------
98
99 :Release Date: 2018-11-30
100
101 **New Features**
102    - Demo slf4j library with marker/mdc support along with kubernetes, docker, war support projects.
103
104 **Bug Fixes**
105
106
107 **Known Issues**
108    - `Logstash load balancing is asymmetric wherever AAI is run <https://jira.onap.org/browse/LOG-376>`_
109
110 **Security Notes**
111
112 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>`_.
113
114 Quick Links:
115         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
116
117         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
118
119         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=45307852>`_
120
121 **Upgrade Notes**
122       None
123
124 **Deprecation Notes**
125       None
126
127 **Other**
128       None
129
130
131 POMBA Release Notes
132 --------------
133 POMBA is sub-project of the Logging Enhancements Project.
134
135 Casablanca
136 --------------
137    - pomba-audit-common Version: 1.3.1
138    - pomba-aai-context-builder Version: 1.3.1
139    - pomba-context-aggregator Version: 1.3.3
140    - pomba-network-discovery-context-builder Version: 1.3.0
141    - pomba-sdc-context-builder Version: 1.3.1
142
143
144 --------------
145
146 :Release Date: 2018-11-15
147
148 **New Features**
149    - Version 1 of the audit common model
150    - Initial release of context aggregator and 3 context builders
151
152 **Bug Fixes**
153
154
155 **Known Issues**
156
157
158 **Security Notes**
159    - all three nodeports for kibana, context builder and data-router are open by default for now
160
161 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>`_.
162
163 Quick Links:
164    - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
165    - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
166    - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
167
168 **Upgrade Notes**
169       None
170
171 **Deprecation Notes**
172       None
173
174 **Other**
175       None
176
177 Version: Beijing
178 --------------
179
180 :Release Date: 2018-06-07
181
182 **New Features**
183    - Logstash is a daemonset (clustered at 1 container per VM)
184    - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
185
186 **Bug Fixes**
187
188
189 **Known Issues**
190    - Logstash load balancing is asymmetric
191
192 **Security Notes**
193    - all three nodeports for logstash, elasticsearch and kibana are open by default for now
194
195 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>`_.
196
197 Quick Links:
198         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
199
200         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
201
202         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
203
204 **Upgrade Notes**
205       None
206
207 **Deprecation Notes**
208       None
209
210 **Other**
211       Note: there was no released artifacts under 1.2.2 for Beijing - release was pushed to Casablanca
212
213
214
215 Version: 1.0.0
216 --------------
217
218 :Release Date: 2017-11-16
219
220 **New Features**
221
222 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.
223
224     - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
225     - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
226     - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
227     - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
228
229 **Bug Fixes**
230
231     - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
232     - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
233
234 **Known Issues**
235
236     - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
237       Unable to find logback xml for DMaaP component.
238       Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
239
240     - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
241       SO Logging Provider Config File need correction in Timestamp MDC.
242       Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
243       The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected  pattern is - 2017-09-25T05:30:07.832Z.
244
245     - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
246       The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
247
248     - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
249       SO log format error during Health Check - blocking tracking jira for SO-246.
250
251 **Security Issues**
252       None
253
254 **Upgrade Notes**
255       None
256
257 **Deprecation Notes**
258       None
259
260 **Other**
261       None
262
263 ===========
264
265 End of Release Notes