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