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