summaryrefslogtreecommitdiffstats
path: root/docs/platform/architecture.rst
diff options
context:
space:
mode:
authorCédric Ollivier <cedric.ollivier@orange.com>2021-10-21 17:58:01 +0200
committerCédric Ollivier <cedric.ollivier@orange.com>2021-10-27 02:34:14 +0200
commit3c0ce0f85b34392dd50608e7440f10a20b0279cd (patch)
tree92521c605d2880a2a0dfabad5cdcaa7c48e89c4b /docs/platform/architecture.rst
parent6a35d99de3143d80f1fec13e310bb6fc156fe8cc (diff)
Leverage upper-constraints files to pin all dependencies
It leverages the latest change from lfdocs-conf and the upper-constraints.txt now centralized in ONAP docs. In a long run, upperconstraints.os.txt should be removed once ONAP is synced with OpenStack. It removes tox and setuptools from requirements as nothing depends on them (most requirements should be removed except lfdocsconf) Issue-ID: DOC-765 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I893490b8dfe244e49912d599b8b40745e546862c
Diffstat (limited to 'docs/platform/architecture.rst')
-rw-r--r--docs/platform/architecture.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/platform/architecture.rst b/docs/platform/architecture.rst
new file mode 100644
index 0000000..0a5ed6c
--- /dev/null
+++ b/docs/platform/architecture.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. _architecture:
+
+
+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.
+
+.. image:: images/overall-architecture-in-onap.png
+
+
+Taking a deep dive into Holmes, could observe that it mainly consists of three modules, which are: the rule management module, the engine management module and the data source adapter module respectively.
+
+The rule management module provides interfaces for the operations (e.g. creating, updating and deleting) on the rules.
+
+The data source adapter consists of subscribers and publishers, which are used to convert the data format into the one that could be digested by Holmes and vice versa.
+
+The engine management module is the core of Holmes. All the rules are deployed here. When alarms gets into Holmes, they will be pushed into the Drools engine and analyzed by the enabled rules one after another. When processing the alarms, a couple of attributes, such as the alarm name, the occurrence time of the alarm and so on, are utilized. Also, the topological information from A&AI is used in combination of the alarm attributes. After the root cause is identified, it will be converted into a control loop event and published to a specific DMaaP topic which is subscribed to by the Policy component.
+
+.. image:: images/holmes-architecture.png