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