RHDHDeployment

Class for managing RHDH deployments in OpenShift.

Import

import { RHDHDeployment } from "rhdh-e2e-test-utils/rhdh";

Constructor

new RHDHDeployment(namespace: string)

Parameter	Type	Description
namespace	string	Kubernetes namespace for deployment

Properties

rhdhUrl

get rhdhUrl(): string

The URL of the deployed RHDH instance.

deploymentConfig

get deploymentConfig(): DeploymentConfig

Current deployment configuration. See Deployment Types.

k8sClient

get k8sClient(): KubernetesClientHelper

Kubernetes client instance for direct cluster operations.

Methods

configure()

async configure(options?: DeploymentOptions): Promise<void>

Configure deployment options and create namespace.

Parameter	Type	Description
options	DeploymentOptions	Optional deployment configuration

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

deploy()

async deploy(): Promise<void>

Deploy RHDH to the cluster. This:

1. Merges configuration files
2. Applies ConfigMaps and Secrets
3. Installs RHDH via Helm or Operator
4. Waits for deployment to be ready

await rhdh.deploy();

waitUntilReady()

async waitUntilReady(timeout?: number): Promise<void>

Wait for RHDH deployment to be ready.

Parameter	Type	Default	Description
timeout	number	300000	Timeout in milliseconds

await rhdh.waitUntilReady(600000); // 10 minutes

rolloutRestart()

async rolloutRestart(): Promise<void>

Restart the RHDH deployment.

await rhdh.rolloutRestart();

scaleDownAndRestart()

async scaleDownAndRestart(): Promise<void>

Scale down to 0, then back to 1 replica.

await rhdh.scaleDownAndRestart();

teardown()

async teardown(): Promise<void>

Delete the namespace and all resources.

await rhdh.teardown();

Example

import { RHDHDeployment } from "rhdh-e2e-test-utils/rhdh";

const rhdh = new RHDHDeployment("my-namespace");

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",
  valueFile: "tests/config/values.yaml",
});

await rhdh.deploy();

console.log(`RHDH deployed at: ${rhdh.rhdhUrl}`);

// After tests
await rhdh.teardown();