summaryrefslogtreecommitdiffstats
path: root/docs/platform/administration.rst
diff options
context:
space:
mode:
authorshentao <shentao@chinamobile.com>2017-11-10 17:41:23 +0800
committershentao <shentao@chinamobile.com>2017-11-10 17:41:32 +0800
commit7db99a4c2fbd85a8cf45a89206e1bffe96226ee0 (patch)
tree5a3775d3411b393f3420cdb80925668583db46c1 /docs/platform/administration.rst
parent0f76ea2e69e3899ed4f948ea2d0db334c36621d1 (diff)
Update usecase-ui document
Change-Id: Ida0464f2f938d39cad2ed33357a19f7b9334e908 Issue-Id: USECASEUI-50 Signed-off-by: shentao <shentao@chinamobile.com>
Diffstat (limited to 'docs/platform/administration.rst')
-rw-r--r--docs/platform/administration.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/platform/administration.rst b/docs/platform/administration.rst
new file mode 100644
index 00000000..977e024e
--- /dev/null
+++ b/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...]``