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.0
  14 --------------
  15
  16 :Release Date: 2018-11-xx
  17
  18
  19 **New Features**
  20 In the Casablanca release, Holmes provides its own GUI for rule management tasks:
  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 Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related assistant tools are added to the common library of Holmes.
  25
  26 **Bug Fixes**
  27
  28 - `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from then engine.
  29 - `HOLMES-133 <https://jira.onap.org/browse/HOLMES-133>`_ Don't rely on key word 'import' when extracting package name from rule.
  30 - `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.
  31
  32 **Known Issues**
  33
  34 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
  35 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
  36
  37 **Security Issues**
  38
  39 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>`_.
  40
  41 Quick Links:
  42     - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
  43
  44         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
  45
  46         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=41422564>`_
  47
  48
  49 **Upgrade Notes**
  50
  51 N/A
  52
  53
  54 **Deprecation Notes**
  55
  56 N/A
  57
  58
  59 **Other**
  60
  61 N/A
  62
  63 ===========
  64
  65
  66 Version: 1.1.0
  67 --------------
  68
  69 :Release Date: 2018-06-07
  70
  71
  72 **New Features**
  73 In the Beijing release, Holmes provides no more functionalites than the Amsterdam release. Its main features remains like follows:
  74
  75 - `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.
  76
  77 - `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.
  78
  79 Besides, Holmes has been enhanced to meet the platform maturity requirements. The enhancement mainly covers:
  80
  81 - Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data.
  82
  83 - Security: Holmes has updated all its APIs to support the HTTPS protocol.
  84
  85 **Bug Fixes**
  86
  87 N/A
  88
  89 **Known Issues**
  90
  91 - If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
  92 - The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future.
  93
  94 **Security Issues**
  95
  96 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>`_.
  97
  98 Quick Links:
  99      - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_
 100
 101         - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_
 102
 103         - `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_
 104
 105
 106 **Upgrade Notes**
 107
 108 - `HOLMES-99 <https://jira.onap.org/browse/HOLMES-99>`_ Updated the Drools engine to Version 6.5.0.
 109 - `HOLMES-104 <https://jira.onap.org/browse/HOLMES-104>`_ Update all interfaces to enforce the HTTPS protocal.
 110 - `HOLMES-112 <https://jira.onap.org/browse/HOLMES-112>`_ Following the guideline of the Logging Enhancements Project to implement log collection.
 111 - `HOLMES-106 <https://jira.onap.org/browse/HOLMES-106>`_ Implemented horizontal scaling.
 112 - `HOLMES-123 <https://jira.onap.org/browse/HOLMES-123>`_ Fixed some vulnerability issues identified by Nexus IQ.
 113
 114
 115 **Deprecation Notes**
 116
 117 None of the HTTP APIs provided in the Amsterdam release are available in Beijing anymore.
 118
 119
 120 **Other**
 121
 122 N/A
 123
 124 ===========
 125
 126 Version: 1.0.0
 127 --------------
 128
 129 :Release Date: 2017-11-16
 130
 131
 132 **New Features**
 133 In the Amsterdam release, Holmes is mainly intended to support the alarm
 134 correlation analysis for the VoLTE scenario. To get us there, Holmes provides
 135 the following features:
 136
 137 - `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.
 138
 139 - `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.
 140
 141 **Bug Fixes**
 142
 143 This is the initial release.
 144
 145 **Known Issues**
 146
 147 If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module.
 148
 149 **Security Issues**
 150
 151 N/A
 152
 153 **Upgrade Notes**
 154
 155 This is the inital release.
 156 ===========
 157
 158
 159 End of Release Notes