From 90b740e99be5e6ddb3bccc6f2840c707acf74f92 Mon Sep 17 00:00:00 2001 From: GuangrongFu Date: Thu, 23 May 2019 18:27:23 +0800 Subject: Updated Docs Change-Id: I0c51e78ec3347206d1655ef7e34a09893476378b Issue-ID: HOLMES-228 Signed-off-by: GuangrongFu --- docs/platform/delivery.rst | 4 ++-- docs/platform/installation.rst | 7 ++++--- docs/platform/log-and-diagnostic-info.rst | 14 ++++++++++---- 3 files changed, 16 insertions(+), 9 deletions(-) (limited to 'docs/platform') 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 ^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit 1.2.3-korg