Skip to content

Commit d0b685d

Browse files
authored
chore: explain how to contribute and test (#170)
1 parent 700a43f commit d0b685d

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,13 @@ Build binary:
4141
```console
4242
make build
4343
```
44+
45+
## Testing environment
46+
47+
For testing purpose you may need a Kubernetes environment, you can deal with microK8s, k3d, k3s, kind or what you prefer.
48+
49+
1. Apply CRDs manifests to your cluster : `kubectl apply -f package/crds`
50+
2. Create ProviderConfig : with the templates in `examples/providerconfig` you need to create a secret and a providerconfig and apply them to your cluster
51+
3. Run the provider locally : `make run`
52+
53+
Now you can to test your resources. Typically, you need to copy `examples-generated`resource in `examples`, modify it and test it.

0 commit comments

Comments
 (0)