summaryrefslogtreecommitdiffstats
path: root/docs/docs/platform/administration.rst
diff options
context:
space:
mode:
authorGuangrong Fu <fu.guangrong@zte.com.cn>2021-10-14 09:14:31 +0800
committerGuangrong Fu <fu.guangrong@zte.com.cn>2021-10-14 09:27:07 +0800
commit6a35d99de3143d80f1fec13e310bb6fc156fe8cc (patch)
treed8f49e42e2ec4ef67b1fe1da95596e9b29d2e820 /docs/docs/platform/administration.rst
parent6e6587bdad31fb2575be2680419cc86125339a9d (diff)
Updated docs
Issue-ID: HOLMES-480 Signed-off-by: Guangrong Fu <fu.guangrong@zte.com.cn> Change-Id: I6893e4cd12dfd70e1c32079912cdfefad32b7da7
Diffstat (limited to 'docs/docs/platform/administration.rst')
-rw-r--r--docs/docs/platform/administration.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/docs/platform/administration.rst b/docs/docs/platform/administration.rst
new file mode 100644
index 0000000..977e024
--- /dev/null
+++ b/docs/docs/platform/administration.rst
@@ -0,0 +1,33 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+
+Administration
+--------------
+
+It is not hard to manage Holmes becasue it's been dockerized and split into two dockers. One is for rule management and the other for engine management.
+
+Processes / Dockers
+^^^^^^^^^^^^^^^^^^^
+
+For both of the dockers of Holmes, there's only one process running during the run time. But the rule management docker sort of relies on the enginemanagement docker. Once the engine management module is stopped, the whole Holmes will malfunction because the Drools engine which is managed by the engine management module is the core component of Holmes.
+
+Holmes mainly consists of two dockers:
+
+* Rule Management Docker
+
+* Engine Management Docker
+
+Actions
+^^^^^^^
+
+All actions performed on the Holmes modules are docker-based.
+
+* Create a Container: ``sudo docker run [OPTIONS] IMAGE [COMMAND] [ARG...]``
+
+* Kill a Container: ``sudo docker kill [OPTIONS] CONTAINER [CONTAINER...]``
+
+* Stop a Container: ``sudo docker stop [OPTIONS] CONTAINER [CONTAINER...]``
+
+* Start a Container: ``sudo docker start [OPTIONS] CONTAINER [CONTAINER...]``
+
+* Restart a Container: ``sudo docker restart [OPTIONS] CONTAINER [CONTAINER...]``