Skip to content

Commit 1bb42ab

Browse files
Merge pull request #8 from HCL-TECH-SOFTWARE/sync/cf227
Sync/cf227
2 parents 80b0c8c + 5e654e8 commit 1bb42ab

File tree

25 files changed

+969
-28
lines changed

25 files changed

+969
-28
lines changed

docs/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ nav:
33
- whats_new
44
- getting_started
55
- deploy_dx
6+
- guide_me

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 CF227
17+
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:
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-CF227.zip
26+
27+
```shell
28+
HCL DX Compose notices CF227.txt
29+
hcl-dx-content-composer-image-v1.40.0_20250425-1905.tar.gz
30+
hcl-dx-dam-plugin-google-vision-image-v1.0.0_20250425-1907.tar.gz
31+
hcl-dx-dam-plugin-kaltura-image-v1.0.0_20250425-1908.tar.gz
32+
hcl-dx-deployment-v2.36.0_20250428-1459.tgz
33+
hcl-dx-digital-asset-manager-image-v1.39.0_20250425-1945.tar.gz
34+
hcl-dx-file-processor-image-v2.0.0_20250425-1932.tar.gz
35+
hcl-dx-haproxy-image-v1.23.0_20250425-1932.tar.gz
36+
hcl-dx-image-processor-image-v1.40.0_20250425-1933.tar.gz
37+
hcl-dx-license-manager-image-v95_CF227_20250425-1914.tar.gz
38+
hcl-dx-logging-sidecar-image-v1.0.0_20250425-1915.tar.gz
39+
hcl-dx-openldap-image-v2.6.8_20250425-1911.tar.gz
40+
hcl-dx-opensearch-image-v2.0.0_20250425-1916.tar.gz
41+
hcl-dx-people-service-image-v1.0.0_20250425-1910.tar.gz
42+
hcl-dx-persistence-connection-pool-image-v1.37.0_20250425-1931.tar.gz
43+
hcl-dx-persistence-metrics-exporter-image-v1.35.0_20250425-1930.tar.gz
44+
hcl-dx-persistence-node-image-v1.27_20250425-1926.tar.gz
45+
hcl-dx-prereqs-checker-image-v1.0.0_20250425-1933.tar.gz
46+
hcl-dx-ringapi-image-v1.40.0_20250425-1924.tar.gz
47+
hcl-dx-runtime-controller-image-v95_CF227_20250425-1917.tar.gz
48+
hcl-dx-search-middleware-image-v2.0.0_20250425-1929.tar.gz
49+
hcl-dx-search-v2.25.0_20250428-1459.tgz
50+
hcl-dx-webengine-image-CF227_20250425-2144.tar.gz
51+
```
52+
53+
<!--
1654
## HCL DX 9.5 Compose CF226
1755
1856
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:

docs/deploy_dx/install/kubernetes_deployment/preparation/mandatory_tasks/prepare_configure_networking.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,16 @@ networking:
9292

9393
This configuration is helpful for those who want to use a custom `Ingress Controller` to expose the service in a compatible way. Even then, HAProxy will still be active. The `Ingress Controller` will handle the incoming traffic and then route them to the HAProxy service.
9494

95+
## Using annotations to control the HAProxy service behavior for different cloud providers
96+
97+
The Helm chart allows you to add annotations to the HAProxy service to control the behavior of the service for different cloud providers. You can use this to configure the service to use a specific type of load balancer or to configure other settings specific to the cloud provider. You can add annotations in your `custom-values.yaml` as described [in the Annotations documentation](../optional_tasks/optional_labels_annotations.md#annotations).
98+
99+
Examples for such annotations are in an non-exhaustive list. Refer to the documentation provided by your cloud provider for more information:
100+
101+
- [Amazon Elastic Kubernetes Service - Use Service Annotations to configure Network Load Balancers](https://docs.aws.amazon.com/eks/latest/userguide/auto-configure-nlb.html){target="_blank"}
102+
- [Google Kubernetes Engine - LoadBalancer Service parameters](https://cloud.google.com/kubernetes-engine/docs/concepts/service-load-balancer-parameters){target="_blank"}
103+
- [Azure Kubernetes Service - LoadBalancer annotations](https://cloud-provider-azure.sigs.k8s.io/topics/loadbalancer/#loadbalancer-annotations){target="_blank"}
104+
95105
## Generate self-signed certificate
96106

97107
**It is recommended that you use a properly signed certificate for HAProxy**. However, it is also possible to create and use a self-signed certificate, for example, for staging or testing environment.
@@ -148,10 +158,10 @@ A `Route` resource must be created manually when required as part of a deploymen
148158

149159
#### Create the route resource manually
150160

151-
If you want to deploy OpenShift manually using `Routes`, you need to create a .yaml file like below and any changes required can be made in that. To apply those changes in the OpenShift cluster, you can run `kubectl apply` and specify its namespace and location.
161+
If you want to deploy OpenShift manually using `Routes`, you need to create a `.yaml` file like below and any changes required can be made in that. To apply those changes in the OpenShift cluster, you can run `kubectl apply` and specify its namespace and location.
152162
For more information, refer to the [OpenShift Route Configuration](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html){target="blank"} documentation.
153163

154-
In some versions of OpenShift, by default, sticky sessions for passthrough `Routes` are enabled in OpenShift using the source (IP) as identifier. To make sure traffic gets forwarded to all DX Compose HAProxy Pods even when another proxy is used in front of it, the `Route` should be annotated as shown in the example below. Please refer to the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html){target="blank"} to select the appropriate value for your deployment.
164+
In some versions of OpenShift, by default, sticky sessions for passthrough `Routes` are enabled in OpenShift using the source (IP) as identifier. To make sure traffic gets forwarded to all DX Compose HAProxy Pods even when another proxy is used in front of it, the `Route` should be annotated as shown in the example below. Refer to the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/networking/routes/route-configuration.html){target="blank"} to select the appropriate value for your deployment.
155165

156166
```yaml
157167
apiVersion: "route.openshift.io/v1"

docs/deploy_dx/manage/cfg_dx_compose/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ nav:
77
- enable_people_service.md
88
- enable_search.md
99
- integrate_ddc
10+
- setup_cntnt_serv_pgs.md
Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# Configuring DX Compose
22

3-
<!-- add short description-->
3+
In this topic, you will learn how to configuring the different features and services available in HCL Digital Experience (DX) Compose.
44

5-
- **[Enabling and disabling Content Composer](enable_cc.md)**
5+
- **[Enabling and disabling Content Composer](./enable_cc.md)**
66
Learn how to enable and disable Content Composer.
7-
- **[Enabling and disabling Digital Asset Management](enable_dam.md)**
7+
- **[Enabling and disabling Digital Asset Management](./enable_dam.md)**
88
Learn how to enable and disable Digital Asset Management.
9-
- **[Enabling and disabling WCM Content AI Analysis](enable_content_ai.md)**
9+
- **[Enabling and disabling WCM Content AI Analysis](./enable_content_ai.md)**
1010
Learn how to enable and disable artificial intelligence (AI) analysis for Web Content Management (WCM) content.
11-
- **[Integrating WAB with DX Compose](wab_integration.md)**
11+
- **[Integrating WAB with DX Compose](./wab_integration.md)**
1212
Learn how to integrate WAB with DX Compose.
13-
- **[Enabling and disabling People Service](enable_people_service.md)**
13+
- **[Enabling and disabling People Service](./enable_people_service.md)**
1414
Learn how to enable and disable People Service.
15-
- **[Enabling Search V2](enable_search.md)**
15+
- **[Enabling Search V2](./enable_search.md)**
1616
Learn how to enable and disable Search V2.
17-
- **[Integrating Digital Data Connector (DDC) in DX Compose](./integrate_ddc/index.md)**
18-
Learn how to integrate DDC in DX Compose.
17+
- **[Integrating Digital Data Connector in DX Compose](./integrate_ddc/index.md)**
18+
Learn how to integrate DDC in DX Compose.
19+
- **[Installing Content as a Service](./setup_cntnt_serv_pgs.md)**
20+
Learn how to install Content as a Service (CaaS).
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Setting up Content as a Service
2+
3+
To be able to work with Content as a Service (CaaS) pages in HCL Digital Experience (DX) Compose, you must enable it using the steps listed in this topic. The setup for CaaS is comprised of resources that are shared across virtual portals and virtual portal scoped resources.
4+
5+
Refer to the following steps to install and configure CaaS:
6+
7+
1. On a Kubernetes deployment, change the directory to `/home/centos/native-kube` on the main Kubernetes node.
8+
9+
2. Run the following command to make the CaaS theme available to DX Compose.
10+
11+
```
12+
helm upgrade -n dxns -f install-deploy-values.yaml -f ./install-hcl-dx-deployment/caas/install-caas.yaml dx-deployment ./install-hcl-dx-deployment
13+
```
14+
15+
3. Run the following command to enter a bash shell on the DX Compose WebEngine pod.
16+
17+
```
18+
kubectl exec -it dx-deployment-web-engine-0 bash -n dxns
19+
```
20+
21+
4. Run the following command to register the CaaS theme to all the virtual portals in DX Compose.
22+
23+
```
24+
/opt/openliberty/wlp/usr/svrcfg/scripts/xmlaccess/xmlaccess.sh -d /opt/openliberty/wlp/usr/servers/defaultServer -url http://localhost:9080/wps/config -in /opt/openliberty/wlp/usr/svrcfg/templates/caas/deployCaaSTheme.xml -out /tmp/deployCaaSTheme.xml.out -user "your Portal Admin userid" -password "your password"
25+
```
26+
27+
5. Run the following command to register the CaaS Page and Portlet in each virtual portal, including the main virtual portal.
28+
29+
```
30+
/opt/openliberty/wlp/usr/svrcfg/scripts/xmlaccess/xmlaccess.sh -d /opt/openliberty/wlp/usr/servers/defaultServer -url http://localhost:9080/wps/config -in /opt/openliberty/wlp/usr/svrcfg/templates/caas/deployCaaSPages.xml -out /tmp/deployCaaSPages.xml.out -user "your Portal Admin userid" -password "your password"
31+
```
32+
33+
If you are installing the CaaS pages into a virtual portal apart from the main virtual portal, run the following command. This command includes the `VP Context` in the `url` parameter.
34+
35+
```
36+
/opt/openliberty/wlp/usr/svrcfg/scripts/xmlaccess/xmlaccess.sh -d /opt/openliberty/wlp/usr/servers/defaultServer -url http://localhost:9080/wps/config/"VP Context" -in /opt/openliberty/wlp/usr/svrcfg/templates/caas/deployCaaSPages.xml -out /tmp/deployCaaSPages.xml.out -user "your Portal Admin userid" -password "your password"
37+
```
38+
39+
6. Restart your HCL DX Compose server.
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
/****************************************************************************************************
2+
* ★★★★★ IMPORTANT WARNING ★★★★★
3+
* PLEASE REVIEW AND UPDATE ALL USERS, ROLES, AND PATHS ACCORDING TO YOUR ENVIRONMENT.
4+
* This sample script is provided as a template. BEFORE EXECUTION, ensure that you modify the
5+
* user names, role definitions, and file paths to match your specific requirements and
6+
* security policies.
7+
****************************************************************************************************/
8+
9+
-- NOTE: create a database name WPSDB & user. And update below query with your database connect user (<replace-with-user>) and password (<replace-with-user-password>)
10+
-- NOTE: make sure replace the <replace-with-user> and <replace-with-user-password> with your database connect user and password
11+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
12+
CREATE SCHEMA release AUTHORIZATION <replace-with-user>;
13+
COMMIT;
14+
15+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_BASE_CONFIG_USERS;
16+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_BASE_CONFIG_USERS;
17+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA release TO GROUP WP_BASE_CONFIG_USERS;
18+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_BASE_CONFIG_USERS;
19+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_BASE_CONFIG_USERS;
20+
21+
CONNECT RESET;
22+
23+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
24+
CREATE SCHEMA community AUTHORIZATION <replace-with-user>;
25+
COMMIT;
26+
27+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_BASE_CONFIG_USERS;
28+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_BASE_CONFIG_USERS;
29+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA community TO GROUP WP_BASE_CONFIG_USERS;
30+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_BASE_CONFIG_USERS;
31+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_BASE_CONFIG_USERS;
32+
33+
CONNECT RESET;
34+
35+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
36+
CREATE SCHEMA customization AUTHORIZATION <replace-with-user>;
37+
COMMIT;
38+
39+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_BASE_CONFIG_USERS;
40+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_BASE_CONFIG_USERS;
41+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA customization TO GROUP WP_BASE_CONFIG_USERS;
42+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_BASE_CONFIG_USERS;
43+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_BASE_CONFIG_USERS;
44+
45+
CONNECT RESET;
46+
47+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
48+
CREATE SCHEMA jcr AUTHORIZATION <replace-with-user>;
49+
COMMIT;
50+
51+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_JCR_CONFIG_USERS;
52+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_JCR_CONFIG_USERS;
53+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA jcr TO GROUP WP_JCR_CONFIG_USERS;
54+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_JCR_CONFIG_USERS;
55+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_JCR_CONFIG_USERS;
56+
57+
58+
GRANT USE OF TABLESPACE ICMLFQ32 TO GROUP WP_JCR_CONFIG_USERS;
59+
GRANT USE OF TABLESPACE ICMLNF32 TO GROUP WP_JCR_CONFIG_USERS;
60+
GRANT USE OF TABLESPACE ICMVFQ04 TO GROUP WP_JCR_CONFIG_USERS;
61+
GRANT USE OF TABLESPACE ICMSFQ04 TO GROUP WP_JCR_CONFIG_USERS;
62+
GRANT USE OF TABLESPACE CMBINV04 TO GROUP WP_JCR_CONFIG_USERS;
63+
GRANT USE OF TABLESPACE ICMLSUSRTSPACE4 TO GROUP WP_JCR_CONFIG_USERS;
64+
65+
CONNECT RESET;
66+
67+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
68+
CREATE SCHEMA feedback AUTHORIZATION <replace-with-user>;
69+
COMMIT;
70+
71+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_PZN_CONFIG_USERS;
72+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_PZN_CONFIG_USERS;
73+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA feedback TO GROUP WP_PZN_CONFIG_USERS;
74+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_PZN_CONFIG_USERS;
75+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_PZN_CONFIG_USERS;
76+
77+
CONNECT RESET;
78+
79+
CONNECT TO WPSDB USER <replace-with-user> USING <replace-with-user-password>;
80+
CREATE SCHEMA likeminds AUTHORIZATION <replace-with-user>;
81+
COMMIT;
82+
83+
GRANT CONNECT, CREATETAB ON DATABASE TO GROUP WP_PZN_CONFIG_USERS;
84+
GRANT EXECUTE ON PACKAGE NULLID.SYSSH200 TO GROUP WP_PZN_CONFIG_USERS;
85+
GRANT ALTERIN, CREATEIN, DROPIN ON SCHEMA likeminds TO GROUP WP_PZN_CONFIG_USERS;
86+
GRANT USE OF TABLESPACE USERSPACE1 TO GROUP WP_PZN_CONFIG_USERS;
87+
GRANT USAGE ON WORKLOAD SYSDEFAULTUSERWORKLOAD TO GROUP WP_PZN_CONFIG_USERS;
88+
89+
CONNECT RESET;

0 commit comments

Comments
 (0)