examples/

Orkestra Examples

A progressive set of examples — from a single Deployment to a multi-source Komposer with admission policy and Go hooks. Each example is complete and runnable. Each builds on the concepts introduced by the previous one.

Learning path

Beginner — ork run

Start here. No cluster setup required beyond a CRD and the ork CLI.

Intermediate — ork run

You know the basics. Now use more of Orkestra's surface.

Advanced — kubectl apply

Production deployment. Admission policy, registry composition, Go hooks, custom reconcilers.

Prerequisites

All examples require:

• A running Kubernetes cluster (kind, minikube, or remote)
• kubectl configured
• ork installed: brew install orkspace/tap/ork

Advanced examples additionally require:

• Orkestra deployed in-cluster: see Deployment Guide
• ENABLE_ADMISSION_WEBHOOK=true for validation/mutation examples
• Go 1.22+ for hook and constructor examples

How to use these examples

Each example directory contains:

example-name/
  README.md         step-by-step walkthrough
  crd.yaml          the CRD to install
  katalog.yaml      the operator definition
  cr.yaml           the custom resource to apply
  cleanup.sh        removes everything the example created

Advanced examples may also include:

  komposer.yaml         Komposer configuration
  hooks/                Go hook implementation
  install-xx-.yaml      in-cluster Orkestra deployment

Run chmod +x cleanup.sh before running cleanup.