Holmes Architecture
-------------------
-Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Istanbul release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy.
+Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Jakarta release, Holmes is more generally a DCAE analytic application. It is deployed by DCAE and run as an analytic application on top of it. Also, it could be considered as a filter of the Policy component because it reduces the number of the input messages of Policy.
.. image:: images/overall-architecture-in-onap.png
Configuration
-------------
-No machanism for customized configurtions is provided in the Istanbul release. Such functionalities will be provided in the future if necessary.
+No machanism for customized configurtions is provided in the Jakarta release. Such functionalities will be provided in the future if necessary.
Consumed APIs
-------------
-In the Istanbul release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
+In the Jakarta release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
DCAE
^^^^
Target Users
^^^^^^^^^^^^
-The human interfaces provided in the Istanbul release by Holmes is intended for the developers rather than the end users.
+The human interfaces provided in the Jakarta release by Holmes is intended for the developers rather than the end users.
Interface Type
^^^^^^^^^^^^^^
Installation
------------
-In the Istanbul 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 Jakarta release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources.
-In case the users want to deploy Holmes independently, the steps for the installation is as follows.
+If a user wants to deploy Holmes using Helm, please refer to the OOM manual for help.
+
+In case a user want to deploy Holmes independently, the steps for the installation is as follows.
Prerequisites
^^^^^^^^^^^^^
#. Start the rule management module of Holmes using the command below:
- ``sudo docker run --name holmes-rule-management -p 9101:9101 -p 9104:9104 -p 9201:9201 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=$MSB_IAG_PORT -e TESTING=1 -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false nexus3.onap.org:10001/onap/holmes/rule-management:9.0.0``
+ ``sudo docker run --name holmes-rule-management -p 9101:9101 -p 9104:9104 -p 9201:9201 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=$MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hrmrules nexus3.onap.org:10001/onap/holmes/rule-management:10.0.2``
#. 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_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e TESTING=1 -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false nexus3.onap.org:10001/onap/holmes/engine-management:9.0.0``
+ ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hemtopics nexus3.onap.org:10001/onap/holmes/engine-management:10.0.2``
-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.
+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. ``LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES`` specifies the place where corresponding configuration files are stored. The configuration files should be organized as `files for the rule management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-rule-mgmt/resources/rules;h=e3071f02c0143bd5774967bd7148d73afeb8a17c;hb=HEAD>`_ and `files for the engine management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-engine-mgmt/resources/config;h=6a43bc35fa56731379956da08f766aa8d0abdd53;hb=HEAD>`_ (only *cfy.json* is needed in the standalone mode).
Check the Status of Holmes
^^^^^^^^^^^^^^^^^^^^^^^^^^
Logging & Diagnostic Information
---------------------------------
-In the Istanbul 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.
+In the Jakarta 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^
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: 10.0.0
+---------------
+
+:Release Date: 2022-05-12
+
+
+**New Features**
+
+- `Added support to 7.1 VES data-stream in parallel to 5.4. <https://jira.onap.org/browse/HOLMES-308>`_
+- `Removed CBS/consul dependency for application config management to finish DEAE tranformation to support Helm. <https://jira.onap.org/browse/HOLMES-488>`_
+
+**Bug Fixes**
+
+- `Engine instance recreating ALARM_INFO table on every restart of pod. <https://jira.onap.org/browse/HOLMES-491>`_
+- `Make EN lang as default for other than ZH locale in Holmes UI. <https://jira.onap.org/browse/HOLMES-499>`_
+- `Date parsing exceptions in logs after rule-management restart. <https://jira.onap.org/browse/HOLMES-492>`_
+
+**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 NexusCloud and all critical vulnerabilities have been addressed.
+
+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: 9.0.0
--------------
Code Review / holmes / rule-management.git / commitdiff