Skip to content

Commit 80b0c8c

Browse files
authored
Merge pull request #7 from HCL-TECH-SOFTWARE/sync/cf226
Sync/cf226
2 parents 68ec1d1 + 967ea62 commit 80b0c8c

File tree

25 files changed

+378
-35
lines changed

25 files changed

+378
-35
lines changed

docs/deploy_dx/install/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
nav:
22
- index.md
33
- Kubernetes Deployment: kubernetes_deployment
4+
- Docker Compose: docker_compose.md
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
# Docker Compose for HCL DX Compose
3+
4+
Developers with entitlements to HCL Digital Experience (DX) Compose 9.5 can additionally deploy for non-production purposes using [Docker Compose](https://docs.docker.com/compose/){target="_blank"}. This approach streamlines deployment and configuration of HCL DX Compose 9.5 components. For more information about Docker Compose, see the [Docker Compose documentation](https://docs.docker.com/compose/){target="_blank"}.
5+
6+
## Deploying using Docker Compose
7+
8+
To deploy HCL DX Compose 9.5 using Docker Compose, refer to the following steps:
9+
10+
1. Download the Docker images for the HCL DX Compose 9.5 version you want to deploy. See [Download software](../../getting_started/download/index.md) for more information.
11+
12+
2. Find the HCL DX Compose 9.5 Docker Compose scripts, along with installation and configuration instructions for non-production use, which are published as-is in Github.com in the [DX Compose Docker Compose](https://github.com/HCL-TECH-SOFTWARE/dx-compose-docker-compose){target="_blank"} repository.
13+
14+
You can find further instructions about how to use the DX Docker Compose scripts in the same repository.

docs/deploy_dx/install/kubernetes_deployment/image_list.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,44 @@ In future continuous delivery updates, entitled customers can obtain the HCL DX
1313

1414
Video: [How to upload HCL Digital Experience 9.5 container images to a private repository](https://youtu.be/XJONRdpgCuo)
1515

16+
## HCL DX 9.5 Compose CF226
17+
18+
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:
19+
20+
- HCL Digital Experience 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
24+
25+
## hcl-compose-kubernetes-CF226.zip
26+
27+
```shell
28+
HCL DX Compose notices CF226.txt
29+
hcl-dx-content-composer-image-v1.39.0_20250314-1444.tar.gz
30+
hcl-dx-dam-plugin-google-vision-image-v1.0.0_20250314-1450.tar.gz
31+
hcl-dx-dam-plugin-kaltura-image-v1.0.0_20250314-1454.tar.gz
32+
hcl-dx-deployment-v2.35.0_20250317-1617.tgz
33+
hcl-dx-digital-asset-manager-image-v1.38.0_20250314-1509.tar.gz
34+
hcl-dx-file-processor-image-v2.0.0_20250314-1508.tar.gz
35+
hcl-dx-haproxy-image-v1.22.0_20250314-1521.tar.gz
36+
hcl-dx-image-processor-image-v1.39.0_20250314-1520.tar.gz
37+
hcl-dx-license-manager-image-v95_CF226_20250317-1342.tar.gz
38+
hcl-dx-logging-sidecar-image-v1.0.0_20250314-1500.tar.gz
39+
hcl-dx-openldap-image-v2.6.8_20250314-1500.tar.gz
40+
hcl-dx-opensearch-image-v2.0.0_20250314-1501.tar.gz
41+
hcl-dx-people-service-image-v1.0.0_20250314-1504.tar.gz
42+
hcl-dx-persistence-connection-pool-image-v1.36.0_20250314-1519.tar.gz
43+
hcl-dx-persistence-metrics-exporter-image-v1.34.0_20250314-1519.tar.gz
44+
hcl-dx-persistence-node-image-v1.26_20250314-1528.tar.gz
45+
hcl-dx-prereqs-checker-image-v1.0.0_20250314-1502.tar.gz
46+
hcl-dx-ringapi-image-v1.39.0_20250314-1513.tar.gz
47+
hcl-dx-runtime-controller-image-v95_CF226_20250314-1505.tar.gz
48+
hcl-dx-search-middleware-image-v2.0.0_20250314-1455.tar.gz
49+
hcl-dx-search-v2.24.0_20250317-1645.tgz
50+
hcl-dx-webengine-image-CF226_20250314-1843.tar.gz
51+
```
52+
53+
<!--
1654
## HCL DX 9.5 Compose CF225
1755
1856
If you are deploying the HCL DX 9.5 Compose CF225 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:

docs/deploy_dx/install/kubernetes_deployment/kubernetes_runtime.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Review your chosen Kubernetes platform and ensure that it supports the following
3737

3838
|CF Level|Kubernetes versions|
3939
|--------------|-----------------|
40+
|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/>|
4041
|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/>|
4142
|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/>|
4243

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,13 @@ images:
2727

2828
All pods created now have that secret configured for pulling DX Compose container images.
2929

30-
<!--
3130
## Configuring deployment to use the HCL Harbor container registry
3231

33-
It is possible to pull images directly from the HCL Harbor container registry. This requires every cluster node to be able to access the HCL Harbor container registry.
32+
You can pull images directly from the HCL Harbor container registry. This requires every cluster node to be able to access the HCL Harbor container registry.
3433

35-
If you want to leverage this feature, you will have to configure an ImagePullSecret with your HCL Harbor credentials.
34+
If you want to use this feature, you must configure an ImagePullSecret with your HCL Harbor credentials.
3635

37-
To do so, use the following command targeting your the Kubernetes namespace for your deployment:
36+
Use the following command targeting your the Kubernetes namespace for your deployment:
3837

3938
```sh
4039
# E-Mail and username are your harbor login, the password is your harbor CLI secret
@@ -44,24 +43,23 @@ kubectl create secret -n <YOUR-NAMESPACE> docker-registry dx-harbor --docker-ser
4443
--docker-password='<YOUR_HARBOR_CLI_SECRET>'
4544
```
4645

47-
You can obtain the CLI secret from harbor by navigating to your `User Profile` in [HCL Harbor](https://hclcr.io){target="_blank"}. You can copy it from the field called `CLI secret`.
46+
You can obtain the CLI secret from Harbor by navigating to your `User Profile` in [HCL Harbor](https://hclcr.io){target="_blank"}. You can copy it from the field called `CLI secret`.
4847

4948
After executing this command you should receive the following message:
5049

5150
```text
52-
secret/dx-harbor created
51+
secret/dx-compose-harbor created
5352
```
5453

55-
Inside your `custom-values.yaml` you can now adjust the ImagePullSecret to the secret that was just created and point to the HCL Harbor container registry.
54+
Inside your `custom-values.yaml` you can now adjust the `ImagePullSecret` to the secret that was just created and point to the HCL Harbor container registry.
5655

5756
```yaml
5857
# Image related configuration
5958
images:
6059
repository: "hclcr.io"
6160
# Image pull secrets used for accessing the repository
6261
imagePullSecrets:
63-
- name: "dx-harbor"
62+
- name: "dx-compose-harbor"
6463
```
6564

66-
Your deployment can now directly pull the container images from the HCL Harbor container registry.
67-
-->
65+
Your deployment can now directly pull the container images from the HCL Harbor container registry.

docs/deploy_dx/manage/cfg_dx_compose/enable_people_service.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Enabling and disabling People Service
22

3-
This document outlines configurations to enable and disable People Service in HCL Digital Experience (DX) Compose using the `values.yaml` file. People Service provides a layer for social connectivity by helping team members to connect, especially in large projects. It enhances user profiles with additional data and interactive features, improving team collaboration and project execution.
3+
This document outlines configurations to enable and disable [People Service](https://help.hcl-software.com/digital-experience/9.5/latest/extend_dx/integration/people_service/){target="_blank"} in HCL Digital Experience (DX) Compose using the `values.yaml` file. People Service provides a layer for social connectivity by helping team members to connect, especially in large projects. It enhances user profiles with additional data and interactive features, improving team collaboration and project execution.
44

55
!!!note
66
In this release, instructions for using this feature is located in the [HCL Digital Experience Help Center](https://help.hcl-software.com/digital-experience/9.5/latest/extend_dx/integration/people_service/){target="_blank"}. These will be documented in the HCL Digital Experience Compose Help Center in future releases.
@@ -28,3 +28,11 @@ Access People Service by using the following sample URL:
2828
```link
2929
https://your-portal.net/dx/ui/people
3030
```
31+
32+
## People Service with Search V2
33+
34+
You can integrate People Service with [Search V2](https://help.hcl-software.com/digital-experience/9.5/latest/build_sites/search_v2/){target="_blank"} to enhance user discoverability and search performance. This integration provides efficient access to user profile data with real-time synchronization.
35+
36+
You can enable the Search V2 integration through the parameter `configuration.search.middleware.enabled` in the People Service Helm chart.
37+
38+
For more information on how to integrate People Service with Search V2, refer to the [People Service and Search V2 integration](https://help.hcl-software.com/digital-experience/9.5/latest/extend_dx/integration/people_service/integration/people_service_search_v2_integration/){target="_blank"} topic.
Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Enabling and disabling Search V2
1+
# Enabling Search V2
22

3-
This document outlines configurations to enable and disable Search V2 in HCL Digital Experience (DX) Compose using the `values.yaml` file. Search introduces a new user interface along with a new backend service that utilizes OpenSearch to provide a seamless search experience.
3+
[Search V2](https://help.hcl-software.com/digital-experience/9.5/latest/build_sites/search_v2/){target="_blank"} introduces a new user interface with a backend service that utilizes OpenSearch to provide a seamless search experience. Search V2 is enabled by default for HCL Digital Experience (DX) Compose when the parameter `configuration.searchMiddleware.enabled` is set to `true` in the HCL DX Deployment Helm chart.
44

55
## Search configuration
66

@@ -9,31 +9,33 @@ Refer to the following sample snippet for configuring the DX Compose server to e
99
```yaml
1010
# Application configuration
1111
configuration:
12-
# Application specific configuration for Core
13-
webEngine:
14-
# Settings for SearchV2 UI configuration
15-
search:
16-
# Determines if search ui v2 is enabled or not
17-
uiV2Enabled: true
18-
# Determines to which search center any input box on DX redirects by default
19-
inputRedirectVersion: "v2"
12+
# Search Middleware configuration
13+
searchMiddleware:
14+
# Enable/Disable Search Middleware
15+
enabled: true
2016
```
2117
22-
Set the value of the key `uiV2Enabled` to `true` to enable or `false` to disable Search V2.
23-
Set the value of the key `inputRedirectVersion` to `v2` to redirect all searches on DX to the new Search V2 UI.
24-
25-
2618
## Validation
2719
28-
After updating the `values.yaml` file, perform the following actions:
20+
After updating the `values.yaml file`, perform the following actions:
2921

3022
- If running the server for the first time, refer to [Installing WebEngine](../../install/kubernetes_deployment/install.md).
3123
- If upgrading previous configurations, refer to [Upgrading the Helm deployment](../working_with_compose/helm_upgrade_values.md).
3224

25+
## Access
26+
3327
Access the HCL Search V2 by navigating to **Practitioner Studio > Web Content > Search**.
3428

3529
You can also use the following sample URL:
3630

3731
```
3832
https://your-portal.net/wps/myportal/Practitioner/SearchCenter
39-
```
33+
```
34+
35+
## Search V2 integration
36+
37+
You can enable the following application to use as additional data source for Search V2:
38+
39+
- [People Service](https://help.hcl-software.com/digital-experience/9.5/latest/extend_dx/integration/people_service/){target="_blank"}
40+
41+
For more information on how to integrate People Service with Search V2, refer to the [People Service and Search V2 integration](https://help.hcl-software.com/digital-experience/9.5/latest/extend_dx/integration/people_service/integration/people_service_search_v2_integration/){target="_blank"} topic.

docs/deploy_dx/manage/cfg_dx_compose/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Learn how to enable and disable artificial intelligence (AI) analysis for Web Co
1212
Learn how to integrate WAB with DX Compose.
1313
- **[Enabling and disabling People Service](enable_people_service.md)**
1414
Learn how to enable and disable People Service.
15-
- **[Enabling and disabling Search V2](enable_search.md)**
15+
- **[Enabling Search V2](enable_search.md)**
1616
Learn how to enable and disable Search V2.
1717
- **[Integrating Digital Data Connector (DDC) in DX Compose](./integrate_ddc/index.md)**
1818
Learn how to integrate DDC in DX Compose.

docs/deploy_dx/manage/cfg_webengine/webengine_directory_structure.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Database properties are stored in the following directory:
6868
```
6969

7070
### Custom secrets
71+
7172
Custom secrets are stored in subfolders under the following directory:
7273

7374
```
@@ -76,6 +77,16 @@ Custom secrets are stored in subfolders under the following directory:
7677

7778
For more details, refer to [Using custom secrets in WebEngine](../working_with_compose/custom_secrets.md).
7879

80+
### Custom certificates
81+
82+
Custom certificates are stored in subfolders under the following directory:
83+
84+
```
85+
/mnt/certs
86+
```
87+
88+
For more details, refer to [Using custom Certificates in WebEngine](../working_with_compose/custom_certificates.md).
89+
7990
## Sidecar container for logs
8091

8192
### SystemOut log

docs/deploy_dx/manage/working_with_compose/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ nav:
1010
- Troubleshooting: troubleshooting
1111
- Upgrading the Helm deployment: helm_upgrade_values.md
1212
- Using custom secrets in WebEngine: custom_secrets.md
13+
- Using custom certificates in WebEngine: custom_certificates.md
1314
- Viewing WebEngine server logs: logging_webengine.md

0 commit comments

Comments
 (0)