Skip to content

Commit

Permalink
add section on localk8s tool
Browse files Browse the repository at this point in the history
Signed-off-by: Meredith Lancaster <malancas@github.com>
  • Loading branch information
malancas committed Jul 6, 2023
1 parent 291aac7 commit b16973a
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=<my cluster name> --ko-docker-repo=<some-docker-repo>`.

You can clean up the cluster with `./bin/localk8s clean --cluster-name=<my 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:
Expand Down

0 comments on commit b16973a

Please sign in to comment.