Welcome
Installation
Learn more about HCL Detect installation and deploying core components of the product.
Installing HCLDetect on OpenShift
Prerequisites

Getting Started
Welcome to the documentation for HCL Detect, where you can find information about how to install, maintain, and use this service.
Installation
Learn more about HCL Detect installation and deploying core components of the product.
Administration
Learn about how to configure, manage, and maintain HCL Detect environments. It includes details on system setup, user management, and permissions, ensuring seamless operation and efficient deployment of your continuous delivery processes.
Working with Platform
The section provides comprehensive instructions for creating, configuring, and managing marketing events. It covers topics such as defining audience conditions, setting up triggers, deploying events, and tracking their performance. Additionally, this section includes explanations of key terminology and offers advanced options to optimize event management.
Extending Platform
This section guides developers on customizing and extending Detect solutions. It covers the solution's folder structure, configuration files, integration methods, and provides insights into the Detect Expression Language and its built-in functions.
Platform Data Model
This section provides detailed information about the internal tables used within the Detect module. It includes descriptions of each table's structure, purpose, and relationships, aiding administrators and developers in understanding and managing the underlying database schema effectively.
PDF

Prerequisites

Before you begin the installation process, ensure that the following prerequisites are met:

Software Requirements

Software Type	Requirement
Operating System	Red Hat Enterprise Linux 8
Database	MariaDB 10.6
Kubernetes	Kubernetes Version 1.21 and above
Container	Docker Version 20.10.7 and above
Package Manager	Helm Version 3
Container Platform	OpenShift Container Platform (OCP) 4.8
Distributed Event Streaming Platform	Apache Kafka 3.8.1

Hardware Requirements

The minimum hardware requirements for HCL Detect are as follows

Hardware Type	Requirement
OpenShift Kubernetes Cluster	10 CPUs with 16GiB of memory
Virtual Machine	Minimum 8 CPUs with 16GB RAM and 200GB disk
Ports required to access between Cluster and VM	80, 443, 2181, 2182, 2183, 3306, 8010, 8081, 9092, 9093, 9094, and range 32768-42769
OpenShift Storage for PVC	As required

There are two parts of the deployment:

Micro services based components, to be deployed on containerization platform. Here, Red Hat OpenShift is the choice of the Container orchestration platform.
VM based deployment.

Before proceeding with the installation of the required components, you have to ensure that Red Hat OpenShift is installed and properly configured. Refer to the Red Hat OpenShift documentation for installation guidelines.

Also, below tools are expected to present in the deployment to facilitate the installation:

OpenShift CLI ("oc" command)
Kubernetes command line tool ("kubectl" command)
Helm CLI tool ("helm" command)

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.