host=gerrit.onap.org
port=29418
project=holmes/rule-management.git
+defaultbranch=master
from docs_conf.conf import *
+release = "master"
+version = "master"
+
branch = 'latest'
master_doc = 'index'
Holmes Architecture
-------------------
-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.
+Basically, Holmes itself is an independent component in ONAP, which means it could be deployed as an ONAP-level component. In the Kohn 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 Jakarta release. Such functionalities will be provided in the future if necessary.
+No machanism for customized configurtions is provided in the Kohn release. Such functionalities will be provided in the future if necessary.
Consumed APIs
-------------
-In the Jakarta release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
+In the Kohn release, Holmes mainly depends on the APIs provided by DCAE, A&AI, DMaaP and MSB.
DCAE
^^^^
Target Users
^^^^^^^^^^^^
-The human interfaces provided in the Jakarta release by Holmes is intended for the developers rather than the end users.
+The human interfaces provided in the Kohn release by Holmes is intended for the developers rather than the end users.
Interface Type
^^^^^^^^^^^^^^
Installation
------------
-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 the Kohn 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.
If a user wants to deploy Holmes using Helm, please refer to the OOM manual for help.
Logging & Diagnostic Information
---------------------------------
-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.
+In the Kohn 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: 11.0.0
+---------------
+
+:Release Date: 2022-11-10
+
+
+**New Features**
+
+- `Migrate from Dropwizard to Springboot <https://jira.onap.org/browse/HOLMES-511>`_
+
+**Bug Fixes**
+
+- `Nginx stops working. Holmes UI is not available. <https://jira.onap.org/browse/HOLMES-565>`_
+- `Manually deployed rules are removed with no reason from Holmes. <https://jira.onap.org/browse/HOLMES-564>`_
+- `Holmes does not log the request ID and the transaction ID in the log file. <https://jira.onap.org/browse/HOLMES-563>`_
+
+**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.
+- `Unable to perform CRUD operations on rules when multiple engine instances running <https://jira.onap.org/browse/HOLMES-493>`_ (a potential problem, not reproduced)
+- `Inconsistency of alarm processing when multiple engine instances running <https://jira.onap.org/browse/HOLMES-494>`_ (a potential problem, not reproduced)
+
+**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: 10.0.0
---------------