diff options
| author |   Guangrong Fu <fu.guangrong@zte.com.cn> | 2023-04-13 10:30:37 +0800 |
|---|---|---|
| committer | Guangrong Fu <fu.guangrong@zte.com.cn> | 2023-04-13 10:30:37 +0800 |
| commit | b854b31af7b283b1a7b10948c8b430f40df35ad8 (patch) | |
| tree | 59089ffafc54fd7e1a687967685952dfebca7029 /docs/platform/installation.rst | |
| parent | be727900614e557a2260b917d2a1e9067bf05bfb (diff) | |
Updated documents
Issue-ID: HOLMES-617
Signed-off-by: Guangrong Fu <fu.guangrong@zte.com.cn>
Change-Id: I118303d7cc3c3c299ceb73a9fa4a6ae0be8dbb1c
Diffstat (limited to 'docs/platform/installation.rst')
| -rw-r--r-- | docs/platform/installation.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/platform/installation.rst b/docs/platform/installation.rst index 26547d1..8ee231e 100644 --- a/docs/platform/installation.rst +++ b/docs/platform/installation.rst @@ -4,7 +4,7 @@ Installation ------------ -In the Kohn release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. +In the London release, Holmes could either be deployed as an analytics application of DCAE along with the whole ONAP or be deployed in a standalone mode for the sake of saving resources. If a user wants to deploy Holmes using Helm, please refer to the OOM manual for help. @@ -27,10 +27,11 @@ Steps #. 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_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hemtopics nexus3.onap.org:10001/onap/holmes/engine-management:10.0.2`` + ``sudo docker run --name holmes-engine-management -p 9102:9102 -d -e URL_JDBC=$DB_IP -e MSB_IAG_SERVICE_HOST=$MSB_IAG_IP -e MSB_IAG_SERVICE_PORT=MSB_IAG_PORT -e HOST_IP=$HOST_IP -e ENABLE_ENCRYPT=false -e BASE_URL=$BASE_URL -e PRE_ADDR=$PRE_ADDR -e POST_ADDR=$POST_ADDR -e AAI_ADDR=$AAI_ADDR -v $LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES:/opt/hemtopics nexus3.onap.org:10001/onap/holmes/engine-management:10.0.2`` -All the interactions between Holmes and other ONAP components are routed by MSB. In order to register Holmes itself to MSB, the users have to specify the IP address of the host using the ``HOST_IP`` variable. Please note that the ``HOST_IP`` should be the IP address of the host, rather than the IP address of the containers (of which the IP address is allocated by the docker daemon). +All the interactions between Holmes and other ONAP components are routed by MSB or Ingress. In order to register Holmes itself to MSB, the users have to specify the IP address of the host using the ``HOST_IP`` variable. Please note that the ``HOST_IP`` should be the IP address of the host, rather than the IP address of the containers (of which the IP address is allocated by the docker daemon). ``ENABLE_ENCRYPT`` specifies whether HTTPS is enabled. When it is set to "false", only the HTTP schema is allowed. Otherwise, only HTTPS is allowed. ``LOCAL_PATH_THAT_STORES_THE_CONFIG_FILES`` specifies the place where corresponding configuration files are stored. The configuration files should be organized as `files for the rule management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-rule-mgmt/resources/rules;h=e3071f02c0143bd5774967bd7148d73afeb8a17c;hb=HEAD>`_ and `files for the engine management module <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/holmes/components/holmes-engine-mgmt/resources/config;h=6a43bc35fa56731379956da08f766aa8d0abdd53;hb=HEAD>`_ (only *cfy.json* is needed in the standalone mode). +All the addresses are organized in the form of (taking A&AI as an example) ``http(s)://$PRE_ADDR$AAI_ADDR$POST_ADDR.$BASE_URL`` within Holmes. Whether TLS is enabled depends on the value of the environment variable ``ENABLE_ENCRYPT`` Check the Status of Holmes ^^^^^^^^^^^^^^^^^^^^^^^^^^ |