ork generate registry

1 min read

Generate the runtime registry file used by typed operators.

ork generate registry --file <file> [flags]

This command produces:

  • pkg/runtime/zz_generated_runtime_registry.go
  • containing RegisterRuntimeObjects() and RegisterScheme()
  • for all enabled CRDs with reconciler.default: false

It is required whenever you use typed CRDs, Go hooks, or custom constructors.

Flags

FlagDescription
-k, --file <file>One or more Katalog files (comma‑separated or repeated)
--dry-runPrint generated output without writing files
-o, --output <file>(Ignored — registry always writes to the runtime package)
-n, --namespace <name>Namespace (not used by registry generation)

Usage

Generate the registry from a single Katalog:

ork generate registry --file katalog.yaml

Multiple Katalogs:

ork generate registry --file a.yaml --file b.yaml

Comma‑separated:

ork generate registry --file a.yaml,b.yaml

Dry‑run:

ork generate registry --file katalog.yaml --dry-run

When Required

SituationRequired
Dynamic templates onlyNo
Hooks declaredYes
Typed CRDsYes
Custom constructorsYes
Using Orkestra as a pure dynamic operatorNo

Behavior

  • Merges one or more Katalog files.
  • Validates the merged Katalog.
  • Selects all CRDs with reconciler.default: false.
  • Generates:
    • type registrations
    • scheme registrations
    • runtime object constructors
  • Writes to pkg/runtime/zz_generated_runtime_registry.go (idempotent).