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