Installation

Installing RBG to a Kubernetes Cluster

Prerequisites

• A Kubernetes cluster with version >= 1.28 is Required, or it will behave unexpected.
• Kubernetes cluster has at least 1 node with 1+ CPUs and 1G of memory available for the RoleBasedGroup controller manager Deployment to run on.
• The kubectl command-line tool has communication with your cluster. Learn how to install the Kubernetes tools.

Install a released version

Install by kubectl

kubectl apply --server-side -f ./deploy/kubectl/manifests.yaml

To wait for RoleBasedGroup controller to be fully available, run:

kubectl wait deploy/rbgs-controller-manager -n rbgs-system --for=condition=available --timeout=5m

Install by Helm

The Helm chart includes a CRD Upgrader Job that automatically installs/upgrades CRDs during installation and upgrade. This is enabled by default.

helm upgrade --install rbgs deploy/helm/rbgs \
    --create-namespace \
    --namespace rbgs-system \
    --wait

Or use the Makefile shortcut:

make helm-deploy

CRD Upgrader Configuration

Parameter	Description	Default
crdUpgrade.enabled	Enable CRD Upgrader Job	true
crdUpgrade.image.repository	CRD Upgrader image repository	rolebasedgroup/rbgs-upgrade-crd
crdUpgrade.image.tag	CRD Upgrader image tag	Same as controller.image.tag
crdUpgrade.ttlSecondsAfterFinished	Job TTL after completion	259200 (3 days)
crdUpgrade.tolerations	Pod tolerations	[{operator: Exists}]
crdUpgrade.nodeSelector	Pod node selector	{}

Manual CRD Installation (Alternative)

If you prefer to manage CRDs manually:

1. Install CRDs:

kubectl apply --server-side -f config/crd/bases/

1. Install Controller via Helm with CRD Upgrader disabled:

helm upgrade --install rbgs deploy/helm/rbgs \
    --create-namespace \
    --namespace rbgs-system \
    --set crdUpgrade.enabled=false \
    --wait

Uninstall

To uninstall RoleBasedGroup installed via kubectl:

kubectl delete -f ./deploy/kubectl/manifests.yaml

To uninstall RoleBasedGroup installed via Helm:

# Uninstall controller (CRDs are preserved)
helm uninstall rbgs --namespace rbgs-system

# Optional: Delete CRDs (WARNING: this will delete all RoleBasedGroup/InstanceSet resources)
kubectl delete -f config/crd/bases/

Or use the Makefile shortcuts:

make helm-undeploy    # Uninstall controller only
make uninstall-crds   # Delete CRDs (use with caution)