Getting started with the HCL Compass Analytics features in the same Docker Compose services

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 Getting started with HCL Compass Helm Chart.

About this task

This quick start guide demonstrates how to use Docker Compose to setup and run an HCL Compass Analytics feature with HCL Compass RESTful.

Procedure

Compete steps 1-3 in Getting started with Docker Compose.
Create environment files.
- Create an environment file named ccm.env in your project directory and paste in the hcl-compass URL.
```
CCM_URL=https://<hcl-compass_IP_Address>:8190
```
- Create an environment file named analytics.env in your project directory and paste in the hcl-compass-analytics URL.
```
ANALYTICS_URL=https://<compass_analytics_IP_Address>:8290
```

Define the service in a Docker compose file.

Create a YAML file named docker-compose-analytics.yaml in your project directory as shown below. Replace the image repositories and tag with you selected image repositories and tags:

 version: '3.3'

services:
  hcl-compass:
    env_file:
      - analytics.env        # environment variables file for the FlexNet licensesetting the CCM Analytics URL.
  hcl-compass-analytics:
    links:
      - hcl-compass
    restart: on-failure
    depends_on:
      - "hcl-compass"

    image: compass-docker-dev-local.us-artifactory1.nonprod.hclpnp.com/ccm/hcl-compass-analytics:latest
    hostname: hcl-compass-analytics
    container_name: hcl-compass-analytics

    env_file:
      - license.env
      - ccm.env
    
    ports:
      - 8290:8290

    networks:
      - hcl-compass

    volumes:
      - hcl-compass-analytics-logs:/opt/hcl/compass/compass-analytics-rest-server-distribution/logs
      - hcl-compass-analytics-config:/opt/hcl/compass/compass-analytics-rest-server-distribution/config
      - hcl-compass-analytics-data:/opt/hcl/compass/compass-analytics-rest-server-distribution/data

    networks:
      - hcl-compass

volumes:
 hcl-compass-analytics-logs:
  hcl-compass-analytics-data:
  hcl-compass-analytics-config:

Build and run the HCL Compass application with Docker Compose

From your project directory, start your application by running docker-compose up

$ docker-compose -f docker-compose.yaml -f docker-compose-analytics.yaml up  -d

Creating network "compass_hcl-compass-analytics" with driver "bridge"
Creating volume "compass_hcl-compass-analytics-logs" with default driver
Creating volume "compass_hcl-compass-config-analytics" with default driver
Creating compass_hcl-compass-analytics ... done

After the command has been launched, you can check to see that the service and the container are started by using the following command:
```
$ docker-compose -f docker-compose.yaml -f docker-compose-analytics.yaml ps
```

Optionally, you can view the container logs by using the following command:

$ docker-compose -f docker-compose.yaml -f docker-compose-analytics.yaml logs

Enter http://localhost:8190/ in a browser to see the HCL Compass application running with search and dashboard functionality.