Install and deploy Opensearch, Opensearch Dashboards and Logstash to support HCL Compass dashboards for business analytics

Business analytics and dashboard support is offered as part of a technical preview. Support will be provided on a best effort basis.

Before you begin

Note: Using HCL Compass on Docker and Docker Compose is not supported when deployed in a production environment. To use HCL Compass in a container in a production environment, deploy HCL Compass to a Kubernetes environment.

For more information, see Deploying HCL Compass on SoFy Sandbox.

To install and deploy analytic tools for HCL Compass, note the following:

You must be familiar with and follow the instructions in Getting started with Docker.
The following Opensearch has been used for the Opensearch Dashboards and Opensearch docker images: https://opensearch.org/docs/latest/opensearch/install/docker/

About this task

Procedure

Deploy the Opensearch container.

docker run -d --name hcl-compass-opensearch -h hcl-compass-opensearch \
  --mount source=opensearch-data,destination=/usr/share/opensearch/data \  
  --env "discovery.type=single-node" \
  -p 9200:9200 -p 9600:9600  hclcr.io/ccm/opensearch:2.0.0

Deploy the Logstash container.

Mount the updated logstash.conf file to /usr/share/logstash/pipeline/ folder

docker run -d --name hcl-compass-logstash --link hcl-compass -opensearch -h hcl-compass -logstash \
  -v /home/ccm/config/logstash:/usr/share/logstash/pipeline/  \
  -p 5011:5011 hclcr.io/ccm/ccm-logstash:2.2.0

Deploy the Opensearch Dashboards container.

docker run -d --name hcl-compass-dashboaprds --link hcl-compass-dashboards --link hcl-compass-opensearch -h hcl-compass-dashboards \
  --env OPENSEARCH_URL=https://hcl-compass-opensearch:9200 \
  --env OPENSEARCH_HOSTS=https://hcl-compass-opensearch:9200 \
  --env OPENSEARCH_USERNAME=admin \
  --env OPENSEARCH PASSWORD=admin \
  -p 5601:5601  hclcr.io/ccm/opensearch-dashboards:2.0.0

Deploy the Nginx container.

docker run -d --name hcl-compass-nginx --link hcl-compass-logstash --link hcl-compass-dashboards --link hcl-compass-opensearch -h hcl-compass-nginx \
  --env NGINX_SERVER_NAME=hcl-compass-nginx \
  --env DASHBOARDS_HOSTS=http://hcl-compass-dashboards:5601 \
  -p 5602:5602 -p 5603:5603 -p 80:80 -p 8091:9081 \
  hclcr.io/ccm/2.2.0

Add the following settings to the docker hcl-compass run command as described in Getting started with Docker :

--link hcl-compass-opensearch \
--link hcl-compass-logstash \
--link hcl-compass-dashboards \
--link hcl-compass-nginx \
--env OPENSEARCH_HOSTS=https://hcl-compass-opensearch:9200 \
--env NGINX_HOSTS=https://hcl-compass-nginx:5602 \