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