.. toctree::
:maxdepth: 1
-
+
platform/index.rst
release-notes.rst
Holmes Architecture
-------------------
-Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Guilin 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 Honolulu 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 Guilin release. Such functionalities will be provided in the future if necessary.
+No machanism for customized configurtions is provided in the Honolulu release. Such functionalities will be provided in the future if necessary.
Consumed APIs
-------------
-In the Guilin release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
+In the Honolulu release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
DCAE
^^^^
#. Query a VM by ID:
- ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}``
+ ``/aai/v11/search/nodes-query?search-node-type=vserver&filter=vserver-id:EQUALS:{vserver-id}``
More details could be found at `A&AI APIs <https://wiki.onap.org/pages/viewpage.action?pageId=13598793>`_.
-
+
DMaaP
^^^^^
Target Users
^^^^^^^^^^^^
-The human interfaces provided in the Guilin release by Holmes is intended for the developers rather than the end users.
+The human interfaces provided in the Honolulu release by Holmes is intended for the developers rather than the end users.
Interface Type
^^^^^^^^^^^^^^
.. toctree::
:maxdepth: 1
-
+
architecture.rst
offeredapis.rst
consumedapis.rst
Installation
------------
-In the Guilin 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 Honolulu 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.
#. MSB must be installed and started. The user knows the IP address of the MSB API gateway service.
#. PostgreSQL must be installed and started. For the guidance on how to run a PostgreSQL, please refer to `Offical Repository of PostgreSQL <https://hub.docker.com/_/postgres/>`_.
-
+
**While setting up PostgreSQL, a database and a user named 'holmes' must be created. The corresponding password shuold be set to 'holmespwd'. Otherwise, Holmes could not be started up successfully.**
Steps
#. Start the rule management module of Holmes using the command below:
- ``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``
+ ``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:
After the installation, you have to check whether Holmes is alive or not using the health-check API.
-#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-rule-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the rule management module of Holmes has been spun up and registered to MSB successfully.
+#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-rule-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the rule management module of Holmes has been spun up and registered to MSB successfully.
#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-engine-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the engine management module of Holmes has been spun up and registered to MSB successfully.
Logging & Diagnostic Information
---------------------------------
-In the Guilin 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 Honolulu 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
^^^^^^^^^^^^^^^^^^^^^^^^^^^
``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
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: 8.0.1
+--------------
+
+:Release Date: 2021-04-01
+
+
+**New Features**
+
+- `HOLMES-380 <https://jira.onap.org/browse/HOLMES-380>`_ Migrate Holmes deployment to Helm
+
+**Bug Fixes**
+
+N/A
+
+**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: 7.0.1
--------------
**Security Issues**
-HOLMES code has been formally scanned during build time using NexusCloud and all critical vulnerabilities have been addressed.
+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>`_
**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.
+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>`_
**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.
+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>`_
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>`_
-
+
- `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=45298796>`_
- Scaling: Holmes supports horizontal scale-in/scale-out operations in case it is overloaded by too large amounts of data.
-- Security: Holmes has updated all its APIs to support the HTTPS protocol.
+- Security: Holmes has updated all its APIs to support the HTTPS protocol.
**Bug Fixes**
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>`_
-
+
- `Project Vulnerability Review Table for HOLMES <https://wiki.onap.org/pages/viewpage.action?pageId=28378012>`_
Code Review / holmes / rule-management.git / commitdiff