backstage custom resource

Purpose

Create and modify Backstage Custom Resources (CR) for the rhdh-operator. The rhdh-operator manages Red Hat Developer Hub (RHDH) deployments on Kubernetes/OpenShift using these CRs.

API Versions

Ask the user which version they need if not specified:

Consult references/v1alpha3-spec.md, references/v1alpha4-spec.md, or references/v1alpha5-spec.md for complete Go struct definitions and field documentation.

Workflow

1. Determine API version – Ask user or default to v1alpha5
2. Identify requirements – Database (local/external), Route, plugins, monitoring
3. Consult reference – Read the appropriate version spec from references/
4. Generate CR – Create valid YAML based on spec
5. Validate – Ensure referenced ConfigMaps/Secrets exist

Minimal CR

apiVersion: rhdh.redhat.com/v1alpha5
kind: Backstage
metadata:
  name: my-rhdh
  namespace: rhdh
spec:
  application: {}

Creates RHDH with local PostgreSQL, Route enabled, single replica.

Key Configuration Areas

Application

• appConfig.configMaps – App-config YAML files
• dynamicPluginsConfigMapName – Dynamic plugins ConfigMap
• extraEnvs – Environment variables from ConfigMaps/Secrets
• extraFiles – Files from ConfigMaps/Secrets/PVCs
• route – OpenShift Route with TLS

Database

• enableLocalDb: true – Operator-managed PostgreSQL (default)
• enableLocalDb: false + authSecretName – External database

Monitoring (v1alpha4+)

• monitoring.enabled: true – Prometheus metrics

Deployment

• deployment.kind – Deployment or StatefulSet (v1alpha5)
• deployment.patch – Strategic merge patch for workload

Reference Files

Consult these for complete field definitions:

• references/v1alpha3-spec.md – v1alpha3 Go structs and YAML mapping
• references/v1alpha4-spec.md – v1alpha4 with Monitoring
• references/v1alpha5-spec.md – v1alpha5 with Deployment kind

Example Files

• examples/backstage-cr.yaml – Common configuration patterns

External Resources

• rhdh-operator Repository
• RHDH Documentation