Update the Release Notes
[holmes/rule-management.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4
5 Holmes Rule Management Release Notes
6 ====================================
7
8 Holmes provides alarm correlation and analysis for telecom cloud infrastructure
9 and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root
10 reason which causes the failure or degradation of services by digging into the
11 ocean of events collected from different levels of the telecom cloud.
12
13
14 Version: 1.1.0
15 --------------
16
17 :Release Date: 2018-05-24
18
19
20 **New Features**
21 In the Amsterdam release, Holmes is mainly intended to support the alarm
22 correlation analysis for the VoLTE scenario. To get us there, Holmes provides
23 the following features:
24
25 - `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.
26
27 - `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.
28
29 **Bug Fixes**
30
31 N/A
32
33 **Known Issues**
34
35 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
36 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
37
38 **Security Issues**
39
40 Holmes is following the CII Best Practices Badge program. Most of its vulnerability issues have been fixed in Beijing Release except for the issues brought in by jackson-databind which is introduced indirectly by third-party dependencies (namely Dropwizard). The impact analysis can be found at `Holmes Security/Vulnerability Threat Impact Analysis <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_
41
42
43 **Upgrade Notes**
44
45 - `HOLMES-99 <https://jira.onap.org/browse/HOLMES-99>`_ Updated the Drools engine to Version 6.5.0.
46 - `HOLMES-104 <https://jira.onap.org/browse/HOLMES-104>`_ Update all interfaces to enforce the HTTPS protocal.
47 - `HOLMES-112 <https://jira.onap.org/browse/HOLMES-112>`_ Following the guideline of the Logging Enhancements Project to implement log collection.
48 - `HOLMES-106 <https://jira.onap.org/browse/HOLMES-106>`_ Implemented horizontal scaling.
49 - `HOLMES-123 <https://jira.onap.org/browse/HOLMES-123>`_ Fixed some vulnerability issues identified by Nexus IQ.
50
51
52 **Deprecation Notes**
53
54 N/A
55
56 **Other**
57
58 N/A
59
60 ===========
61
62 End of Release Notes