Welcome
Installation
Learn more about HCL CDP installation and deploying core components of the product.
Installing HCL CDP on Microsoft Azure
This section details the installation and deployment of the services and components required for deploying HCL CDP (Customer Data Platform) on the Microsoft Azure platform.
Deploying HCL CDP Core Components on Microsoft Azure
This section describes the installation and configuration of services and components required for deploying HCL CDP core components on Microsoft Azure.
Deploying CDP JavaScript SDK
This section describes the steps to configure and deploy HCL CDP JavaScript SDK on an Azure Kubernetes Service (AKS) cluster using the provided Helm chart.

Get Started
Follow these steps to learn about, deploy, configure, and start using HCL CDP.
Installation
Learn more about HCL CDP installation and deploying core components of the product.
- Installing HCL CDP on OpenShift
  This section details the installation and deployment of the services and components required for deploying HCL CDP (Customer Data Platform) on the Red Hat OpenShift platform.
- Installing HCL CDP on Microsoft Azure
  This section details the installation and deployment of the services and components required for deploying HCL CDP (Customer Data Platform) on the Microsoft Azure platform.
  - Installing HCL CDP Platform on Microsoft Azure
    This chapter details the installation and configuration of the services and components required for deploying HCL CDP (Customer Data Platform) on Microsoft Azure using Azure Kubernetes Service (AKS).
  - Deploying HCL CDP Core Components on Microsoft Azure
    This section describes the installation and configuration of services and components required for deploying HCL CDP core components on Microsoft Azure.
    - Introduction
      This section details the installation and configuration of the services and components required for deploying HCL CDP core components on Microsoft Azure using Helm charts on the AKS cluster.
    - Prerequisites
      Before deploying HCL CDP core components on Microsoft Azure, ensure the required tools and Kubernetes resources are available.
    - List of CDP Core Components for Microsoft Azure
      This section lists the HCL CDP core module components to be deployed and configured on Microsoft Azure.
    - Deploying CDP Admin UI
      This section describes the steps to configure and deploy the HCL CDP Admin UI on an AKS cluster using the provided Helm chart.
    - Deploying CDP JavaScript SDK
      This section describes the steps to configure and deploy HCL CDP JavaScript SDK on an Azure Kubernetes Service (AKS) cluster using the provided Helm chart.
    - Deploying CDP Admin UI Backend
      This section describes the steps to configure and deploy the HCL CDP Admin UI Backend on an AKS cluster using the provided Helm chart.
    - Deploying CDP Web App
      This section describes the steps to configure and deploy the HCL CDP Web App on an AKS cluster using the provided Helm chart.
    - Deploying CDP Dash Backend
      This section describes the steps to configure and deploy the HCL CDP Dash Backend on an AKS cluster using the provided Helm chart.
    - Deploying CDP Core API
      This section describes the steps to configure and deploy the HCL CDP Core API on an AKS cluster using the provided Helm chart.
    - Deploying CDP Manager
      This section describes the steps to configure and deploy the HCL CDP Manager on an AKS cluster using the provided Helm chart.
    - Deploying CDP DI API
      This section describes the steps to configure and deploy the HCL CDP DI API on an AKS cluster using the provided Helm chart.
    - Deploying CDP KMS Service
      This section describes the steps to configure and deploy the HCL CDP KMS Service on an AKS cluster using the provided Helm chart.
    - Deploying Pixel Listener
      This section describes the steps to configure and deploy the HCL Pixel Listener on an AKS cluster using the provided Helm chart.
    - Deploying CDP RTS
      This section describes the steps to configure and deploy the HCL CDP RTS on an AKS cluster using the provided Helm chart.
    - Deploying CDP RTS MS
      This section describes the steps to configure and deploy the HCL CDP RTS MS on an AKS cluster using the provided Helm chart.
    - Deploying CDP Live Events
      This section describes the steps to configure and deploy the HCL CDP Live Events on an AKS cluster using the provided Helm chart.
    - Deploying CDP DMP SST
      This section describes the steps to configure and deploy the HCL CDP DMP SST on an AKS cluster using the provided Helm chart.
    - Deploying CDP DMP Producer
      This section describes the steps to configure and deploy the HCL CDP DMP Producer Service on an Azure Kubernetes Service (AKS) cluster using the provided Helm chart.
    - Deploying CDP DMP SST MAPS
      This section describes the steps to configure and deploy the HCL CDP DMP SST MAPS on an AKS cluster using the provided Helm chart.
    - Deploying CDP DMP SST API
      This section describes the steps to configure and deploy the HCL CDP DMP SST API on an AKS cluster using the provided Helm chart.
    - Deploying CDP S3 Sink Connector
      This section describes the steps to configure and deploy the HCL CDP S3 Sink Connector on an AKS cluster using the provided Helm chart.
    - Deploying CDP Mongo Sink Connector
      This section describes the steps to configure and deploy the HCL CDP Mongo Sink Connector on an AKS cluster using the provided Helm chart.
    - Deploying CDP Mongo Sink Connectors
      This section provides detailed instructions on how to deploy HCL CDP Mongo Sink Connectors via the Kafka Connect REST API.
    - Deploying CDP S3 Sink Connectors
      This section provides detailed instructions on how to deploy HCL CDP S3 Sink Connectors via the Kafka Connect REST API.
    - Deploying CDP DMP SST Redis
      This section describes the steps to deploy a Redis cluster for CDP DMP SST on an AKS cluster using the Bitnami Redis Helm chart.
    - List of Components for Flink Modules
      This section lists the components that must be deployed and configured to support HCL CDP Flink modules on Microsoft Azure.
  - Deploying HCL CDP Marketing Automation Component
    This chapter details the deployment of Marketing Automation components required for HCL CDP on Microsoft Azure.
  - HCL CDP Hardware Sizing Details for Microsoft Azure
    This section outlines the resource estimates for deploying HCL CDP on Azure Kubernetes Service (AKS).
- Installing HCL CDP on AWS
  This section details the installation and deployment of the services and components required for deploying HCL CDP (Customer Data Platform) on the AWS platform.
- Upgrading HCL CDP Platform
  This section details the upgrading HCL CDP platform on the Red Hat OpenShift platform.
Administration
Learn about how to configure, manage, and maintain HCL CDP environments. It includes details on system setup, user management, permissions, integrations, and troubleshooting, ensuring seamless operation and efficient deployment of your continuous delivery processes.
Working with System
This section describes the Data Pipeline for streamlined data flow, leveraging Customer One View for unified profiles, and orchestrating campaigns to drive targeted engagement.
Insights and Actions
This section details unify real-time dashboards and AI-driven intelligence to transform data into impactful outcomes.
Integrations
HCL CDP comes with predefined APIs like get profile and data ingestion APIs.
Settings
This section allows configuring product label, setting frequency caps, and so on.
System Data Model

Deploying CDP JavaScript SDK

This section describes the steps to configure and deploy HCL CDP JavaScript SDK on an Azure Kubernetes Service (AKS) cluster using the provided Helm chart.

Before you begin

Make sure to create the cdp-java-script-sdk secret in the HashiCorp vault before deploying the CDP JavaScript SDK.

To create the cdp-java-script-sdk secret in the HashiCorp Vault, follow the steps below:

Create a cdp-java-script-sdk secret sample key and value in the cdp-java-script-sdk secret shown below, and update the actual values.

{
  "CAMPAIGN_DEFAULT_TTL": "",
  "DbDriver": "",
  "DbPassword": "",
  "DbUrl": "",
  "DbUsername": "",
  "KMS_HASHICORPVAULT_ENDPOINT": "",
  "KMS_HASHICORPVAULT_ENDPOINT_TOKEN": "",
  "KMS_IMPLEMENTATION": "",
  "awsRegions": "",
  "supportedRegions": ""
}

Procedure

Configure the values.yaml file.

Update the environment-specific configuration in chart-location/cdp-java-script-sdk/values.yaml.
Configure application ConfigMaps.

Enable ConfigMaps and configure the required CDP JavaScript SDK Service application URLs.
Configure container image.

Update the HCL CDP JavaScript SDK Service image repository and required image version/tag.

Verify image pull secret.

kubectl get secret hclcr-cred -n cdp-dev-app

Configure NGINX Ingress.

Enable Ingress and configure the required hostname, path, and TLS settings.
Configure Vault secrets.
Ensure the vault-creds Secret exists:
```
kubectl get secret vault-creds -n cdp-dev-app
```
The init container retrieves the kms-service secret from CDP_Secrets and writes it to /etc/secrets/mysecrets.json.

Verify or create namespace.

kubectl get namespace cdp-dev-app

If required, create the namespace:

kubectl create namespace cdp-dev-app

Install CDP JavaScript SDK Service.

helm install cdp-java-script-sdk \
  chart-location/cdp-java-script-sdk \
  -f chart-location/cdp-java-script-sdk/values.yaml \
  -n cdp-dev-app

Verify Helm release.
```
helm list -n cdp-dev-app
```
Expected status: deployed

Verify deployment and pods.

kubectl get deployment -n cdp-dev-app
kubectl get pods -n cdp-dev-app -l k8s-app=cdp-java-script-sdk

Expected pod status:

READY   STATUS
1/1     Running