Containerization requirements and limitations
This section describes the requirements for deploying HCL Digital Experience Compose 9.5 images to container platforms. You can also find current limitations.
Requirements for container image versions
In a single deployment, all container images must come from the same CF release version. Mixing container images from multiple releases in a single deployment is an unsupported configuration.
Exceptions are permissible only when HCL requests customers to use a specially provided container image or to try an image version from a different release to diagnose or temporarily resolve a specific issue.
Requirements and limitations for Helm-based deployments
This section describes the requirements and limitations for HCL Digital Experience Compose 9.5 Container deployments that use Helm.
HCL DX Compose 9.5 is designed to run on any certified Kubernetes platform (https://www.cncf.io/certification/software-conformance), provided that the conditions apply:
- the Kubernetes platform is hosted on x86_64 hardware.
- the Kubernetes platform is officially supported by Helm (https://helm.sh/docs/topics/kubernetes_distros/).
Although the platforms might be Certified Kubernetes platforms, you might find the environments vary slightly depending on the vendors. HCL Support will make a reasonable effort to assist the customer in problem resolution in scenarios where the Kubernetes version is still under support by the vendor. If there are any unresolved issues, HCL Support will provide alternative implementation recommendations or open Feature Requests for the problem scenario.
Internally, HCL tests DX Compose against a range of Kubernetes platforms that is regularly reviewed and updated. HCL does not test with every single platform vendor, but aims to cover a representative sample of popular Kubernetes implementations.
To deploy HCL Digital Experience Compose 9.5 to the supported Kubernetes platforms that use Helm, the following elements are required:
-
Helm installation:
Download and install Helm to your target environment. The HCL DX Compose 9.5 container deployment is tested and is supported with Helm v3. For more information regarding the supported Helm version for individual Kubernetes versions, refer to Helm documentation.
-
Container platform capacity resource requirements:
The following table outlines the minimum possible amount of resource requests by the HCL DX Compose 9.5 container components in Helm-based deployments and the minimum number of pods required for each component.
To use the minimal configuration, adjust the resource requests in your custom-values.yaml file accordingly. You can use alternatives to these numbers. Increasing any number is not an issue. In fact, for best results in a production environment, increase these numbers to scale to your specific needs. You can also decrease some of these numbers and still be able to start DX Compose (for example, for deployment environments), but this action is not officially supported.
All the following CPU sizings relate to an environment with 2nd generation Intel Xeon scalable processors (Cascade Lake 8223CL) or 1st generation Intel Xeon Platinum 8000 series (Skylake 8124M) processors.
Note
Every Kubernetes node requires some memory for Kubernetes-specific services. Ensure that your Kubernetes Node has enough capacity to host both the Kubernetes services and HCL DX Compose. The overall requested amount of resources might vary based on disabled and enabled applications.
| Pod name | Minimum number of Pods | Container | Container Image | Container CPU request and limit | Container Memory request and limit |
|---|---|---|---|---|---|
| web-engine | 1 | web-engine | web-engine | 4000m | 6144Mi |
| content-composer | 1 | content-composer | content-composer | 100m | 128Mi |
| dam-plugin-google-vision | 1 | dam-plugin-google-vision | dam-plugin-google-vision | 100m | 384Mi |
| dam-plugin-kaltura | 1 | dam-plugin-kaltura | dam-plugin-kaltura | 100m | 128Mi |
| digital-asset-management | 1 | digital-asset-management | digital-asset-manager | 500m | 1512Mi |
| prereqs-checker | prereqs-checker | 100m | 64Mi | ||
| haproxy | 1 | haproxy | haproxy | 200m | 300Mi |
| image-processor | 1 | image-processor | image-processor | 200m | 2048Mi |
| license-manager | 1 | license-manager | license-manager | 100m | 300Mi |
| open-ldap | 1 | ldap | openldap | 200m | 768Mi |
| persistence-connection-pool | 1 | persistence-connection-pool | persistence-connection-pool | 500m | 512Mi |
| persistence-node | 1 | persistence-node | persistence-node | 500m | 1024Mi |
| persistence-metrics-exporter | persistence-metrics-exporter | 100m | 128Mi | ||
| persistence-repmgr-log | logging-sidecar | 100m | 64Mi | ||
| system-out-log | logging-sidecar | 100m | 64Mi | ||
| system-err-log | logging-sidecar | 100m | 64Mi | ||
| prereqs-checker | prereqs-checker | 100m | 64Mi | ||
| ring-api | 1 | ring-api | ringapi | 100m | 256Mi |
| runtime-controller | 1 | runtime-controller | runtime-controller | 100m | 256Mi |
| open-search-data/manager | 1 | open-search | dx-opensearch | 1000m | 1536Mi |
| search-middleware-query/data | 1 | search-middleware | dx-search-middlware | 500m | 512Mi |
| file-processor | 1 | file-processor | dx-file-processor | 1000m | 2048Mi |
| Overall | 9800m | 18304Mi |
Note
The overall sums for CPU and memory include all components of HCL DX Compose. In most cases, you only want to deploy a subset of all components. Therefore, the minimal system requirements decrease accordingly.