Skip to content

Getting started

Sign in at app.ctrlplane.run with GitHub (during early access, new accounts wait for approval). Then choose Create control plane, or use the CLI:

Terminal window
brew install alperencelik/tap/ctrlplane
ctrlplane login
ctrlplane create dev --wait

dev becomes <you>-dev, and it’s ready in about a minute.

Point kubectl at your control plane:

Terminal window
ctrlplane use dev
kubectl get crds # empty for now

Prefer a plain kubeconfig? Download it from the site; see Access.

Install your operator’s CRDs, either in the site (API → Add CRDs: paste YAML, upload a file, or give a release URL) or with kubectl:

Terminal window
kubectl apply -f https://github.com/example/operator/releases/download/v1.0.0/crds.yaml

Under Controllers → Deploy a controller, give it a name and your operator’s image, for example ghcr.io/example/operator:v1.0.0. Or from your terminal, with your operator’s own Deployment:

Terminal window
ctrlplane deploy -f config/manager/manager.yaml

See Controllers.

Terminal window
kubectl apply -f my-resource.yaml
kubectl get <kind> -w

Your controller should start reconciling the resource. You can see its metrics and logs under Observability.