Skip to content

Overview

This section outlines mandatory and optional tasks that need to be done before installation of the HCL Digital Experience 9.5 Container Update CF196 using Helm.

This includes preparing your cluster to have proper access to application container images, creating a custom configuration file that fits your deployment needs and configuring network and application settings to allow your HCL Digital Experience 9.5 CF196 and later deployment to work properly.

Read this first

  • Helm architecture for an understanding of the capabilities, deployment structures, configuration and scaling options available for HCL DX 9.5 CF196 and later deployments.
  • Containerization requirements and limitations for an understanding of the requirements, including capacity planning, and current limitations for an HCL Digital Experience 9.5 and later deployment using Helm.

Mandatory tasks

The following tasks are mandatory for HCL Digital Experience 9.5 Container deployment to operate in your Kubernetes cluster using Helm.

Prepare a namespace

Before you can deploy HCL Digital Experience, it is recommended that you create a namespace inside your Kubernetes Cluster.

Prepare the Helm deployment configuration file

Create a configuration file that fits the needs of your target HCL DX 9.5 Container deployment. The configuration file is the heart of your deployment using Helm. It defines how HCL Digital Experience 9.5 is deployed to supported platforms, and how it behaves during runtime operations. This section explains how to create your own configuration file and how to leverage the existing values.yaml inside the Helm Chart. It also explains how to optionally overwrite settings in case the default set may not be sufficient.

Load container images

This section presents how to load the DX 9.5 Container Update CF196 or later images into your container image repository, tag them to fit your repository structure, and push them to your repository, so that all Nodes in your Kubernetes or OpenShift cluster can deploy HCL Digital Experience 9.5 Pods.

Configure persistent volume claims

HCL Digital Experience requires Persistent Volumes to be present in order to have all applications running. This topic explains to you how you can configure the deployment to use the Persistent Volumes in your cluster.

Configure networking

Depending on your deployment, your requirements for networking may differ from the default. This topic shows you what needs to be configured to get HCL Digital Experience up and running inside your Kubernetes cluster and be accessible.

Configure internal network

Add the platform-specific annotations for the ambassador service to deploy DX on the internal network (network with no public access).

Configure HAProxy certificate

The HAProxy requires an SSL certificate to use (if ssl is enabled), this topic shows how to configure that for the HCL Digital Experience Kubernetes deployment.

Optional

These tasks may be relevant for you if you have specific requirements for the deployment.

Configure Harbor Helm Repository

If you want to directly use the HCL Harbor Helm repository instead of a downloaded variant, you will need to add and authenticate the HCL Harbor Helm repository in your Helm installation.

Using ImagePullSecrets

In your deployment it might be necessary to access a container image registry that requires credentials to pull images from. This topic explains to you how you configure the DX deployment to work under such conditions. This is also required when you want to pull container images directly from the HCL Harbor container registry, without using your private container registry.

Using NodeSelectors

You may want to have certain applications of the HCL Digital Experience Kubernetes deployment to be running on certain Nodes inside your cluster. This topic will explain how to achieve that for each application.

Choose deployed applications

This topic shows you how to disable and enable specific applications from HCL Digital Experience in your Kubernetes deployment.

Configure applications

There are application specific configurations that you may want to adjust, e.g. if Core should behave as a rendering or authoring environment. This topic explains to you how that can be configured.

Configure scaling

This topic explains how you can configure Pod count and automated scaling for applications that support it.

Configure credentials

This topic shows you how to adjust credentials that are used for the deployment.

Configure Core sidecar logging

This topic describes how to expose logs that are written to files by the DX Core application.

Configure Remote Search sidecar logging

This topic describes how you can expose logs that are written to files on its PersistentVolumes (PVs) by the DX Remote Search application.

Configure Labels and Annotations

This topic documents the configuration of labels and annotations for different DX resources.

Try experimental features

This topic describes the incubator section in the Helm Charts.


Last update: September 12, 2022