ork generate
Generate Orkestra components from one or more Katalog files.
ork generate <command> [flags]
The generate command group contains tools for producing CRDs, example CRs, runtime registries, documentation, dashboards, RBAC, ConfigMaps, installation bundles, and more.
Each generator reads one or more katalog.yaml files, merges them, and produces the requested artifacts.
Available Commands
| Command | Description |
|---|---|
| katalog | Scaffold a starter katalog.yaml for a new operator |
| crd | Generate Kubernetes CRDs from a Katalog |
| cr | Generate example CustomResources for a CRD |
| registry | Generate zz_generated_runtime_registry.go for typed operators |
| docs | Generate Markdown documentation for all CRDs (in development) |
| dashboards | Generate Grafana dashboards for all CRDs (in development) |
| rbac | Generate a minimal ClusterRole based on the Katalog |
| configmap | Generate a ConfigMap embedding a Katalog or Komposer |
| bundle | Generate a complete installation bundle (RBAC + ConfigMap) |
| all | Run all generators (registry, docs, dashboards) |
Shared Flags
Most generate subcommands support:
| Flag | Description |
|---|---|
-k, --file <file> | One or more Katalog files (comma‑separated or repeated) |
-o, --output <path> | Write output to file or directory |
-n, --namespace <name> | Namespace for generated manifests (default: orkestra-system) |
--dry-run | Print output to stdout without writing files |