Skip to content

Configure Harbor Helm Repository

Beginning with HCL Digital Experience 9.5 Container Update CF205, the Docker images for deployment to Kubernetes environments can be optionally accessed via Helm charts in the HCL Harbor repository. Customers with credentials to access entitled software in the HCL Software Licensing Portal may apply those credentials to optionally access the Docker components of Digital Experience v9.5 Container Update CF205 or later releases.

Note

The Harbor repository structure does not support storage and access of binary zip files. Specifically, all Docker images except for the DX Client and Ring API sample zip files may be accessed via the HCL Harbor repository.

Harbor is an open-source Container Image and Helm Chart registry. It can be accessed through use of CLI tools, such as Docker and HELM using a CLI Secret. For more information about Harbor capabilities reference the Harbor documentation at https://goharbor.io.

Adding HCL Harbor Helm repository

To add the HCL Harbor Helm repository to your Helm installation, you can use the following command:

helm repo add \
--username <YOUR_HARBOR_USERNAME> \
--password <YOUR_HARBOR_CLI_SECRET_> \
hcl-dx https://hclcr.io/chartrepo/dx

To obtain the CLI secret, you must log in to HCL Harbor using your authorized user credentials, navigate to your User Profile in HCL Harbor, and then copy it from the field called CLI secret.

After adding the repository to Helm, you should see the following message:

"hcl-dx" has been added to your repositories

Listing available Helm Chart versions

To verify that your Helm configuration works and to see which application versions are available, you can use the following command:

# Using helm search to find available versions, the DX helm charts are named hcl-dx-deployment
helm search repo hcl-dx/hcl-dx-deployment --versions

This would return you a list of available versions, looking similar to this:

NAME                        CHART VERSION   APP VERSION DESCRIPTION                                    
hcl-dx/hcl-dx-deployment    2.7.1           95_CF204    Kubernetes Deployment of HCL Digital Experience

You see which chart version correlates to which HCL Digital Experience version. In the above example, installing CF204 would require you to use Helm Chart version 2.7.1.

Your Helm configuration is now capable of using HCL DX Helm Charts directly from the HCL Harbor Helm Repository.

Pulling Helm Chart for deployment

To use the HCL Digital Experience Helm Chart from the HCL Harbor Helm repository, we recommend you pull it via Helm to your local machine, by that you can work with it the same way, as you would have downloaded it manually.

To do so, run the following command with the correct Helm Chart version:

# Use Helm Pull with the version you want to deploy (example uses 2.7.1, please fill in your desired version)
helm pull hcl-dx/hcl-dx-deployment --version 2.7.1

After running this command, you can check if the Helm Chart has been downloaded to your local machine:

# List directory content to check successful pull
ls -lah 

# total 8868
# -rw-r--r--. 1 user user  136052 Jul  7 11:28 hcl-dx-deployment-2.7.1.tgz

You have now downloaded your Helm Chart and can continue with your deployment.

Related information

Last update: September 12, 2022