summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
blob: d30bfd101d256ef3c6ad6b38be3d4360a3015878 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0


Holmes Rule Management Release Notes
====================================

Holmes provides alarm correlation and analysis for telecom cloud infrastructure
and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root
reason which causes the failure or degradation of services by digging into the
ocean of events collected from different levels of the telecom cloud.

Version: 5.0.1
--------------

:Release Date: 2019-10-17


**New Features**
N/A

**Bug Fixes**
N/A

**Known Issues**

- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.

**Security Issues**

HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. 

Quick Links:
    - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
     
 	- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_


**Upgrade Notes**

N/A


**Deprecation Notes**

N/A


**Other**

N/A

Version: 1.2.6
--------------

:Release Date: 2019-06-13


**New Features**
Added some tools to support the extended CCVPN use case:

- `Rules for CCVEN Extension <https://jira.onap.org/browse/HOLMES-193>`_ This feature provides some rules for the extended CCVPN usecase. Users could use the rules as templates to develop their own rules.
- `Updated AAI Assistant Tools for CCVPN Extension <https://jira.onap.org/browse/HOLMES-194>`_ Some tools related to the CCVPN usecase have been enhanced in order to support the extended CCVPN usecase.

**Bug Fixes**

- `HOLMES-204 <https://jira.onap.org/browse/HOLMES-204>`_ Alarms can not be deleted from the DB when they get cleared.
- `HOLMES-223 <https://jira.onap.org/browse/HOLMES-223>`_ The "ABATED" messages can not be generated in the control loop.

**Known Issues**

- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.

**Security Issues**

HOLMES code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, some of the items that remain open have been assessed for risk and determined to be false positive and the rest are planned to be resolved in the next release. 

Quick Links:
    - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
     
 	- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_


**Upgrade Notes**

N/A


**Deprecation Notes**

N/A


**Other**

N/A

===========

Version: 1.2.0
--------------

:Release Date: 2018-11-30


**New Features**
In the Casablanca release, Holmes provides its own GUI for rule management tasks:

- `UI Deployment <https://jira.onap.org/browse/HOLMES-96>`_ This feature provides a graphic user interface for the sake of easiness of rule management. It mainly provides a rule list view and a rule editing page. Users could get an overview of all rules that have been added to Holmes and create/modify them easily by using the GUI provided by this feature.

Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related assistant tools are added to the common library of Holmes.

**Bug Fixes**

- `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from the engine.
- `HOLMES-133 <https://jira.onap.org/browse/HOLMES-133>`_ Don't rely on key word 'import' when extracting package name from rule.
- `HOLMES-130 <https://jira.onap.org/browse/HOLMES-130>`_ Holmes can not be successfully registered to MSB when trying to register itself with a health check parameter.

**Known Issues**

- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.

**Security Issues**

HOLMES 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 HOLMES open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_.

Quick Links:
    - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
     
 	- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
 	
 	- `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_


**Upgrade Notes**

N/A


**Deprecation Notes**

N/A


**Other**

N/A

===========


Version: 1.1.0
--------------

:Release Date: 2018-06-07


**New Features**
In the Beijing release, Holmes provides no more functionalites than the Amsterdam release. Its main features remains like follows:

- `Rule Management <https://jira.onap.org/browse/HOLMES-4>`_ The feature provides interfaces for the users to create, query, update and delete rules. In this release, they are used along with the DCAE interfaces to accomplish the deployment (creation/update) of the control loop related rules.

- `Engine Management <https://jira.onap.org/browse/HOLMES-5>`_ The feature is not exposed to the end user directly. It's mainly used internally by Holmes as a container for the execution of rules. It provides interface for rule verification and deployment/un-deployment.

Besides, Holmes has been enhanced to meet the platform maturity requirements. The enhancement mainly covers:

- Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data.

- Security: Holmes has updated all its APIs to support the HTTPS protocol. 

**Bug Fixes**

N/A

**Known Issues**

- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.

**Security Issues**

HOLMES 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 HOLMES open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_.

Quick Links:
    - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
 	
 	- `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
 	
 	- `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_


**Upgrade Notes**

- `HOLMES-99 <https://jira.onap.org/browse/HOLMES-99>`_ Updated the Drools engine to Version 6.5.0.
- `HOLMES-104 <https://jira.onap.org/browse/HOLMES-104>`_ Update all interfaces to enforce the HTTPS protocal.
- `HOLMES-112 <https://jira.onap.org/browse/HOLMES-112>`_ Following the guideline of the Logging Enhancements Project to implement log collection.
- `HOLMES-106 <https://jira.onap.org/browse/HOLMES-106>`_ Implemented horizontal scaling.
- `HOLMES-123 <https://jira.onap.org/browse/HOLMES-123>`_ Fixed some vulnerability issues identified by Nexus IQ.


**Deprecation Notes**

None of the HTTP APIs provided in the Amsterdam release are available in Beijing anymore.


**Other**

N/A

===========

Version: 1.0.0
--------------

:Release Date: 2017-11-16


**New Features**
In the Amsterdam release, Holmes is mainly intended to support the alarm
correlation analysis for the VoLTE scenario. To get us there, Holmes provides
the following features:

- `Rule Management <https://jira.onap.org/browse/HOLMES-4>`_ The feature provides interfaces for the users to create, query, update and delete rules. In this release, they are used along with the DCAE interfaces to accomplish the deployment (creation/update) of the control loop related rules.

- `Engine Management <https://jira.onap.org/browse/HOLMES-5>`_ The feature is not exposed to the end user directly. It's mainly used internally by Holmes as a container for the execution of rules. It provides interface for rule verification and deployment/un-deployment.

**Bug Fixes**

This is the initial release.

**Known Issues**

If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.

**Security Issues**

N/A

**Upgrade Notes**

N/A


End of Release Notes