summaryrefslogtreecommitdiffstats
path: root/docs/platform/administration.rst
diff options
context:
space:
mode:
authorGuangrongFu <fu.guangrong@zte.com.cn>2017-10-11 03:22:32 +0800
committerGuangrongFu <fu.guangrong@zte.com.cn>2017-10-11 03:22:32 +0800
commit38cbeea75d6b6bce68be9282a1c731ab07db6e2e (patch)
tree23dfe3368620eda5ac1290622f89ba197d3894e9 /docs/platform/administration.rst
parent0c42e8f328b75f156201a55b8fb89f4f62d36626 (diff)
Add the Administration Doc
Change-Id: I79e36db4e4db5600b094d6e7f7924f580415d306 Issue-ID: HOLMES-66 Signed-off-by: GuangrongFu <fu.guangrong@zte.com.cn>
Diffstat (limited to 'docs/platform/administration.rst')
-rw-r--r--docs/platform/administration.rst30
1 files changed, 24 insertions, 6 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst
index 5213df7..977e024 100644
--- a/docs/platform/administration.rst
+++ b/docs/platform/administration.rst
@@ -4,12 +4,30 @@
Administration
--------------
-Processes
-^^^^^^^^^
-* Process 1
-* Process 2
+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
^^^^^^^
-* Action X
-* Action Y
+
+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...]``