Updated the release notes
[holmes/rule-management.git] / docs / release-notes.rst
index 33cecf8..9f5db0c 100644 (file)
@@ -11,10 +11,106 @@ 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: 10.0.0
+---------------
+
+:Release Date: 2022-06-02
+
+
+**New Features**
+
+- `Added support to 7.1 VES data-stream in parallel to 5.4. <https://jira.onap.org/browse/HOLMES-308>`_
+- `Removed CBS/consul dependency for application config management to finish DEAE tranformation to support Helm. <https://jira.onap.org/browse/HOLMES-488>`_
+
+**Bug Fixes**
+
+- `Engine instance recreating ALARM_INFO table on every restart of pod. <https://jira.onap.org/browse/HOLMES-491>`_
+- `Make EN lang as default for other than ZH locale in Holmes UI. <https://jira.onap.org/browse/HOLMES-499>`_
+- `Date parsing exceptions in logs after rule-management restart. <https://jira.onap.org/browse/HOLMES-492>`_
+
+**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.
+- `Unable to perform CRUD operations on rules when multiple engine instances running <https://jira.onap.org/browse/HOLMES-493>`_ (a potential problem, not reproduced)
+- `Inconsistency of alarm processing when multiple engine instances running <https://jira.onap.org/browse/HOLMES-494>`_ (a potential problem, not reproduced)
+
+**Security Issues**
+
+HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed.
+
+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: 9.0.0
+--------------
+
+:Release Date: 2021-11-04
+
+
+**New Features**
+
+N/A
+
+**Bug Fixes**
+
+- `Fixed Vulnerability issues by removing httpclient. <https://jira.onap.org/browse/HOLMES-441>`_
+- `Failed to update rules if the package name does not end with a semicolon. <https://jira.onap.org/browse/HOLMES-482>`_
+- `Database instantiation failed due to holmesdb password with single quote. <https://jira.onap.org/browse/HOLMES-463>`_
+- `Existing rules are not able to sync when engine get restarted/redeployed. <https://jira.onap.org/browse/HOLMES-462>`_
+- `RESTful APIs of the Engine Management Module are not Accessible. <https://jira.onap.org/browse/HOLMES-454>`_
+
+**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 NexusCloud and all critical vulnerabilities have been addressed.
+
+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: 8.0.1
 --------------
 
-:Release Date: 2021-04-01
+:Release Date: 2021-04-22
 
 
 **New Features**
@@ -35,9 +131,9 @@ N/A
 HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed.
 
 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>`_
+- `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**
@@ -80,9 +176,9 @@ Version: 7.0.1
 HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed.
 
 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>`_
+- `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**
@@ -123,9 +219,9 @@ N/A
 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>`_
+- `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**
@@ -169,9 +265,9 @@ Added some tools to support the extended CCVPN use case:
 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>`_
+- `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**
@@ -216,14 +312,13 @@ Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related
 
 **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>`_.
+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`_.
 
 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>`_
+- `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`_
 
 
 **Upgrade Notes**
@@ -253,13 +348,11 @@ Version: 1.1.0
 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**
@@ -276,11 +369,10 @@ N/A
 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>`_
+- `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**
@@ -315,7 +407,6 @@ 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**