diff --git a/README.md b/README.md index 7932765f1..0abc71387 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,19 @@ Then run it pointing to a YAML file containing a ClusterImagePolicy, and an imag --image=ghcr.io/sigstore/cosign/cosign:v1.9.0 | jq) ``` +## Local Development + +You can spin up a local [Kind](https://kind.sigs.k8s.io/) K8s cluster to test local changes to the policy controller using the `localk8s` +CLI tool. Build the tool with `make localk8s` and then run it with `./bin/localk8s setup --cluster-name= --ko-docker-repo=`. + +You can clean up the cluster with `./bin/localk8s clean --cluster-name=`. + +You will need to have the following tools installed to use this: +- [Docker](https://docs.docker.com/get-docker/) +- [kind](https://kind.sigs.k8s.io/) +- [ko](https://ko.build/install/) +- [kubectl](https://kubernetes.io/docs/tasks/tools/) + ## Support Policy This policy-controller's versions are able to run in the following versions of Kubernetes: