X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=8ec147978a932fde9afc7774df70513d5dd7d6ae;hb=aa45bd087308d7881be0758a0ae4bc652e274ce6;hp=20116e4aad66dc7fd4cbb4af5830f8bb2ebbc4c7;hpb=85ebf13c86536bfbc7873ed32468c1667efd0f86;p=holmes%2Frule-management.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 20116e4..8ec1479 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,44 +5,32 @@ Holmes Rule Management Release Notes ==================================== -.. note:: - * This Release Notes must be updated each time the team decides to Release new artifacts. - * The scope of this Release Notes is for this particular component. In other words, each ONAP component has its Release Notes. - * This Release Notes is cumulative, the most recently Released artifact is made visible in the top of this Release Notes. - * Except the date and the version number, all the other sections are optional but there must be at least one section describing the purpose of this new release. - * This note must be removed after content has been added. +Holmes provides alarm correlation and analysis for telecom cloud infrastructure +and services, including hosts, vims, VNFs and NSs. Holmes aims to find the root +reason which causes the failure or degradation of services by digging into the +ocean of events collected from different levels of the telecom cloud. -Holmes provides alarm correlation and analysis for Telecom cloud infrastructure and services, -including hosts, vims, VNFs and NSs. Holmes aims to find the root reason which causes the failure -or degradation of services by digging into the ocean of events collected from different levels of -the Telecom cloud. - -Version: x.y.z +Version: 1.0.0 -------------- -:Release Date: yyyy-mm-dd +:Release Date: 2017-11-16 **New Features** - -One or two sentences explaining the purpose of this Release. +In the Amsterdam release, Holmes is mainly intended to support the alarm +correlation analysis for the VoLTE scenario. To get us there, Holmes provides +the following features: +- `Rule Management `_ 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. +- `Engine Management `_ 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. **Bug Fixes** - - `CIMAN-65 `_ and a sentence explaining what this defect is addressing. + **Known Issues** - - `CIMAN-65 `_ and two, three sentences. - One sentences explaining what is the issue. - - Another sentence explaining the impact of the issue. - - And an optional sentence providing a workaround. **Security Issues** - You may want to include a reference to CVE (Common Vulnerabilities and Exposures) `CVE `_ - **Upgrade Notes**