diff options
| author |   shentao <shentao@chinamobile.com> | 2017-11-12 09:36:51 +0800 |
|---|---|---|
| committer | shentao <shentao@chinamobile.com> | 2017-11-12 09:36:59 +0800 |
| commit | 9208eb1e0f4b44e7e9ddaf05642c3cfadd61e95b (patch) | |
| tree | d7565e98850eaa0ed5367d0840213a8650f34ac0 /docs/platform/installation.rst | |
| parent | 7db99a4c2fbd85a8cf45a89206e1bffe96226ee0 (diff) | |
Update usecase-ui docs
Change-Id: I55065209062d721cfdaea8310854f2cfd4e7e446
Issue-Id: USECASEUI-57
Signed-off-by: shentao <shentao@chinamobile.com>
Diffstat (limited to 'docs/platform/installation.rst')
| -rw-r--r-- | docs/platform/installation.rst | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index f380835f..79266801 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -3,40 +3,3 @@ 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. - |