my-pattern/
├── charts/
├── common/
├── pattern-metadata.yaml
├── pattern.sh
├── values-global.yaml
└── values-prod.yamlPattern metadata
Every Validated Patterns pattern repository includes a pattern-metadata.yaml file at the repository root.
This file is the source of truth for pattern identity, cluster sizing, tier information, and links.
Downstream systems read this file to discover patterns, validate metadata, and render information in the Red Hat Hybrid Cloud Console, on validatedpatterns.io, and in quality engineering (QE) workflows.
If you are contributing a new pattern or updating an existing one, maintain this file in your pattern repository.
Do not edit the generated metadata modules in the validatedpatterns/docs repository by hand.
Where the file lives
Place pattern-metadata.yaml in the top-level directory of your pattern Git repository, alongside files such as values-global.yaml, Makefile, and pattern.sh.
A typical pattern repository includes the metadata file in this layout:
For more information about repository layout, see Validated pattern structure.
Who consumes pattern metadata
Three systems consume pattern-metadata.yaml, each with different expectations:
| Consumer | Purpose |
|---|---|
Fetches metadata from pattern repositories, normalizes it, validates it against a JSON schema, and publishes a static catalog image for the Validated Patterns Operator console plugin. | |
validatedpatterns.io documentation | Syncs metadata into cluster sizing pages through GitHub Actions and |
QE and CI tooling | Uses links, tier, and sizing data for test planning and CI dashboard integration. |
The Red Hat Hybrid Cloud Console does not read pattern-metadata.yaml from your Git repository directly.
The console plugin reads normalized pattern.yaml files from the catalog image that the operator deploys on-cluster.
In this section
Metadata and the UI catalog — Source and catalog formats, catalog discovery, and fields the console renders.
Metadata and documentation — Docs site sync, Hugo frontmatter alignment, and the metadata GitHub Actions workflow.
Schema and field reference — JSON schema, required and optional fields, and per-field descriptions.
Example metadata files — Minimal, GPU, and multi-cloud hub/spoke examples.
Validation and troubleshooting — Schema validation, inclusion rules, and common errors.
Next steps
Create or extend a pattern with Creating a pattern or Creating a pattern with patternizer.
Install patterns through the UI with Using the Validated Patterns Operator.
Learn about pattern tiers in Sandbox tier requirements and Tested tier requirements.
