Getting started with HCL Compass Helm Chart

Learn how to install, configure, and launch the HCL Compass Helm chart in your own Kubernetes environment.

1. Download the HCL Compass Helm Chart.
   1. Login to Harbor.
   2. Select compass project from the Projects list.
   3. Click the Helm Chards tab to view the HCL Compass helm charts list.
   4. Select the hcl-compass helm chart and click on DOWNLOAD.
   5. You can also click on the hcl-compass helm chart name to see the list of the helm chart versions. If you click in the helm chart version, you will see the README file for the selected helm chart version.
2. Use Helm to install the HCL Compass solution Chart.
   1. Optionally, create a namespace for your solution.

      kubectl create namespace [name]

   2. Create a pull secret in the solution namespace.

      kubectl create secret docker-registry [secret-name] --docker-server=hclcr.io --docker-username=[sofy userid] --docker-password=[CLI secret] --namespace=[solution namespace]

      To set your Harbor CLI secret, login to hclcr.io with your HCL/SoFy credentials, selecting LOGIN VIA OIDC PROVIDER. In the top right corner, click the dropdown for your username, open your User Profile and enter a secret string of your choice. Use this string as the CLI secret in the command in step 2b.

   3. Install the solution chard using the helm install command:

            $ helm install [release-name] [file-name] \ 
                      --namespace [solution namespace] \               
                      --set global.hclImagePullSecret=[secret-name] \ 
                      --set hclFlexnetURL=[flexnet-url] \ 
                      --set hclFlexnetID=[flexnet-id]

      release-name

      A release name that you choose

      file-name

      The HCL Compass solution chart in .tgz file format.

      solution namespace

      The namespace that you created in step 2a.

      secret-name

      The secret name that you created in step 2b.

      flexnet-url

      Your HCL FlexNet license server URL.

      flexnet-id

      Your HCL FlexNet license ID.

   4. 1. Installing the HCL Compass Helm Chart that is installed with this solution chart creates the three following services:
         • hcl-compass service for RESTful applications with a two database connection set.
         • hcl-compass-search-app1 service for the Search application for the first database connection set.
         • hcl-compass-search-app2 service for the Search application for the second database connection set.
      Note: Note that the HCL Compass solution Helm Chart sets the persistent volume by default. If your Kubernetes environment does not provide default StoreageClass, then you must create your own default StorageClass or disable the persistent volume. If you do not, the HCL Compass pods cannot start. For more information, see HCL Compass Persistent Volumes.
3. Access the HCL Compass home page.
   1. Run kubectl get pods to make sure that all pods are in the running state and READY set to 1/1. It may take 5-7 minutes for all of the pods to reach the running state and READY set to 1/1.

      $ kubectl get pods –-namespace [namespace_name]

   2. Run kubectl get services to get EXTERNAL-IP address from the LoadBalancer service type.

      $ kubectl get services –-namespace [namespace_name]

   3. Start the HCL Compass home page in your browser by using https://hcl-compass-IP:loadBalancer_Port_Num.
   4. When you are finished with your solution, you can use the helm delete command to uninstall it.

      $ helm delete {release-name} --namespace [namespace_name]