User Guide Overview

Dynamic Plugins Overlay Repository - User Guide

This guide covers the essential workflows for using the rhdh-plugin-export-overlays repository to export, maintain, and publish dynamic plugins for Backstage-based platforms.

Table of Contents

Document	Description
01 - Getting Started	Core concepts, repository structure, and prerequisites
02 - Export Tools	Using the dynamic plugins export tools and CLI
03 - Plugin Owner Responsibilities	Ownership model and maintenance obligations
04 - Metadata Synchronization	Keeping source and overlay metadata in sync
05 - Version Updates	Updating Backstage target/minimum versions
06 - Patch Management	Creating, updating, and retiring patches
07 - Plugin Catalog Index	How the catalog index is built, published, and monitored
08 - Creating Release Branches	Admin runbook for cutting release-x.y from main

---

Quick Reference

Key Repository Files

Path	Purpose
versions.json	Target Backstage version, Node version, CLI version
plugins-regexps	Auto-discovery scope patterns
workspaces/[name]/source.json	Source repo URL, ref, and Backstage version (Model A: overlay build)
workspaces/[name]/plugins-list.yaml	Plugin paths and export arguments
workspaces/[name]/metadata/*.yaml	Package entity definitions
workspaces/[name]/patches/*.patch	Unified diff patches
workspaces/[name]/plugins/[plugin]/	Plugin-specific overlays
catalog-entities/extensions/plugins/*.yaml	Plugin catalog listing entities (Model A and Model B / catalog-only; PM approval required for curated catalog tiers)
catalog-entities/extensions/collections/*.yaml	Collection groupings (required only if PM approved)
rhdh-community-packages.txt / rhdh-supported-packages.txt	Curated Optional Extras / Supported Plugins catalog tier lists (required only if PM approved; support level is in metadata YAML)
default.packages.yaml	GA packages under enabled: / disabled: (required only if PM approved; GA only)

Common Workflows

Task	Start Here
Add a new plugin (overlay export)	01 - Getting Started
Catalog-only plugin (external OCI build)	03 - Plugin Owner Responsibilities
Update plugin version	05 - Version Updates
Fix build failure	02 - Export Tools
Sync metadata	04 - Metadata Synchronization
Create/update a patch	06 - Patch Management
Create a release branch from main	08 - Creating Release Branches
Check branch workspace status reports	Workspace Status Reports

---

Current Versions

Component	Version
Backstage	1.54.9
Node.js	24.19.0
CLI	@red-hat-developer-hub/cli@2.1.0

🔄 Auto-generated when synced to wiki

---

Prerequisites

• Git with access to this repository
• Node.js version 24.19.0 (or as specified in versions.json)
• GitHub CLI (gh) for workflow triggers
• Basic understanding of Backstage plugin architecture