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