Getting started
1. Create a control plane
Section titled “1. Create a control plane”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:
brew install alperencelik/tap/ctrlplanectrlplane loginctrlplane create dev --waitdev becomes <you>-dev, and it’s ready in about a minute.
2. Connect kubectl
Section titled “2. Connect kubectl”Point kubectl at your control plane:
ctrlplane use devkubectl get crds # empty for nowPrefer a plain kubeconfig? Download it from the site; see Access.
3. Add your API types (CRDs)
Section titled “3. Add your API types (CRDs)”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:
kubectl apply -f https://github.com/example/operator/releases/download/v1.0.0/crds.yaml4. Deploy your controller
Section titled “4. Deploy your controller”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:
ctrlplane deploy -f config/manager/manager.yamlSee Controllers.
5. Create a resource
Section titled “5. Create a resource”kubectl apply -f my-resource.yamlkubectl get <kind> -wYour controller should start reconciling the resource. You can see its metrics and logs under Observability.
- Controllers need to reach your own network?: turn on a tunnel.
- Build your own dashboards: use the data in Grafana.