Install the HCL Digital Experience 9.5 Container Tech Preview components

This section provides a high-level overview of the architecture and the steps to install and configure the HCL Digital Experience 9.5 Experience API - Tech Preview, HCL Digital Experience 9.5 Content Composer - Tech Preview, and HCL Digital Experience 9.5 Digital Asset Management - Tech Preview components.

High-level architecture and topology

Figure 1: High-level architecture
Figure 2: Topology

Prerequisite

Install and configure HCL Digital Experience 9.5 Container Update release CF_173 or later, on either the Amazon Elastic Kubernetes Service (EKS) or the Red Hat OpenShift container platform using the procedures in the Deployment section.
Note: It is recommended to install the HCL Digital Experience 9.5 Experience API - Tech Preview, HCL Digital Experience 9.5 Content Composer - Tech Preview, and HCL Digital Experience 9.5 Digital Asset Management - Tech Preview to a non-production (test) HCL Digital Experience 9.5 environment.

Installing the Tech Preview components

Follow these steps to install your HCL Digital Experience 9.5 CF_173 or later Experience API - Tech Preview, HCL Digital Experience 9.5 Content Composer - Tech Preview, and HCL Digital Experience 9.5 Digital Asset Management - Tech Preview components.
  1. Verify that you can access the HCL Digital Experience 9.5 CF_173 or later Practitioner Studio by logging in to your HCL Digital Experience 9.5 Practitioner Studio interface. See the HCL Digital Experience 9.5 Practitioner Studio topic for information.
  2. Download and extract the HCL Digital Experience 9.5 Tech Preview components from your Digital Experience entitlements from the HCL Software License Portal to the local file system.

    Download package name: hcl-dx-tech-preview-v95-CF173.zip or later tech-preview-v95-CFxx.zip

    Contains:
    • HCL Experience API - Tech Preview (Docker image) - hcl-dx-ringapi-image-v0.6.0_xxxxxxxx-xxxx.tar.gz
    • HCL Digital Asset Management - Tech Preview (Operator) - hcl-dx-medialibrary-operator-image-v95_CF173_xxxxxxxx-xxxx.tar.gz
    • HCL Digital Experience Digital Asset Management - Tech Preview (Docker image) - hcl-dx-media-library-image-v0.1.0_xxxxxxxx-xxxx.tar.gz
    • HCL Digital Experience Digital Asset Management - Tech Preview (Image processor) - hcl-dx-image-processor-image-v1.0.0_xxxxxxxx-xxxx.tar.gz
    • HCL Content Composer - Tech Preview (Docker image) - hcl-dx-content-ui-image-v0.2.0_xxxxxxxx-xxxx.tar.gz
    • Postgres - hcl-dx-postgres-image-11.5_xxxxxxxx-xxxx.tar.gz
  3. Extract the images to the local file system.
  4. Open a terminal window and change to the root directory of the extracted package images.
  5. Load the containers into your Docker repository on Amazon EKS or Red Hat OpenShift platform.

    For example:

    Docker load < hcl-dx-ringapi-image-v0.6.0_xxxxxxxx-xxxx.tar.gz
    Docker load < hcl-dx-medialibrary-operator-image-v95_CF173_xxxxxxxx-xxxx.tar.gz
    Docker load < hcl-dx-media-library-image-v0.1.0_xxxxxxxx-xxxx.tar.gz
    Docker load < hcl-dx-content-ui-image-v0.2.0_xxxxxxxx-xxxx.tar.gz
    Docker load < hcl-dx-image-processor-image-v1.0.0_xxxxxxxx-xxxx.tar.gz
    Docker load < hcl-dx-postgres-image-11.5_xxxxxxxx-xxxx.tar.gz
    Note: Either -i or < works for the load command. In case you encounter an error when using one, try running the command using the other.
  6. Install the HCL Digital Experience 9.5 CF_173 or later Experience API, Content Composer, and Digital Asset Management Tech Preview components.
    Note: The HCL Experience API - Tech Preview must be installed to access and use the HCL Content Composer - Tech Preview and the HCL Digital Asset Management - Tech Preview features.
  7. Verify your HCL Digital Experience 9.5 CF_173 or later container instance is up and running on Amazon EKS or Red Hat OpenShift.
  8. Update the HCL Digital Experience 9.5 CF_173 container deployment configuration map to deploy the HCL Experience API, HCL Content Composer, and HCL Digital Asset Management CF_173 or later Tech Preview components.
    Note: The config map name value used to support the CF_173 or later Tech Preview components must be the same as the HCL Digital Experience 9.5 CF_173 or later deployment. By default, the config map deployment name value is dx-deployment.
  9. Create a YAML file with the following config map settings
    kind: DxDeployment
    metadata:
      name: dx-deployment
  10. Use the following example YAML (dx-deploy-config-map.yaml) to deploy the HCL Experience API, HCL Content Composer, and HCL Digital Asset Management CF_173 or later Tech Preview components. If deploying HCL Digital Asset Management and Content Composer CF18 Tech Preview components, replace their file names in the sample YAML file services lines used.
    Note: It is possible to deploy the services for the HCL Experience API and HCL Content Composer and/or Digital Asset Management Tech Previews by removing either the HCL Content Composer or HCL Digital Asset Management service lines from the YAML file.
    kind: ConfigMap
    metadata:
      name: dx-deployment
      namespace: your-namespace
    apiVersion: v1
    data:
      dx.deploy.contentui.enabled: "true"
      dx.deploy.contentui.image: portal/content-ui
      dx.deploy.contentui.tag: v0.2.0_20200323-2149_95_CF173
    
      dx.deploy.experienceapi.enabled: "true"
      dx.deploy.experienceapi.image: portal/api/ringapi
      dx.deploy.experienceapi.tag: v0.6.0_20200318-1556_95_CF173 
    
      dx.deploy.medialibrary.enabled: "true"
      dx.deploy.medialibrary.imgprocessor.image: portal/image-processor
      dx.deploy.medialibrary.imgprocessor.tag: v1.0.0_20200319-1731_rohan_release_95_CF173
    
      dx.deploy.medialibrary.medialibrary.image: portal/media-library
      dx.deploy.medialibrary.medialibrary.tag: v0.1.0_20200325-0746_rohan_release_95_CF173
    
      dx.deploy.medialibrary.operator.image: hcl-medialibrary-operator
      dx.deploy.medialibrary.operator.tag: 9.5.ml.next
    
      dx.deploy.medialibrary.persistence.image:  portal/persistence/postgres
      dx.deploy.medialibrary.persistence.tag: 11.5_20200323-1800_release_95_CF173
    
      dx.deploy.medialibrary.storageclass: dx-deploy-stg
      dx.deploy.medialibrary.volume: ml-volume-1
    

    The dx.deploy.contentui.enabled and dx.deploy.experienceapi.enabled configurations tell the operator to deploy HCL Content Composer and HCL Experience API Tech Previews. This defaults to using the same repository as the HCL Digital Experience 9.5 CF_173 container core deployment.

    Notes on this YAML file:
    • The deployment of HCL Content Composer and HCL Experience API Tech Preview components create:
      • Deployments named dx-deployment-contentui and dx-deployment-ringapi.
      • Services dx-deployment-service-content-ui and dx-deployment-service-ring-api, and a route for each.
    • The dx.deploy.medialibrary.enabled tells the operator to deploy the HCL Digital Asset Management component. Note that there are 4 required sets of image/tag parameters:
      • The HCL Digital Asset Management operator variables use this prefix dx.deploy.medialibrary.operator.
      • The Postgres datastore uses dx.deploy.medialibrary.persistence.
      • The HCL Digital Asset Management library services uses dx.deploy.medialibrary.medialibrary.
      • The Image processor uses dx.deploy.medialibrary.persistence.

      The last two parameters in the example YAML file provide the storage class and volume (must be ReadWriteMany) for the HCL Digital Asset Management - Tech Preview component. This is where the persistence layer maintains the datastore layer.

      An additional self-provisioning volume is created for the HCL Digital Asset Management library service. If this volume is not present the images are lost and will show blank if/when the HCL Digital Asset Management library is restarted.

      Administrators can override the repository by adding:
      dx.deploy.contentui.repository
      In addition, the following default settings can be adjusted:
      • dx.deploy.contentui.resources.cpurequest, the default is 1.
      • dx.deploy.contentui.resources.cpulimit, the default is 3.
      • dx.deploy.contentui.resources.memoryrequest, the default is 2G.
      • dx.deploy.contentui.resources.memorylimit, the default is 4G.
      • dx.deploy.experienceapi.resources.cpurequest, the default is 1.
      • dx.deploy.experienceapi.resources.cpulimit, the default is 3.
      • dx.deploy.experienceapi.resources.memoryrequest, the default is 2G.
      • dx.deploy.experienceapi.resources.memorylimit, the default is 4G.

      Additional configuration options are currently not supported.

  11. Deploy the YAML (dx-deploy-config-map.yaml) by issuing the command :
    kubectl apply -f dx-deploy-config-map.yaml -n your-namespace
  12. Stop and restart the HCL Digital Experience 9.5 CF_173 or later container deployment.
    Note: If you are adding the Tech Previews for HCL Content Composer, HCL Digital Asset Management, and HCL Experience API to an existing HCL Digital Experience 9.5 test environment (must be at level 9.5 CF_173 or later) deployment, you must stop the deployment and restart it with one (1) replica. Once it is fully started, you can safely scale it to N instances.

    Reminder: It is not advisable to deploy Tech Preview components to a production HCL Digital Experience 9.5 deployment.

  13. Access the HCL Content Composer and HCL Digital Asset Management Tech Preview components by navigating to Practitioner Studio > Web Content > Content, or Practitioner Studio > Digital Assets.
    https://your-portal.net/wps/myportal/Practitioner/Web Content/Content Library
    https://your-portal.net/wps/myportal/Practitioner/Digital Assets
  14. Access the HCL Experience API - Tech Preview Explorer at the following URL:
    route location / explorer
    For example,
    https://your-host.net/k8s/ns/ml-tests-1/routes

Tech Preview Feedback

HCL Digital Experience is interested in your experience and feedback working with this Tech Preview release software. To offer comments or issues on your findings, please access the HCL Digital Experience 9.5 Tech Preview Feedback Reporting application.