Skip to content

Requirements

System Requirements

RequirementVersion
Node.js>= 22
Yarn>= 3 (uses Corepack)

Enabling Corepack

This project uses Yarn 3 with Corepack. Enable it with:

bash
corepack enable

Required CLI Tools

The following binaries must be installed and available in your PATH:

ToolPurpose
ocOpenShift CLI for cluster operations
kubectlKubernetes CLI (used as fallback)
helmHelm CLI for chart deployments

Installing CLI Tools

OpenShift CLI (oc)

bash
# macOS
brew install openshift-cli

# Linux
curl -LO https://mirror.openshift.com/pub/openshift-v4/clients/ocp/latest/openshift-client-linux.tar.gz
tar xvzf openshift-client-linux.tar.gz
sudo mv oc /usr/local/bin/

Helm

bash
# macOS
brew install helm

# Linux
curl https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3 | bash

OpenShift Cluster Requirements

You must be logged into an OpenShift cluster with sufficient permissions to:

PermissionResource
Create/DeleteNamespaces
Create/UpdateConfigMaps
Create/UpdateSecrets
Create/ReadRoutes
InstallHelm charts
InstallRHDH Operator (if using operator method)
ReadCluster ingress configuration

Logging into OpenShift

bash
# Using token
oc login --server=https://api.your-cluster.com:6443 --token=your-token

# Using username/password
oc login --server=https://api.your-cluster.com:6443 -u username -p password

Verifying Cluster Access

bash
# Check cluster connection
oc whoami

# Check permissions
oc auth can-i create namespace
oc auth can-i create secret
oc auth can-i create configmap

RHDH Requirements

ComponentDescription
RHDH VersionSet via RHDH_VERSION environment variable (e.g., "1.5")
Helm ChartDefault: oci://quay.io/rhdh/chart (customizable via CHART_URL)

Keycloak Requirements (Optional)

If using Keycloak authentication:

ComponentDescription
Namespacerhdh-keycloak (default)
Helm ChartBitnami Keycloak chart
StoragePersistentVolumeClaim for Keycloak data

Resource Requirements

Minimum cluster resources for running tests:

ComponentCPUMemory
RHDH1 core2Gi
Keycloak0.5 core1Gi
PostgreSQL (for Keycloak)0.25 core512Mi

Network Requirements

RequirementDescription
OpenShift RoutesMust be accessible from test runner
Ingress DomainAutomatically detected from cluster
HTTPSRoutes use cluster's default TLS

Environment Variables

Required

VariableDescriptionExample
RHDH_VERSIONRHDH version to deploy"1.5"
INSTALLATION_METHODDeployment method"helm" or "operator"

Optional

VariableDescriptionDefault
SKIP_KEYCLOAK_DEPLOYMENTSkip Keycloak auto-deploymentfalse
CHART_URLCustom Helm chart URLoci://quay.io/rhdh/chart
CIIf set, enables auto-cleanup-

Next Steps

Released under the Apache-2.0 License.