Deployment Overview

The package provides comprehensive deployment capabilities for RHDH and Keycloak to OpenShift clusters.

Deployment Architecture

┌─────────────────────────────────────────────────────────────┐
│                    OpenShift Cluster                         │
│                                                              │
│  ┌─────────────────────────┐  ┌─────────────────────────┐   │
│  │   RHDH Namespace        │  │  Keycloak Namespace     │   │
│  │   (e.g., my-plugin)     │  │  (rhdh-keycloak)        │   │
│  │                         │  │                         │   │
│  │  ┌──────────────────┐   │  │  ┌──────────────────┐   │   │
│  │  │ RHDH Deployment  │   │  │  │ Keycloak         │   │   │
│  │  │ or Backstage CR  │   │  │  │ StatefulSet      │   │   │
│  │  └──────────────────┘   │  │  └──────────────────┘   │   │
│  │                         │  │                         │   │
│  │  ┌──────────────────┐   │  │  ┌──────────────────┐   │   │
│  │  │ ConfigMaps       │   │  │  │ PostgreSQL       │   │   │
│  │  │ - app-config     │   │  │  │ StatefulSet      │   │   │
│  │  │ - dynamic-plugins│   │  │  └──────────────────┘   │   │
│  │  └──────────────────┘   │  │                         │   │
│  │                         │  │  ┌──────────────────┐   │   │
│  │  ┌──────────────────┐   │  │  │ Routes           │   │   │
│  │  │ Secrets          │   │  │  │ - keycloak       │   │   │
│  │  │ - rhdh-secrets   │   │  │  └──────────────────┘   │   │
│  │  └──────────────────┘   │  │                         │   │
│  │                         │  └─────────────────────────┘   │
│  │  ┌──────────────────┐   │                                │
│  │  │ Routes           │   │                                │
│  │  │ - backstage      │   │                                │
│  │  └──────────────────┘   │                                │
│  └─────────────────────────┘                                │
└─────────────────────────────────────────────────────────────┘

Deployment Methods

Helm Deployment

Deploy RHDH using the official Helm chart:

await rhdh.configure({
  method: "helm",
  valueFile: "tests/config/values.yaml",
});
await rhdh.deploy();

Learn more about Helm Deployment →

Operator Deployment

Deploy RHDH using the RHDH Operator:

await rhdh.configure({
  method: "operator",
  subscription: "tests/config/subscription.yaml",
});
await rhdh.deploy();

Learn more about Operator Deployment →

Authentication Providers

Guest Authentication

Simple authentication for development and testing:

await rhdh.configure({ auth: "guest" });

Keycloak Authentication

OIDC authentication via Keycloak:

await rhdh.configure({ auth: "keycloak" });

Learn more about Authentication →

Deployment Lifecycle

1. Configure

Set deployment options before deploying:

await rhdh.configure({
  version: "1.5",
  method: "helm",
  auth: "keycloak",
  appConfig: "tests/config/app-config.yaml",
  secrets: "tests/config/secrets.yaml",
  dynamicPlugins: "tests/config/plugins.yaml",
});

2. Deploy

Deploy RHDH to the cluster:

await rhdh.deploy();

This:

1. Creates the namespace
2. Injects plugin metadata into dynamic plugins
3. Applies ConfigMaps
4. Applies Secrets (with env substitution)
5. Installs RHDH (Helm or Operator)
6. Waits for deployment to be ready

3. Access

Access the deployed RHDH instance:

const url = rhdh.rhdhUrl;
const namespace = rhdh.deploymentConfig.namespace;

4. Update (Optional)

Update configuration during tests:

// Apply new configs
await rhdh.rolloutRestart();

5. Cleanup

Delete resources after tests (automatic in CI):

await rhdh.teardown();

Configuration Merging

Configurations are merged in layers:

1. Common configs - Base configurations
2. Auth configs - Provider-specific configs
3. Project configs - Your custom configs

Package defaults      → auth/guest/     → Your configs
                      → auth/keycloak/  →
                      → auth/github/    →

Later configurations override earlier ones, allowing you to customize only what you need.

In This Section

• RHDH Deployment - RHDHDeployment class
• Keycloak Deployment - KeycloakHelper class
• Helm Deployment - Helm-specific guide
• Operator Deployment - Operator-specific guide
• Orchestrator Deployment - installOrchestrator script
• Authentication - Auth providers