Skip to content

Commit 4a2fb19

Browse files
authored
Merge pull request #9 from HCL-TECH-SOFTWARE/sync/cf228
Sync/cf228
2 parents 1bb42ab + 46ad13b commit 4a2fb19

File tree

92 files changed

+1481
-251
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+1481
-251
lines changed

docs/deploy_dx/install/kubernetes_deployment/containers_requirements_limits.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Exceptions are permissible only when HCL requests customers to use a specially p
1616

1717
This section describes the requirements and limitations for HCL Digital Experience Compose 9.5 Container deployments that use Helm.
1818

19-
HCL DX Compose 9.5 is designed to run on any certified Kubernetes platform \([https://www.cncf.io/certification/software-conformance](https://www.cncf.io/certification/software-conformance)\), provided that the conditions apply:
19+
HCL DX Compose 9.5 is designed to run on any certified Kubernetes platform \([https://www.cncf.io/certification/software-conformance](https://www.cncf.io/certification/software-conformance){target="_blank"}\), provided that the conditions apply:
2020

2121
- The Kubernetes platform is hosted on x86\_64 hardware.
22-
- The Kubernetes platform is officially supported by Helm ([https://helm.sh/docs/topics/kubernetes\_distros/](https://helm.sh/docs/topics/kubernetes_distros/)).
22+
- The Kubernetes platform is officially supported by Helm ([https://helm.sh/docs/topics/kubernetes\_distros/](https://helm.sh/docs/topics/kubernetes_distros/){target="_blank"}).
2323

2424
<!--
2525
For the list of Kubernetes versions that are tested and supported by HCL, refer to the [HCL DX supported hardware and software statements](https://support.hcltechsw.com/csm?id=kb_article&sysparm_article=KB0013514&sys_kb_id=ba230c701b983c50f37655352a4bcb29) page.
@@ -34,7 +34,7 @@ To deploy HCL Digital Experience Compose 9.5 to the supported Kubernetes platfor
3434

3535
- **Helm installation**:
3636

37-
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](https://helm.sh/).
37+
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](https://helm.sh/){target="_blank"}.
3838

3939
- **Container platform capacity resource requirements**:
4040

@@ -45,7 +45,9 @@ To deploy HCL Digital Experience Compose 9.5 to the supported Kubernetes platfor
4545
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.
4646

4747
!!!note
48-
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.
48+
- 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.
49+
- 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.
50+
- This configuration outlines the minimum requirements. For production environments or higher workloads, scale to small config. If you encounter performance issues, increase resource allocations as needed. For guidance on optimizing your deployment, see the [Performance Tuning Guide](../../../guide_me/performance_tuning/kubernetes/index.md).
4951

5052
| **Pod name** | **Minimum number of Pods** | **Container** | **Container Image** | **Container CPU request and limit** | **Container Memory request and limit** |
5153
|---|---|---|---|---|---|
@@ -74,10 +76,6 @@ To deploy HCL Digital Experience Compose 9.5 to the supported Kubernetes platfor
7476
| | | | | | |
7577
| **Overall** | | | | **9800m** | **18304Mi** |
7678

77-
!!!note
78-
The overall sums for CPU and memory include all components of HCL DX Compose.
79-
In most cases, you only want to deploy a subset of all components. Therefore, the minimal system requirements decrease accordingly.
80-
8179
<!--
8280
!!!important
8381
For the recommended disk storage per PersistentVolume, refer to the `values.yaml` file. The relevant values can be found in the `volumes` section of the `values.yaml file` in the `requests.storage` parameter of each Volume. Note that the required size increases with every core upgrade from one cumulative fix to another. For best results, clean up your previous profiles after you confirm that the new profile is working. See related [Core Profile Check](../../../deployment/install/container/helm_deployment/preparation/optional_tasks/optional-core-prereqs-checker.md#core-profile-check) and [Storage Space Check](../../../deployment/install/container/helm_deployment/preparation/optional_tasks/optional-core-prereqs-checker.md#storage-space-check).

docs/deploy_dx/install/kubernetes_deployment/download_sw.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
New and existing users need to [register](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0069114){target="blank"} at the HCL Software License Portal and download their entitled HCL Digital Experience packages.
44

5-
The following software files are packaged and licensed for use with HCL Digital Experience Compose v9.5 and are available in your entitlements on the [HCL Software License Portal](https://hclsoftware.flexnetoperations.com/flexnet/operationsportal/logon.do){target="blank"}.
5+
The following software files are packaged and licensed for use with HCL Digital Experience Compose v9.5 and are available in your entitlements on the [My HCLSoftware (MHS) portal](https://my.hcltechsw.com/){target="blank"}.
66

77
- HCL Digital Experience Compose v9.5
88
- HCL DX Client

docs/deploy_dx/install/kubernetes_deployment/image_list.md

Lines changed: 46 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,60 @@
22

33
This section presents the latest available HCL Digital Experience (DX) 9.5 Compose Container images.
44

5-
The following software files are packaged and licensed for use with HCL Digital Experience Compose v9.5 and are available in your entitlements on the [HCL Software License Portal](https://hclsoftware.flexnetoperations.com/flexnet/operationsportal/logon.do){target="blank"}.
5+
The following software files are packaged and licensed for use with HCL DX Compose v9.5 and are available in your entitlements on the My HCLSoftware (MHS) portal.
66

7-
- HCL Digital Experience Compose v9.5
7+
- HCL DX Compose v9.5
88
- HCL DXClient
99
- HCL Leap 9.3.x for use with DX Compose
1010
- HCL Volt Foundry 9.5.x for use with DX Compose
1111

12-
In future continuous delivery updates, entitled customers can obtain the HCL DX 9.5 Compose container updates from the DX_Compose_CF_Updates download package entry in the [HCL Software License Portal](https://hclsoftware.flexnetoperations.com/flexnet/operationsportal/logon.do){target="blank"}.
12+
In future continuous delivery updates, entitled customers can obtain the HCL DX 9.5 Compose container updates from the download package entries in the [MHS portal](https://my.hcltechsw.com/downloads){target="blank"}.
13+
14+
Video: [How to upload HCL DX 9.5 container images to a private repository](https://youtu.be/XJONRdpgCuo)
15+
16+
## HCL DX 9.5 Compose CF228
17+
18+
If you are deploying the HCL DX 9.5 Compose CF228 release, the following software packages are available in your MHS portal HCL DX Compose v9.5 entitlements:
19+
20+
- HCL DX Compose v9.5
21+
- HCL DXClient
22+
- HCL Leap 9.3.x for use with DX Compose
23+
- HCL Volt Foundry 9.5.x for use with DX Compose
1324

14-
Video: [How to upload HCL Digital Experience 9.5 container images to a private repository](https://youtu.be/XJONRdpgCuo)
25+
## hcl-compose-kubernetes-CF228.zip
1526

27+
```shell
28+
HCL DX Compose notices CF228.txt
29+
hcl-dx-content-composer-image-v1.41.0_20250606-1743.tar.gz
30+
hcl-dx-dam-plugin-google-vision-image-v1.0.0_20250606-1816.tar.gz
31+
hcl-dx-dam-plugin-kaltura-image-v1.0.0_20250606-1759.tar.gz
32+
hcl-dx-deployment-v2.37.2_20250609-1834.tgz
33+
hcl-dx-digital-asset-manager-image-v1.40.0_20250606-1738.tar.gz
34+
hcl-dx-file-processor-image-v2.0.0_20250606-1726.tar.gz
35+
hcl-dx-haproxy-image-v1.24.0_20250606-1802.tar.gz
36+
hcl-dx-image-processor-image-v1.41.0_20250606-1800.tar.gz
37+
hcl-dx-license-manager-image-v95_CF228_20250606-1811.tar.gz
38+
hcl-dx-logging-sidecar-image-v1.0.0_20250606-1745.tar.gz
39+
hcl-dx-openldap-image-v2.6.8_20250606-1745.tar.gz
40+
hcl-dx-opensearch-image-v2.0.0_20250606-1802.tar.gz
41+
hcl-dx-people-service-image-v1.0.0_20250606-1815.tar.gz
42+
hcl-dx-persistence-connection-pool-image-v1.38.0_20250606-1815.tar.gz
43+
hcl-dx-persistence-metrics-exporter-image-v1.36.0_20250606-1800.tar.gz
44+
hcl-dx-persistence-node-image-v1.28_20250606-1802.tar.gz
45+
hcl-dx-prereqs-checker-image-v1.0.0_20250606-1725.tar.gz
46+
hcl-dx-ringapi-image-v1.41.0_20250606-1820.tar.gz
47+
hcl-dx-runtime-controller-image-v95_CF228_20250606-1819.tar.gz
48+
hcl-dx-search-middleware-image-v2.0.0_20250606-1758.tar.gz
49+
hcl-dx-search-v2.26.0_20250609-1834.tgz
50+
hcl-dx-webengine-image-CF228_20250607-0531.tar.gz
51+
```
52+
53+
<!--
1654
## HCL DX 9.5 Compose CF227
1755
18-
If you are deploying the HCL DX 9.5 Compose CF227 release, the following software packages are available in your [HCL Software License Portal (Flexnet)](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0073344){target="blank"} HCL Digital Experience Compose v9.5 entitlements:
56+
If you are deploying the HCL DX 9.5 Compose CF227 release, the following software packages are available in your MHS portal HCL DX Compose v9.5 entitlements:
1957
20-
- HCL Digital Experience Compose v9.5
58+
- HCL DX Compose v9.5
2159
- HCL DXClient
2260
- HCL Leap 9.3.x for use with DX Compose
2361
- HCL Volt Foundry 9.5.x for use with DX Compose
@@ -50,7 +88,6 @@ hcl-dx-search-v2.25.0_20250428-1459.tgz
5088
hcl-dx-webengine-image-CF227_20250425-2144.tar.gz
5189
```
5290
53-
<!--
5491
## HCL DX 9.5 Compose CF226
5592
5693
If you are deploying the HCL DX 9.5 Compose CF226 release, the following software packages are available in your [HCL Software License Portal (Flexnet)](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0073344){target="blank"} HCL Digital Experience Compose v9.5 entitlements:
@@ -165,10 +202,9 @@ hcl-dx-webengine-image-CF224_20241213-2134.tar.gz
165202
```
166203
-->
167204

168-
[Locate the HCL Digital Experience Compose v9.5 software](locating_downloads.md) and download the files from the [HCL Software License Portal (Flexnet)](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0073344){target="blank"}.
205+
[Locate the HCL DX Compose v9.5 software](locating_downloads.md) and download the files from the MHS portal.
169206

170207
See the [System requirements](../../../getting_started/system_requirements.md) section for more information about the supported Container and Operating Systems.
171208

172209
???+ info "Related information"
173-
- [Download the HCL Digital Experience Compose software](../kubernetes_deployment/download_sw.md)
174-
210+
- [Download the HCL DX Compose software](../kubernetes_deployment/download_sw.md)

docs/deploy_dx/install/kubernetes_deployment/kubernetes_runtime.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ Review your chosen Kubernetes platform and ensure that it supports the following
3737

3838
|CF Level|Kubernetes versions|
3939
|--------------|-----------------|
40+
|CF228| Kubernetes 1.33<br/>Kubernetes 1.32<br/>Kubernetes 1.31<br/>Kubernetes 1.30<br/>Kubernetes 1.29<br/>Kubernetes 1.28<br/>Kubernetes 1.27<br/>Kubernetes 1.26<br/>|
41+
|CF227| Kubernetes 1.32<br/>Kubernetes 1.31<br/>Kubernetes 1.30<br/>Kubernetes 1.29<br/>Kubernetes 1.28<br/>Kubernetes 1.27<br/>Kubernetes 1.26<br/>|
4042
|CF226| Kubernetes 1.32<br/>Kubernetes 1.31<br/>Kubernetes 1.30<br/>Kubernetes 1.29<br/>Kubernetes 1.28<br/>Kubernetes 1.27<br/>Kubernetes 1.26<br/>|
41-
|CF225| Kubernetes 1.32<br/>Kubernetes 1.31<br/>Kubernetes 1.30<br/>Kubernetes 1.29<br/>Kubernetes 1.28<br/>Kubernetes 1.27<br/>Kubernetes 1.26<br/>|
42-
|CF224| Kubernetes 1.31<br/>Kubernetes 1.30<br/>Kubernetes 1.29<br/>Kubernetes 1.28<br/>Kubernetes 1.27<br/>Kubernetes 1.26<br/>|
4343

4444
!!!important
4545
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.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Configure Harbor Helm Repository
2+
3+
The HCL Digital Experience (DX) Compose 9.5 container images and Helm charts can be accessed from the [HCL Harbor container repository](https://hclcr.io/){target="_blank"}. Customers with credentials to access entitled software on the HCL Software Licensing Portal can apply those credentials to access these HCL DX Compose 9.5 components.
4+
5+
The Harbor repository is updated with a registry based on Open Container Initiative (OCI) standards. The Helm chart command is updated to be OCI-compliant.
6+
7+
For more information on how to pull Helm charts using OCI commands and list available Helm chart versions, refer to [Downloading and deploying HCL products from a Harbor Repository](../../../../../getting_started/download/harbor_container_registry.md).

docs/deploy_dx/install/kubernetes_deployment/preparation/get_the_code/configure_harbor_helm_repo.md.225

Lines changed: 0 additions & 104 deletions
This file was deleted.

docs/deploy_dx/install/kubernetes_deployment/preparation/get_the_code/prepare_load_images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It is assumed that you have a repository configured and running, and is technica
1313

1414
## Retrieving container images
1515

16-
[Download the HCL Digital Experience Compose 9.5 package](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0073344){target="blank"}, unpack it locally and load the images into your container registry. You can load the images to your own container registry for others in your organization to access.
16+
[Download the HCL Digital Experience Compose 9.5 package](https://support.hcl-software.com/csm?id=kb_article&sysparm_article=KB0120373){target="blank"} from your entitlements on the My HCLSoftware (MHS) portal, unpack it locally and load the images into your container registry. You can load the images to your own container registry for others in your organization to access.
1717
<!--
1818
You can either directly pull the HCL DX Compose images from the HCL Harbor container image registry, or download the HCL Digital Experience Compose 9.5 package, unpack it locally and load the images into your container registry. In both cases, you can load the images to your own container registry for others in your organization to access.
1919
-->

docs/deploy_dx/install/kubernetes_deployment/preparation/optional_tasks/optional_configure_apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ configuration:
6161
6262
Refer to the following Help Center documentation for more information about LDAP configuration:
6363
64-
- [Enable federated security](../../../../manage/working_with_compose/cfg_parameters/manage_users_groups_liberty.md#configuring-federated-user-registry.md)
64+
- [Enable federated security](../../../../manage/working_with_compose/cfg_parameters/manage_users_groups_liberty.md#configuring-federated-user-registry)
6565
- [Troubleshooting](../../../../manage/working_with_compose/troubleshooting/index.md)
6666
6767

docs/deploy_dx/install/kubernetes_deployment/preparation/optional_tasks/optional_container_resources.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
The default Helm values included in the HCL Digital Experience 9.5 Helm Chart offer minimal supported configuration for CPU and Memory resources. You can adjust the values in the `custom-values.yaml` for a deployment according to the [Kubernetes Resource Management](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/){target="blank"}.
44

5+
!!!note
6+
This configuration outlines the minimum requirements. For production environments or higher workloads, scale to small config. If you encounter performance issues, increase resource allocations as needed. For guidance on optimizing your deployment, see the [Performance Tuning Guide](../../../../../guide_me/performance_tuning/kubernetes/index.md).
7+
58
```yaml
69
# Resource allocation settings, definition per pod
710
# Use number + unit, e.g. 1500m for CPU or 1500M for Memory

0 commit comments

Comments
 (0)