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