Skip to main content
Kubernetes

Search

Cequence UAP Platform Kubernetes Deployment

© 2024 Cequence Security. All Rights Reserved.

Cequence UAP Platform Kubernetes Deployment

  • Updated on
  • ~ minute read
Download PDF

This page describes the steps to install the Cequence UAP Platform in a Kubernetes cluster.

Prerequisites

Below are the prerequisites for deployment of Cequence UAP Platform in Kubernetes (K8S) distributions.

Gitlab/Registry credentials

Credentials to pull down the image from the Cequence registry or custom registry need to be available before you start.

DNS records

Valid DNS domain with wildcard or individual entries for all services needs to be configured.

Internet access

It is recommended to have connectivity to the Internet during the installation process.

Cluster admin access

You need to have cluster admin access for the cluster in which you are installing UAP Platform.

Default storage class

A default storage class needs to be configured in the cluster in which you are installing UAP Platform.

Ingress controller

An ingress controller for the cluster is required. The preferred ingress controller is nginx. Valid certificates need to be configured for the ingress controller without which you will not be able to access the Cequence UAP deployment.

Note: OpenShift deployments come with a default ingress controller.

Download and Configure your Deployment

Step 1: Download the installer package provided by Cequence

The installer package contains shell scripts that will help you with the installation of Cequence UAP. Unzip the installer to the host machine from where the installation would be performed.

 

Step 2: Configure values in the config file

Navigate to the following folder:

cd utils/uap-installer/env

Edit the file "variable.properties". This file contains all the variables needed for installation. Most of these variables have default values already. The below tables describe the ones you need to review and edit, as needed.

 

Logging

Variable Name

Description

Default Values

DEBUG

Set it as true to enable the debug mode in shell script. This will show every statement that is being run while execution

false

Application variables

Name

Description

Default value

NAMESPACE

Defines the namespace in which UAP Platform is being installed

cequence

INGRESS_CLASS_NAME

Defines the ingress class name to use while creating ingress resources

nginx

IS_REDIS_REQUIRED

When set as true, the installer script goes ahead and installs Redis on the given cluster

true

IS_AIRFLOW_REQUIRED

When set as true, the installer script goes ahead and installs Airflow on the given cluster

false
IS_SPYDERUI_REQUIRED

When set as true, the installer script installs SpyderUI on the given cluster

false
IS_GIT_SYNC_REQUIRED

When set as true, the installer script sets git sync as true in the airflow override file.

false
LOAD_VERSION_FROM_CONSTANTS

If set true, you will need to update the versions in resources/constants.properties file.

It is required, when we need to install a custom version other than the latest version of charts

false
AIRFLOW_DATADOG_APIKEY

Defines the Datadog API key, which is used by airflow pods for reading data.

Installer script uses the value to create secret by the name - airflow-datadog-api-key

NA
CQPRIME_DATADOG_APIKEY

Defines the CQ Prime Datadog API key, which is used by airflow pods for reading data.

Installer script uses the value to create secret by the name - cqprime-datadog-api-key

NA

SUBDOMAIN

Defines the subdomain to be used while creating hostname for ingress resources

NA

REGISTRY

Defines custom registry that will be used for pulling images.

registry.gitlab.com

 

Install Cequence UAP Platform

Run the following commands to give the required permissions:

cd utils/uap-installer chmod +x ./uap-installer.sh chmod -R +x ./scripts/

After configuring the variables above, run uap-installer.sh using the following command: 

./uap-installer.sh
You will be prompted to provide the following inputs during the installation.

 

Cluster Type

You will be asked to select the type of cluster in which you are installing UAP Platform. Select one of the following:

  • Default (Rancher Kubernetes Engine)

  • OpenShift

  • Google Anthos

clustertype.png

Subdomain

If you did not specify the subdomain in the variables.properties file, the script will prompt you for it:

image-20240124-063124.png

example: rke2.subdomain.com

Ingress Creation

  • The script provides an option to either go with the default creation ingress resources or to create your own ingress resources manually.

  • If you select y then the script goes ahead and creates the ingress resources for handling the incoming ingress request to the cluster. It assumes that the cluster already has an ingress controller installed, preferably NGINX ingress controller

image-20231219-163515.png

Routes Creation

  • The script, provides an option to either go with the default creation routes resources or to create their own routes resources manually.

image-20231219-163809.png

 

Custom Storage Class Name

  • The script allows you to provide a custom storage class to be used instead of the default storage class.

  • You can provide the name and press enter to provide the storage class name or they can just skip it by pressing enter

image-20231219-163953.png

 

Cequence Repository Access

  • The script will prompt you to provide the credentials to download Docker images from the Cequence repository.

image-20240123-130504.png

Verify the inputs

  • Before, the script starts the installation. It shows all the inputed data by the user one last time so that the user is aware of what is provided and can opt to continue or provide the inputs again

  • The user can enter y continue with the installation or n to restart

finalsummary.png 

Validate the Deployment

Congratulations!! You have successfully installed Cequence UAP Platform in your cluster. Use the following commands to validate that the installation has been successful.

Ensure that the installation script indicates a successful deployment. You should get a screen like below.

image-20240129-100621.png

 

 

 

Was this article helpful?