Holmes Rule Management Release Notes
====================================
-.. note::
- * This Release Notes must be updated each time the team decides to Release new artifacts.
- * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes.
- * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes.
- * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release.
- * This note must be removed after content has been added.
+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.
-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: x.y.z
+Version: 1.1.0
--------------
-
-:Release Date: yyyy-mm-dd
-
+:Release Date: 2018-05-24
**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:
-One or two sentences explaining the purpose of this Release.
+- `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**
- - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing.
+
+N/A
+
**Known Issues**
- - `CIMAN-65 <https://jira.onap.org/browse/CIMAN-65>`_ and two, three sentences.
- One sentences explaining what is the issue.
-
- Another sentence explaining the impact of the issue.
-
- And an optional sentence providing a workaround.
+
+- 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**
- You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE <https://cve.mitre.org>`_
+
+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>`_
**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**
+N/A
+
**Other**
+N/A
+
===========
End of Release Notes
Code Review / holmes / rule-management.git / blobdiff