LogoLogo
Kadeck DocumentationSubmit Ticket
  • Platform overview
  • Deployment
  • API Reference
  • Platform updates
  • Introduction
  • Context & Scope
  • Interoperability & Network
  • System Requirements
  • Configuration List
  • Deployments
    • Overview
    • Basic Setup
    • Advanced Setup
    • Automated Deployment
    • Identity Provider Integration
    • License Activation Scenarios
  • FAQs
    • How do I create a certificate and keystore?
  • How do I access the container images?
  • How to make container images offline available?
  • How do I configure the memory for Portal?

Legal

  • Legal Notice
  • Privacy Policy

© 2025 Xeotek Inc. and its affiliates

On this page
  • Overview of Cluster Architecture
  • Master Node Configuration
  • 1. Define the Master Nodes
  • 2. Configure Each Master Node
  • Auto-Scaling Node Configuration
  • Best Practices for Cluster Deployments
  • Example Cluster Configuration Summary
  • Key Environment Variables for Cluster Mode

Was this helpful?

Export as PDF
  1. Deployments

Advanced Setup

For production environments requiring high availability (HA) and horizontal scalability, the Data Streamhouse Portal can be deployed as a cluster.

This configuration ensures:

  • No single point of failure

  • Continuous availability even during node failures

  • Dynamic scaling of additional Portal instances


Overview of Cluster Architecture

A Portal cluster consists of:

  • Master Nodes — Static nodes responsible for maintaining cluster stability and coordination.

  • Auto-Scaling Nodes — Dynamic instances that join the cluster at runtime to handle additional load.


Master Node Configuration

Master nodes form the backbone of the cluster. At least three master nodes are recommended to tolerate up to two simultaneous failures.

1. Define the Master Nodes

Decide which instances will act as masters. Example configuration:

Node
Hostname
Port

Portal-1

portal-1

2551

Portal-2

portal-2

2552

Portal-3

portal-3

2553

All master nodes must know about each other.

2. Configure Each Master Node

Set the following environment variables on each master:

Example: Portal-1

DSH_PORTAL_CLUSTER_NODES=portal-1:2551,portal-2:2552,portal-3:2553
DSH_PORTAL_CLUSTER_HOSTNAME=portal-1
DSH_PORTAL_CLUSTER_PORT=2551

Example: Portal-2

DSH_PORTAL_CLUSTER_NODES=portal-1:2551,portal-2:2552,portal-3:2553
DSH_PORTAL_CLUSTER_HOSTNAME=portal-2
DSH_PORTAL_CLUSTER_PORT=2552

Example: Portal-3

DSH_PORTAL_CLUSTER_NODES=portal-1:2551,portal-2:2552,portal-3:2553
DSH_PORTAL_CLUSTER_HOSTNAME=portal-3
DSH_PORTAL_CLUSTER_PORT=2553

Important: All masters must list the same DSH_PORTAL_CLUSTER_NODES. Hostnames must resolve correctly inside the Kubernetes cluster or network.


Auto-Scaling Node Configuration

Once the master nodes are stable, you can dynamically launch additional Portal instances to scale horizontally.

Auto-scaling nodes need only one configuration:

DSH_PORTAL_CLUSTER_NODES=portal-1:2551,portal-2:2552,portal-3:2553

When an auto-scaling node comes online:

  • It contacts the master nodes.

  • Registers itself into the cluster.

  • Receives the full cluster membership list through gossiping.

There is no need to manually configure DSH_PORTAL_CLUSTER_HOSTNAME or DSH_PORTAL_CLUSTER_PORT for auto-scaling nodes; these are determined automatically at runtime.


Best Practices for Cluster Deployments

  • Use fully qualified domain names (FQDNs) for all node references in DSH_PORTAL_CLUSTER_NODES.

  • Run an odd number of master nodes to optimize cluster quorum and failover (typically 3, 5, or 7).

  • Distribute master nodes across availability zones (if in a cloud environment) for maximum resilience.

  • Configure resource requests/limits properly to ensure predictable capacity.

  • Monitor cluster health through Portal’s /health endpoint and external monitoring systems.

  • Test node failures regularly to verify failover behavior and cluster stability.


Example Cluster Configuration Summary

Node Type
Environment Variables Example

Master Node

Set DSH_PORTAL_CLUSTER_NODES, DSH_PORTAL_CLUSTER_HOSTNAME, DSH_PORTAL_CLUSTER_PORT

Auto-Scaling Node

Set DSH_PORTAL_CLUSTER_NODES only


Key Environment Variables for Cluster Mode

Variable
Description

DSH_PORTAL_CLUSTER_NODES

Comma-separated list of all master nodes (host:port)

DSH_PORTAL_CLUSTER_HOSTNAME

Hostname of the node (masters only)

DSH_PORTAL_CLUSTER_PORT

Port for cluster communication (masters only)

PreviousBasic SetupNextAutomated Deployment

Last updated 1 month ago

Was this helpful?