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 Version: 1.2.6
  14 --------------
  15
  16 :Release Date: 2019-06-13
  17
  18
  19 **New Features**
  20 Added some tools to support the extended CCVPN use case:
  21
  22 - `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.
  23 - `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.
  24
  25 **Bug Fixes**
  26
  27 - `HOLMES-204 <https://jira.onap.org/browse/HOLMES-204>`_ Alarms can not be deleted from the DB when they get cleared.
  28 - `HOLMES-223 <https://jira.onap.org/browse/HOLMES-223>`_ The "ABATED" messages can not be generated in the control loop.
  29
  30 **Known Issues**
  31
  32 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
  33 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
  34
  35 **Security Issues**
  36
  37 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.
  38
  39 Quick Links:
  40     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
  41
  42         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
  43
  44
  45 **Upgrade Notes**
  46
  47 N/A
  48
  49
  50 **Deprecation Notes**
  51
  52 N/A
  53
  54
  55 **Other**
  56
  57 N/A
  58
  59 ===========
  60
  61 Version: 1.2.0
  62 --------------
  63
  64 :Release Date: 2018-11-30
  65
  66
  67 **New Features**
  68 In the Casablanca release, Holmes provides its own GUI for rule management tasks:
  69
  70 - `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.
  71
  72 Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related assistant tools are added to the common library of Holmes.
  73
  74 **Bug Fixes**
  75
  76 - `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from the engine.
  77 - `HOLMES-133 <https://jira.onap.org/browse/HOLMES-133>`_ Don't rely on key word 'import' when extracting package name from rule.
  78 - `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.
  79
  80 **Known Issues**
  81
  82 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
  83 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
  84
  85 **Security Issues**
  86
  87 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>`_.
  88
  89 Quick Links:
  90     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
  91
  92         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
  93
  94         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_
  95
  96
  97 **Upgrade Notes**
  98
  99 N/A
 100
 101
 102 **Deprecation Notes**
 103
 104 N/A
 105
 106
 107 **Other**
 108
 109 N/A
 110
 111 ===========
 112
 113
 114 Version: 1.1.0
 115 --------------
 116
 117 :Release Date: 2018-06-07
 118
 119
 120 **New Features**
 121 In the Beijing release, Holmes provides no more functionalites than the Amsterdam release. Its main features remains like follows:
 122
 123 - `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.
 124
 125 - `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.
 126
 127 Besides, Holmes has been enhanced to meet the platform maturity requirements. The enhancement mainly covers:
 128
 129 - Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data.
 130
 131 - Security: Holmes has updated all its APIs to support the HTTPS protocol.
 132
 133 **Bug Fixes**
 134
 135 N/A
 136
 137 **Known Issues**
 138
 139 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
 140 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
 141
 142 **Security Issues**
 143
 144 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>`_.
 145
 146 Quick Links:
 147     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
 148
 149         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
 150
 151         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_
 152
 153
 154 **Upgrade Notes**
 155
 156 - `HOLMES-99 <https://jira.onap.org/browse/HOLMES-99>`_ Updated the Drools engine to Version 6.5.0.
 157 - `HOLMES-104 <https://jira.onap.org/browse/HOLMES-104>`_ Update all interfaces to enforce the HTTPS protocal.
 158 - `HOLMES-112 <https://jira.onap.org/browse/HOLMES-112>`_ Following the guideline of the Logging Enhancements Project to implement log collection.
 159 - `HOLMES-106 <https://jira.onap.org/browse/HOLMES-106>`_ Implemented horizontal scaling.
 160 - `HOLMES-123 <https://jira.onap.org/browse/HOLMES-123>`_ Fixed some vulnerability issues identified by Nexus IQ.
 161
 162
 163 **Deprecation Notes**
 164
 165 None of the HTTP APIs provided in the Amsterdam release are available in Beijing anymore.
 166
 167
 168 **Other**
 169
 170 N/A
 171
 172 ===========
 173
 174 Version: 1.0.0
 175 --------------
 176
 177 :Release Date: 2017-11-16
 178
 179
 180 **New Features**
 181 In the Amsterdam release, Holmes is mainly intended to support the alarm
 182 correlation analysis for the VoLTE scenario. To get us there, Holmes provides
 183 the following features:
 184
 185 - `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.
 186
 187 - `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.
 188
 189 **Bug Fixes**
 190
 191 This is the initial release.
 192
 193 **Known Issues**
 194
 195 If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
 196
 197 **Security Issues**
 198
 199 N/A
 200
 201 **Upgrade Notes**
 202
 203 N/A
 204
 205
 206 End of Release Notes