diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/installation.rst | 6 | ||||
| -rw-r--r-- | docs/release-notes.rst | 30 |
2 files changed, 11 insertions, 25 deletions
diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index f380835..1d07e0e 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -21,13 +21,13 @@ Steps #. Start the rule management module of Holmes using the command below: - ``sudo docker run --name holmes-rule-management -p 9101:9101 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 nexus3.onap.org:10001/onap/holmes/rule-management`` + ``sudo docker run --name holmes-rule-management -p 9101:9101 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 -e HOST_IP=$HOST_IP nexus3.onap.org:10001/onap/holmes/rule-management`` #. Start the engine manamgement module of Holmes using the command below: - ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 nexus3.onap.org:10001/onap/holmes/engine-management`` + ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 -e HOST_IP=$HOST_IP nexus3.onap.org:10001/onap/holmes/engine-management`` -When the environment variable ``TESTING`` is set to ``1``, it means Holmes is running in the standalone mode. All the interactions between Holmes and other ONAP components are routed by MSB. +When the environment variable ``TESTING`` is set to ``1``, it means Holmes is running in the standalone mode. All the interactions between Holmes and other ONAP components are routed by MSB. In order to register Holmes itself to MSB, the users have to specify the IP address of the host using the ``HOST_IP`` variable. Please note that the ``HOST_IP`` should be the IP address of the host, rather than the IP address of the containers (of which the IP address is allocated by the docker daemon). Check the Status of Holmes ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 20116e4..32f4515 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -5,44 +5,30 @@ 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, +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. +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 <https://jira.onap.org/browse/CIMAN-65>`_ and a sentence explaining what this defect is addressing. + **Known Issues** - - `CIMAN-65 <https://jira.onap.org/browse/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 <https://cve.mitre.org>`_ - **Upgrade Notes** |