Skip to content

Deploying using Helm

Before deployment, see the following resources first.

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

HCL DX Compose is designed to run on any Certified Kubernetes platform with some conditions. See the system requirements for Kubernetes platforms for more information.

This section provides administrators with instructions to deploy HCL Digital Experience Compose to supported Kubernetes platforms. This includes preparation, installation, and uninstallation of the deployments using Helm.

Before you begin: Refer to the latest HCL DX Compose Update image files list provided in the Container image list topic.

Important

To prevent a possible Kubernetes deployment failure in Kubernetes versions 1.28 and 1.29, it may be required to run the command modprobe br_netfilter before running kubeadm init. This is a potential solution to avoid a networking bridge/iptables issue.

flowchart TD
  accTitle: Steps in DX Compose Helm installation.
  accDescr: Flowchart showing the mandatory and optional steps in DX Compose Helm installation.

  A([Start])
  B1[Configure Helm Repository];
  B2[Load the Images];
  C[/Mandatory or Optional Tasks/];
  D[Prepare Namespace];
  E[Setup Custom Configuration];
  G[Configure Networking];
  H[Configure Certificate];
  I[Optional tasks];
  J[Install DX Compose]

  A --> B1;
  B1 --> B2;
  B2 --> C;
  C --> |Mandatory| D;
  D --> E;
  E --> G;
  G --> H;
  H --> J;
  C ----> |Optional| I;
  I --> J;

  click B2 "../preparation/get_the_code/prepare_load_images/"
  click D "../preparation/mandatory_tasks/prepare_namespace/"
  click E "../preparation/mandatory_tasks/prepare_configuration/"
  click G "../preparation/mandatory_tasks/prepare_configure_networking/"
  click H "../preparation/mandatory_tasks/prepare_ingress_certificate/"
  click I "../preparation/optional_tasks/optional_internal_networking/"
  click J "../install/"

HCLSoftware U learning materials

For an introduction and a demo on DX deployment, go to Deployment for Beginners. Several deployment options are provided in the course.

To learn how to do a traditional installation, go to Deployment for Intermediate Users. In this course, you will also learn about additional installation tasks that apply to both container-based and traditional deployments using the Configuration Wizard, DXClient, ConfigEngine, and more. You can try it out using the Deployment Lab and corresponding Deployment Lab Resources.

To learn how to manage multiple DX sites, go to Multi-Site Management. In this course, you will learn when and how to create and manage base, true, and virtual portals in which you may run one or more DX sites. You can also try it out using the Multi-Site Management Lab.

For an introduction and a demo on DX staging, go to Staging for Beginners.

To learn how to use staging tools such as DXClient, Syndication, XMLAccess, ReleaseBuilder/Solution Installer, and ConfigEngine, go to Staging for Intermediate Users. You can try it out using the Staging Lab for Intermediate Users and corresponding Staging Lab Resources.