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