Helm Deployments

tags:

administration
installation
helm

Deploy Flex on Kubernetes using Helm charts. This guide walks you through the installation process step by step.

#Installation Flow

┌─────────────────────────────────────────────────────────────────┐
│  1. Choose Your Platform                                        │ 
│     └─> Set up your Kubernetes cluster                          │
├─────────────────────────────────────────────────────────────────┤
│  2. Configure Ingress                                           │
│     └─> Gateway API (recommended) or Nginx Ingress              │
├─────────────────────────────────────────────────────────────────┤
│  3. Set Up Database                                             │
│     └─> PostgreSQL (recommended) or MySQL                       │
├─────────────────────────────────────────────────────────────────┤
│  4. Install Flex                                                │
│     └─> Run helm install with your override.yaml                │
├─────────────────────────────────────────────────────────────────┤
│  5. Post-Installation                                           │
│     └─> Verify and configure using TUI                          │
└─────────────────────────────────────────────────────────────────┘

#Step 1: Choose Your Platform

Select your Kubernetes platform to get started:

Platform	Guide
Amazon EKS	Amazon EKS Setup
Google GKE	Google GKE Setup
Microsoft AKS	Microsoft AKS Setup
Local (Minikube/MicroK8s)	Local Setup
Rancher Marketplace	Rancher Setup (includes all steps)

#Step 2: Configure Ingress

After your cluster is ready, configure how traffic reaches Flex:

Ingress Setup Guide - Gateway API or Nginx Ingress

#Step 3: Set Up Database

Configure persistence storage:

Database Setup Guide - PostgreSQL or MySQL

#Step 4: Install Flex

Deploy the Helm chart:

Install Flex Guide

#Step 5: Post-Installation

Verify and configure your deployment:

Post-Installation Guide

#System Requirements

The resources may be set minimally to the below:

8-13 GB RAM based on the services deployed
8-11 CPU cores based on the services deployed
50GB hard-disk

Use the listing below for a detailed estimation of the minimum required resources. The table contains the default resources recommendation per service. Depending on the use of each service the resources need may be increase or decrease.

Service	CPU Unit	RAM	Disk Space	Processor Type	Required
Auth server	2.5	2.5GB	N/A	64 Bit	Yes
config - job	0.3	0.3GB	N/A	64 Bit	Yes on fresh installs
persistence - job	0.3	0.3GB	N/A	64 Bit	Yes on fresh installs
auth-key-rotation	0.3	0.3GB	N/A	64 Bit	No [Strongly recommended]
cleanup - job	0.3	0.3GB	N/A	64 Bit	No [Strongly recommended]
fido2	0.5	0.5GB	N/A	64 Bit	No
scim	1	1GB	N/A	64 Bit	No
nginx	1	1GB	N/A	64 Bit	No
config-api	1	1GB	N/A	64 Bit	No
casa	0.5	0.5GB	N/A	64 Bit	No
admin-ui	2	2GB	N/A	64 Bit	No
link	0.5	1GB	N/A	64 Bit	No
saml	0.5	1GB	N/A	64 Bit	No

Releases of images are in style 6.2.0 or x.y-z-1

#Helm Chart Reference

For all configuration options, see the Helm Chart Reference.

#Looking for Older Charts?

We maintain the last 5 versions. For older charts, build from the repository:

git clone --filter blob:none --no-checkout https://github.com/GluuFederation/flex.git /tmp/flex \
    && cd /tmp/flex \
    && git sparse-checkout init --cone \
    && git checkout v5.0.0 \
    && git sparse-checkout add charts/gluu \
    && cd charts/gluu \
    && helm dependency update \
    && helm package .