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
   4
   5 Holmes Rule Management Release Notes
   6 ====================================
   7
   8 Holmes provides alarm correlation and analysis for telecom cloud infrastructure
   9 and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root
  10 reason which causes the failure or degradation of services by digging into the
  11 ocean of events collected from different levels of the telecom cloud.
  12
  13 Version: 1.2.6
  14 --------------
  15
  16 :Release Date: 2019-06-xx
  17
  18
  19 **New Features**
  20 Added some tools to support the extended CCVPN use case:
  21
  22 - `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.
  23
  24 **Bug Fixes**
  25
  26 - `HOLMES-204 <https://jira.onap.org/browse/HOLMES-204>`_ Alarms can not be deleted from the DB when they get cleared.
  27 - `HOLMES-223 <https://jira.onap.org/browse/HOLMES-223>`_ The "ABATED" messages can not be generated in the control loop.
  28
  29 **Known Issues**
  30
  31 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
  32 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
  33
  34 **Security Issues**
  35
  36 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.
  37
  38 Quick Links:
  39     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
  40
  41         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
  42
  43
  44 **Upgrade Notes**
  45
  46 N/A
  47
  48
  49 **Deprecation Notes**
  50
  51 N/A
  52
  53
  54 **Other**
  55
  56 N/A
  57
  58 ===========
  59
  60 Version: 1.2.0
  61 --------------
  62
  63 :Release Date: 2018-11-30
  64
  65
  66 **New Features**
  67 In the Casablanca release, Holmes provides its own GUI for rule management tasks:
  68
  69 - `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.
  70
  71 Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related assistant tools are added to the common library of Holmes.
  72
  73 **Bug Fixes**
  74
  75 - `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from the engine.
  76 - `HOLMES-133 <https://jira.onap.org/browse/HOLMES-133>`_ Don't rely on key word 'import' when extracting package name from rule.
  77 - `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.
  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 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>`_.
  87
  88 Quick Links:
  89     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
  90
  91         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
  92
  93         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_
  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
 112
 113 Version: 1.1.0
 114 --------------
 115
 116 :Release Date: 2018-06-07
 117
 118
 119 **New Features**
 120 In the Beijing release, Holmes provides no more functionalites than the Amsterdam release. Its main features remains like follows:
 121
 122 - `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.
 123
 124 - `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.
 125
 126 Besides, Holmes has been enhanced to meet the platform maturity requirements. The enhancement mainly covers:
 127
 128 - Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data.
 129
 130 - Security: Holmes has updated all its APIs to support the HTTPS protocol.
 131
 132 **Bug Fixes**
 133
 134 N/A
 135
 136 **Known Issues**
 137
 138 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
 139 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
 140
 141 **Security Issues**
 142
 143 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>`_.
 144
 145 Quick Links:
 146     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
 147
 148         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
 149
 150         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_
 151
 152
 153 **Upgrade Notes**
 154
 155 - `HOLMES-99 <https://jira.onap.org/browse/HOLMES-99>`_ Updated the Drools engine to Version 6.5.0.
 156 - `HOLMES-104 <https://jira.onap.org/browse/HOLMES-104>`_ Update all interfaces to enforce the HTTPS protocal.
 157 - `HOLMES-112 <https://jira.onap.org/browse/HOLMES-112>`_ Following the guideline of the Logging Enhancements Project to implement log collection.
 158 - `HOLMES-106 <https://jira.onap.org/browse/HOLMES-106>`_ Implemented horizontal scaling.
 159 - `HOLMES-123 <https://jira.onap.org/browse/HOLMES-123>`_ Fixed some vulnerability issues identified by Nexus IQ.
 160
 161
 162 **Deprecation Notes**
 163
 164 None of the HTTP APIs provided in the Amsterdam release are available in Beijing anymore.
 165
 166
 167 **Other**
 168
 169 N/A
 170
 171 ===========
 172
 173 Version: 1.0.0
 174 --------------
 175
 176 :Release Date: 2017-11-16
 177
 178
 179 **New Features**
 180 In the Amsterdam release, Holmes is mainly intended to support the alarm
 181 correlation analysis for the VoLTE scenario. To get us there, Holmes provides
 182 the following features:
 183
 184 - `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.
 185
 186 - `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.
 187
 188 **Bug Fixes**
 189
 190 This is the initial release.
 191
 192 **Known Issues**
 193
 194 If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
 195
 196 **Security Issues**
 197
 198 N/A
 199
 200 **Upgrade Notes**
 201
 202 N/A
 203
 204
 205 End of Release Notes