summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGuangrongFu <fu.guangrong@zte.com.cn>2017-10-11 03:50:58 +0800
committerGuangrongFu <fu.guangrong@zte.com.cn>2017-10-11 03:50:58 +0800
commitfaa4f3b335ffc638ef7b34fb8453d3088eb633c4 (patch)
tree4c8f92bd33d5553cee7ed8cf936f0224f020845b
parent38cbeea75d6b6bce68be9282a1c731ab07db6e2e (diff)
Add the Delivery Doc
Change-Id: I9d3143fded737f387bb7e41f551a60bc929144d7 Issue-ID: HOLMES-66 Signed-off-by: GuangrongFu <fu.guangrong@zte.com.cn>
-rw-r--r--docs/platform/delivery.rst9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/platform/delivery.rst b/docs/platform/delivery.rst
index 27b3770..5b2a0b1 100644
--- a/docs/platform/delivery.rst
+++ b/docs/platform/delivery.rst
@@ -5,5 +5,12 @@ 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 Amsterdam release actually consists of two main modules.
-**TO BE DONE** \ No newline at end of file
+* 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 Amsterdam 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.
+
+* 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.
+
+.. image:: images/holmes-delivery.png