POMBA casablanca release notes
[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: 1.2.2 Casablanca
7 --------------
8
9 :Release Date: 2018-11-15
10
11 **New Features**
12    - Demo slf4j library with marker/mdc support along with kubernetes, docker, war support projects.
13
14 **Bug Fixes**
15
16
17 **Known Issues**
18    - `Logstash load balancing is asymmetric wherever AAI is run - https://jira.onap.org/browse/LOG-376`_
19
20 **Security Notes**
21       None
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=28378692>`_.
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 <https://wiki.onap.org/pages/viewpage.action?pageId=43385152>`_
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 Casablanca
47 --------------
48 pomba-audit-common Version: 1.3.1
49 pomba-aai-context-builder Version: 1.3.1
50 pomba-context-aggregator Version: 1.3.3
51 pomba-network-discovery-context-builder Version: 1.3.0
52 pomba-sdc-context-builder Version: 1.3.1
53
54
55 --------------
56
57 :Release Date: 2018-11-15
58
59 **New Features**
60    - Version 1 of the audit common model
61    - Initial release of context aggregator and 3 context builders
62
63 **Bug Fixes**
64
65
66 **Known Issues**
67
68
69 **Security Notes**
70    - all three nodeports for kibana, context builder and data-router are open by default for now
71
72 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>`_.
73
74 Quick Links:
75         - `POMBA project page <https://wiki.onap.org/display/DW/POMBA>`_
76         
77         - `See the result from LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
78         
79         - `See the result from LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
80
81 **Upgrade Notes**
82       None
83
84 **Deprecation Notes**
85       None
86
87 **Other**
88       None
89
90 Version: Beijing
91 --------------
92
93 :Release Date: 2018-06-07
94
95 **New Features**
96    - Logstash is a daemonset (clustered at 1 container per VM)
97    - `The following applications send logs to the ELK stack - <https://jira.onap.org/browse/LOG-230>`_
98
99 **Bug Fixes**
100
101
102 **Known Issues**
103    - Logstash load balancing is asymmetric
104
105 **Security Notes**
106    - all three nodeports for logstash, elasticsearch and kibana are open by default for now
107
108 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>`_.
109
110 Quick Links:
111         - `LOG project page <https://wiki.onap.org/display/DW/Logging+Enhancements+Project>`_
112
113         - `Passing Badge information for LOG <https://bestpractices.coreinfrastructure.org/en/projects/1578>`_
114
115         - `Project Vulnerability Review Table for LOG <https://wiki.onap.org/pages/viewpage.action?pageId=28378692>`_
116
117 **Upgrade Notes**
118       None
119
120 **Deprecation Notes**
121       None
122
123 **Other**
124       Note: there was no released artifacts under 1.2.2 for Beijing - release was pushed to Casablanca
125
126
127
128 Version: 1.0.0
129 --------------
130
131 :Release Date: 2017-11-16
132
133 **New Features**
134
135 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.
136
137     - `LOG-1 <https://jira.onap.org/browse/LOG-1>`_ Transaction ID propagation.
138     - `LOG-2 <https://jira.onap.org/browse/LOG-2>`_ Standardized logging provider configuration.
139     - `LOG-3 <https://jira.onap.org/browse/LOG-3>`_ Elastic Stack reference analytics pipeline.
140     - `LOG-4 <https://jira.onap.org/browse/LOG-4>`_ Transaction ID conventions.
141
142 **Bug Fixes**
143
144     - `LOG-64 <https://jira.onap.org/browse/LOG-64>`_ Logger field has a length restriction of 36 which needs a fix.
145     - `LOG-74 <https://jira.onap.org/browse/LOG-74>`_ Extract componentName from the source path of log files.
146
147 **Known Issues**
148
149     - `LOG-43 <https://jira.onap.org/browse/LOG-43>`_
150       Unable to find logback xml for DMaaP component.
151       Logging file for DMaaP is available in this jar "eelf-core-0.0.1.jar".
152
153     - `LOG-65 <https://jira.onap.org/browse/LOG-65>`_
154       SO Logging Provider Config File need correction in Timestamp MDC.
155       Logging provider configuration file for SO i.e. logback files requires correction in Timestamp MDC for correct MDC generation in log.
156       The current pattern prints Timestamp as 2017-09-25 05:30:07,832. Expected  pattern is - 2017-09-25T05:30:07.832Z.
157
158     - `LOG-80 <https://jira.onap.org/browse/LOG-80>`_ Kibana does not seem to show all the logs from application pods.
159       The content of the log directories (/var/log/onap/mso) are not 100% reflected in Kibana.
160
161     - `LOG-88 <https://jira.onap.org/browse/LOG-88>`_
162       SO log format error during Health Check - blocking tracking jira for SO-246.
163
164 **Security Issues**
165       None
166
167 **Upgrade Notes**
168       None
169
170 **Deprecation Notes**
171       None
172
173 **Other**
174       None
175
176 ===========
177
178 End of Release Notes