diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/platform/delivery.rst | 4 | ||||
| -rw-r--r-- | docs/platform/installation.rst | 7 | ||||
| -rw-r--r-- | docs/platform/log-and-diagnostic-info.rst | 14 | ||||
| -rw-r--r-- | docs/release-notes.rst | 49 |
4 files changed, 64 insertions, 10 deletions
diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst index f65b36e..40186b6 100644 --- a/docs/platform/delivery.rst +++ b/docs/platform/delivery.rst @@ -5,11 +5,11 @@ Delivery -------- Describe how functions are packaged into run-time components. For some components a block diagram may be useful. -As mentioned in the architecture chapter, Holmes mainly comprises three modules: the rule management module, the engine management module and the data source adapter. But due to the imperfect implemetation of the DCAE platform, the engine management module and the data source adapter are hosted in a single docker. From this point of view, Holmes in the Beijing release actually consists of two main modules. +As mentioned in the architecture chapter, Holmes mainly comprises two modules: a rule management module and an engine management module. * Rule Management Docker: The main operations on the rules are performed in this module. The module provides CRUD operation interfaces and is reponsible of the persistence of the rules as well. -* Engine Management Docker: The Drools rules are actually deployed into the Drools engine which is embedded within the engine management module. The analysis tasks are excuted in this module as well. Ideally, the data source adapter is supposed to be running as a standalone docker and communicate with the engine management module via MQ (or any other message bus). But in the Beijing release, due to the limitation of the DCAE platform. These two modules are merged into one and interact with each other directy in the manner of Java API calls. +* Engine Management Docker: The Drools rules are actually deployed into the Drools engine which is embedded within the engine management module. The analysis tasks are excuted in this module as well. Alarm messages are converted to Holmes-compatible format and put into the Drools engine for analysis. * Common Library: The library hosts some supportive tools for both the rule management module and the engine management module. It is not run separately. Instead, it is introduced into the main modules of Holmes during the compile and package phase. diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 1d07e0e..e033cfe 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -4,7 +4,7 @@ Installation ------------ -In the Amsterdam release, Holmes is deployed as an analytic application by the DCAE controller. So the users do not have to install it on their own. +In the Dublin release, Holmes is deployed as an analytic application by the DCAE controller. So the users do not have to install it on their own. In case the users want to deploy Holmes independently, the steps for the installation is as follows. @@ -21,13 +21,14 @@ 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 -e HOST_IP=$HOST_IP nexus3.onap.org:10001/onap/holmes/rule-management`` + ``sudo docker run --name holmes-rule-management -p 9101:9101 -p 9201:9201 -p 9104:9104 -p 9105:9105 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false 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 -e HOST_IP=$HOST_IP 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 -e ENABLE_ENCRYPT=false 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. 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). +``ENABLE_ENCRYPT`` specifies whether HTTPS is enabled. When it is set to "false", only the HTTP schema is allowed. Otherwise, only HTTPS is allowed. Check the Status of Holmes ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/platform/log-and-diagnostic-info.rst b/docs/platform/log-and-diagnostic-info.rst index 74c53db..fb4ef47 100644 --- a/docs/platform/log-and-diagnostic-info.rst +++ b/docs/platform/log-and-diagnostic-info.rst @@ -4,15 +4,21 @@ Logging & Diagnostic Information --------------------------------- -In the Beijing release, the logs are kept inside the docekr containers, which means that you can get the log information only when the docker is still running. +In the Dublin release, the logs are kept inside the docker containers, which means that you can get the log information only when the docker is still running. Where to Access Information ^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Assume that the name of a running docker is *holmes-rule-mgmt*, the way to get the log is to run the command ``docker logs ${docker-name}`` in the command window: -``sudo docker logs holmes-rule-mgmt`` +There are two ways for a user to get the logs. -Then the logs will be displayed in the command window. + +* Assume that the name of a running docker is *holmes-rule-mgmt*, the way to get the log is to run the command ``docker logs ${docker-name}`` in the command window: + + ``sudo docker logs holmes-rule-mgmt`` + + Then the logs will be displayed in the command window. + +* Get into the docker containers by running ``sudo docker exec -it ${docker-name} sh``. Go to the path ``/var/log/ONAP/holmes/`` and find the logs there. Error / Warning Messages ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index d929310..e13f1c0 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -10,6 +10,53 @@ 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: 1.2.6 +-------------- + +:Release Date: 2019-06-xx + + +**New Features** +Added some tools to support the extended CCVPN use case: + +- `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. + +**Bug Fixes** + +- `HOLMES-204 <https://jira.onap.org/browse/HOLMES-204>`_ Alarms can not be deleted from the DB when they get cleared. +- `HOLMES-223 <https://jira.onap.org/browse/HOLMES-223>`_ The "ABATED" messages can not be generated in the control loop. + +**Known Issues** + +- If the database is not stable, there may be data/status inconsistency between the rule management module and the engine management module. +- The current horizontal scaling mechanism can not efficiently balance the load. Optimization is needed in the future. + +**Security Issues** + +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. + +Quick Links: + - `HOLMES project page <https://wiki.onap.org/display/DW/Holmes+Project>`_ + + - `Passing Badge information for HOLMES <https://bestpractices.coreinfrastructure.org/en/projects/1602>`_ + + +**Upgrade Notes** + +N/A + + +**Deprecation Notes** + +N/A + + +**Other** + +N/A + +=========== + Version: 1.2.0 -------------- @@ -25,7 +72,7 @@ Besides, Holmes has been enhanced to be CCVPN use case supportive. CCVPN related **Bug Fixes** -- `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from then engine. +- `HOLMES-156 <https://jira.onap.org/browse/HOLMES-156>`_ Rules can not be deployed after they've been added/removed from the engine. - `HOLMES-133 <https://jira.onap.org/browse/HOLMES-133>`_ Don't rely on key word 'import' when extracting package name from rule. - `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. |