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