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