summaryrefslogtreecommitdiffstats
path: root/docs/platform/administration.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/administration.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/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 0000000..977e024
--- /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...]``