Web App Deployment

Installation Guide For The Web App Deployment

---

Overview

This document provides a detailed guide for deploying the LightBeam web app on a Kubernetes cluster.

---

Introduction

In some scenarios, we would like to manage everything on a single node setup, i.e., the web app and Spectra on the same node. For that purpose, the singleNode parameter is used.

What is Single-Node?

When singleNode is enabled in the system configuration, it allows the configuration to switch on an external IP for Kong, an API gateway, and assigns node ports for Kubernetes services. This functionality is crucial for properly tracking the IP address of incoming requests in the framework of cookie consent.

Without the singleNode feature being enabled, the Kubernetes port forward could mask the original IP and assign an internal IP to the Kong proxy service instead.

Installation Guide

Make sure that you have Helm, a package manager for Kubernetes, and Git installed before starting.

1. Clone the project repository:

git clone https://github.com/lightbeam/lightbeam-chart.git

1. Navigate to the lightbeam-chart directory:

cd lightbeam-chart

1. Update the following variables in lightbeam-chart/charts/lightbeam-web-portal/values.yaml

1. lightbeamGatewayAuth:
- endpoint: Lightbeam Spectra endpoint.  
- username: Lightbeam Spectra username.
- password: Lightbeam Spectra password.

2. lightbeamWeb:
- url: Specifies the server URL where the Lightbeam web app interface will be hosted.
- lightbeamWebUniqueID: A field to provide any unique identifier for your particular deploy of Lightbeam.
- singleNode:
  - enabled: Indicates whether deployment is taking place on a single-node setup.
  - httpNodePort: HTTP port to use in single-node setup. Should be same as specified in the 'url'.
  - httpsNodePort: HTTPS port to use in a single-node setup for secure web communication. Any available port in the range from 30000 to 32767 can be used.
  - externalIP: The IP address of the node. This should be the same IP address used in the 'url'.

1. Install the Helm chart:

helm install lightbeam-web charts/lightbeam-web-portal/ --namespace lightbeam-web --create-namespace

Required Configuration

You must navigate to the values.yaml located in your lightbeam-chart folder and set the following configurations for singleNode:

lightbeamWeb:
  singleNode:
    enabled: true  # Enable single-node setup
    httpNodePort:  # Port to be used by the http service
    httpsNodePort:  # Port to be used by the https service
    externalIP:   # The external IP address on which the app will be accessed 

# More config options...

After deployment, your LightBeam web portal will be available at the specified externalIP and the specified httpNodePort.

---

About LightBeam

LightBeam automates Privacy, Security, and AI Governance, so businesses can accelerate their growth in new markets. Leveraging generative AI, LightBeam has rapidly gained customers’ trust by pioneering a unique privacy-centric and automation-first approach to security. Unlike siloed solutions, LightBeam ties together sensitive data cataloging, control, and compliance across structured and unstructured data applications providing 360-visibility, redaction, self-service DSRs, and automated ROPA reporting ensuring ultimate protection against ransomware and accidental exposures while meeting data privacy obligations efficiently. LightBeam is on a mission to create a secure privacy-first world helping customers automate compliance against a patchwork of existing and emerging regulations.

For any questions or suggestions, please get in touch with us at: [email protected].