Merge "Update usecase-ui document"

1 files changed, 42 insertions, 0 deletions

diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst
new file mode 100644
index 00000000..f380835f
--- /dev/null
+++ b/docs/platform/installation.rst
@@ -0,0 +1,42 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+
+
+Installation
+------------
+
+In the Amsterdam release, Holmes is deployed as an analytic application by the DCAE controller. So the users do not have to install it on their own.
+
+In case the users want to deploy Holmes independently, the steps for the installation is as follows.
+
+Prerequisites
+^^^^^^^^^^^^^
+
+#. MSB must be installed and started. The user knows the IP address of the MSB API gateway service.
+#. PostgreSQL must be installed and started. For the guidance on how to run a PostgreSQL, please refer to `Offical Repository of PostgreSQL <https://hub.docker.com/_/postgres/>`_.
+   
+   **While setting up PostgreSQL, a database and a user named 'holmes' must be created. The corresponding password shuold be set to 'holmespwd'. Otherwise, Holmes could not be started up successfully.**
+
+Steps
+^^^^^
+
+#. Start the rule management module of Holmes using the command below:
+
+   ``sudo docker run --name holmes-rule-management -p 9101:9101 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 nexus3.onap.org:10001/onap/holmes/rule-management`` 
+
+#. Start the engine manamgement module of Holmes using the command below:
+
+   ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_ADDR=$MSB_IP -e TESTING=1 nexus3.onap.org:10001/onap/holmes/engine-management``
+
+When the environment variable ``TESTING`` is set to ``1``, it means Holmes is running in the standalone mode. All the interactions between Holmes and other ONAP components are routed by MSB.
+
+Check the Status of Holmes
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+After the installation, you have to check whether Holmes is alive or not using the health-check API.
+
+#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-rule-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the rule management module of Holmes has been spun up and registered to MSB successfully. 
+
+#. Use ``curl http://${msb-ip}:${msb-port}/api/holmes-engine-mgmt/v1/healthcheck`` or any other tools (e.g. Postman) to check whether the engine management module of Holmes has been spun up and registered to MSB successfully.
+
+If the response code is ``200`` and the response body is ``true``, it's telling the user that everything is fine. Otherwise, you have to take a look at the logs to check whether there are any errors and contact the Holmes team for help.
+