Welcome
Installation
Learn more about HCL CDP installation and deploying core components of the product.
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.
Deploying HCL CDP Marketing Automation Component on AWS
This section details the deploying Marketing Automation components required for HCL CDP on the AWS platform.
Deployment Process
This section provides step-by-step instructions for deploying each service, component, and module required for HCL CDP Marketing Automation.
Deploying HCL CDP ExternalAPI

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 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.
  - Installing HCL CDP Platform on AWS
    This section details the installation and configuration of the services and components required for deploying HCL CDP (Customer Data Platform) on the AWS platform.
  - Deploying HCL CDP Core Components on AWS
    This section details the deploying core components required for HCL CDP on the AWS platform.
  - Deploying HCL CDP Marketing Automation Component on AWS
    This section details the deploying Marketing Automation components required for HCL CDP on the AWS platform.
    - Introduction
      This document provides a comprehensive guide to installing and configuring the necessary services and components for deploying HCL CDP Marketing Automation on the AWS platform using Devtron.
    - Prerequisites
    - List of components for Marketing Automation modules
      The following components must be deployed and configured on the cluster to support the deployment of HCL CDP Marketing Automation modules.
    - Deployment Process
      This section provides step-by-step instructions for deploying each service, component, and module required for HCL CDP Marketing Automation.
      - Deploying CDP Trigger
        This section provides detailed instructions on how to deploy HCL CDP Trigger using the Devtron in the AWS.
      - Deploying HCL CDP Core
        This section provides detailed instructions on how to deploy HCL CDP Core using the Devtron in the AWS.
      - Deploying CDP Flip
      - Deploying HCL CDP SMSEmailSender
        This section provides detailed instructions on how to deploy HCL CDP SMS Email Sender using the Devtron in the AWS.
      - Deploying HCL CDP ExternalAPI
      - Deploying HCL CDP Tryitout
        This section provides detailed instructions on how to deploy HCL CDP Tryitout using the Devtron in the AWS.
      - Deploying HCL CDP Celery callback consumer
        This section provides detailed instructions on how to deploy HCL CDP Celerykafkacallbackprocessor using the Devtron in the AWS.
      - Deploying HCL CDP Celery Kafka eta Consumer
        This section provides detailed instructions on how to deploy HCL CDP Celerykafkaetaconsumer using the Devtron in the AWS.
      - Deploying HCL CDP ETA Events
        This section provides detailed instructions on how to deploy HCL CDP Etaevents using the Devtron in the AWS.
      - Deploying HCL CDP Audience Uploader
        This section provides detailed instructions on how to deploy HCL CDP Audienceuploader using the Devtron in the AWS.
      - Deploying HCL CDP Click Trackers
        This section provides detailed instructions on how to deploy HCL CDP Clicktrackers using the Devtron in the AWS.
      - Deploying HCL CDP Webpush
        This section provides detailed instructions on how to deploy HCL CDP Webpush using the Devtron in the AWS.
      - Deploying HCL CDP Webhooks
        This section provides detailed instructions on how to deploy HCL CDP Webhooks using the Devtron in the AWS.
      - Deploying VM
        This section provides detailed instructions on how to deploy VM in the AWS.
  - Deploying HCL CDP MaxAI models on AWS
    This section details the deploying MaxAI models required for HCL CDP on the AWS platform.
  - HCL CDP Hardware Sizing Details For AWS
    This section outlines the minimum hardware requirements to guide AWS infrastructure sizing for the deployment of HCL CDP in support of application deployment.
- 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 HCL CDP ExternalAPI

Context

This section provides detailed instructions on how to deploy HCL CDP External API using the Devtron in the AWS.

Prerequisites

Make sure to create cdp-externalapi secret in the AWS secret manager before deploying CDP External API.

To create cdp-externalapi secret in the AWS secret manager, follow the steps below:

Create a cdp-externalapi secret sample key and value, and update the actual values as shown below.
```
{
  "DbUrl": "jdbc:mariadb://<DB_HOST>:3307/vrm",
  "DbUsername": "<DB_USER>",
  "DbUserPassword": "<DB_PASSWORD>"
}
```
Update ConfigMaps data with actual values, and create required Kafka topics before deployment.

Steps

Navigate to the Devtron Chart Store, and select the cdp-externalapi chart to deploy.
Now, configure and deploy the cdp-externalapi charts.

In the YAML section, update the ConfigMap using the below details and deploy the chart.

ServerPort: "8080"

HibernateNaming: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
DbDriver: org.mariadb.jdbc.Driver
DbSQL: "true"
JpaHibernate: org.hibernate.dialect.MySQLDialect
HibernateDialect: innodb

DbConnectionTimeout: "30000"

LOG_LEVEL_APP: debug
LOG_LEVEL_ROOT: debug

fromEmailId: user@domain.com
alertToEmailId: user@domain.com

kmsBaseUrl: "<masked-kms-service-url>"
region: aps1

On successful deployment, validate the deployment as shown below.