Skip to content

Helm chart for initial configuration of gluu server

Notifications You must be signed in to change notification settings

udbhav-hbk/gluu-server-helm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Note:
For minikube, Specs used to test the charts are. 3GB RAM and 40GB memory.

Gluu Server

Gluu server is an open-source IAM server that sync backend identities, leverage external IDPs, and achieve SSO, 2FA and more.

TL;DR;

helm install beta/gluu

Introduction

This chart bootstraps a Gluu Server deployment on a kubernetes cluster using Helm package manager.
It also packages other components/services that make up Gluu Server.

Prerequisites

  • kubernetes 1.5+
  • PV provisioner support in the underlying infrastructure

installing the chart

To install the chart with the release name my-release:

$ helm install --name my-release

The command deploys Gluu Server on kubernetes cluster using the default configurations. The configuration section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete my-release deployment:

$ helm delete my-release

If during installation the release was not defined, release name is checked by running $ helm ls then deleted using the previous command and the default release name.

Configuration

Parameter Description Default
global.namespace namespace in which to deploy the server default
global.serviceName ldap service name. Used to connect other services to ldap opendj
global.nginxIp DNS IP address to be used 192.168.99.100
global.oxAuthServiceName oxauth service name - should not be changed oxauth
global.oxTrustSeriveName oxtrust service name - should not be changed oxtrust
global.domain DNS domain name demoexample.gluu.org
global.gluuLdapUrl wrends/ldap server url. Port and service name of opendj server - should not be changed opendj:1636
global.gluuMaxFraction Controls how much of total RAM is up for grabs in containers running Java apps 1
global.configAdapterName The config backend adapter kubernetes
global.configSecretAdapter The secrets adapter kubernetes
config.enabled Either to install config chart or not. true
config.orgName Organisation Name Gluu
config.email Email to be registered with ssl support@gluu.org
config.adminPass Admin password to log in to the UI P@ssw0rd
config.domain FQDN demoexample.gluu.org
config.countryCode Country code of where the Org is located US
config.state State UT
config.ldapType Type of LDAP server to use. opendj
oxauth.enabled Whether to allow installation of oxauth subchart. Should be left as true true
opendj.enabled Allow installation of ldap Should left as true true
opendj.gluuCacheType Which type of cache to use.2 options REDIS or NATIVE_PERSISTENCE If REDIS is used redis chart must be enabled and gluuRedisEnabled config set to true NATIVE_PERSISTENCE
opendj.gluuRedisEnabled Used if cache type is redis false
redis.enabled Whether to allow installation of redis chart. false
shared-shib.enabled Allow installation of shared volumes. They are shared between oxtrust and oxshibboleth services. true
oxtrust.enabled Allow installation of oxtrust true
nginx.enabled Allow installation of nginx. Should be allowed unless another nginx is being deployed true
oxshibboleth.enabled Allow oxshibboleth installation false
oxpassport.enabled Allow oxpassport installation false
key-rotation.enabled Allow key rotation false
cr-rotate.enabled Allow cache rotation deployment false
radius.enabled Enabled radius installation false

Instruction on how to different services

The recommended way to install the chart with custom values is to specify a values.yaml file with the required values.

Tip! The default values.yaml

Passport

Because by default oxpassport is disabled and needs to configured before it can be used. There are 2 different ways to enable oxpassport.

  • Method 1: Setting oxpassport.enabled to true before installation, then configuring it on the UI. Kubernetes will restart the pod untill the it detects that passport has been enabled. To enable it on the UI follow these instructions.
  1. Login to the UI and navigate to Configuration -> Organization Configuration -> System Configuration and check Scim Support and Passport Support the click Update button on the bottom left.

  2. Navigate to Configuration -> Manage Custom Scripts -> Person Authentication -> passport_social. Check enabled and click Save at the top right of the screen.

  3. Navigate to Configuration -> Manage Custom Scripts -> UMA RPT Policies -> scim_access_policy. Enable it by checking the box and clicking Save.

  • Method 2: Installing the required services. Enabling installation of oxpassport and upgrading helm installation through,
    helm upgrade --install RELEASE-NAME . then following the above instructions.

Redis

To enable usage of Redis change the following values.

opendj:
  enabled: true
  # options REDIS/NATIVE_PERSISTENCE
  gluuCacheType: REDIS
  # options true/false : must be enabled if cache type is REDIS
  gluuRedisEnabled: true

# redis should be enabled only when cacheType is REDIS
redis:
  enabled: true

tags:
  redis: true

Note: redis.enabled will always override the value in tags.redis

Other optional services

Other optional services like key-rotation, cr-rotation ... are enabled by setting their coresponding values to true.
For example, to enable cr-rotate use

cr-rotate:
  enabled: true

About

Helm chart for initial configuration of gluu server

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published