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