Skip to content

Commit

Permalink
Add instructions for local testing with Docker Desktop (#455)
Browse files Browse the repository at this point in the history
  • Loading branch information
timyates authored Mar 16, 2022
1 parent 0c9ae14 commit 56c0ad7
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Contributing Code or Documentation

To work on this project, you need a Kubernetes cluster accessible via `kubectl`. It can be a local cluster based on
To work on this project, you need a Kubernetes cluster accessible via `kubectl`.
It can be a local cluster based on
[Minikube](https://kubernetes.io/docs/setup/learning-environment/minikube/),
[Kind](https://kind.sigs.k8s.io/) or even a remote cluster hosted
[Kind](https://kind.sigs.k8s.io/),
[Docker Desktop](https://www.docker.com/products/docker-desktop) or even a remote cluster hosted
on AWS / GCP / Azure / Oracle Cloud / etc.

## Setting up the environment
Expand Down Expand Up @@ -38,6 +40,20 @@ Note: In case you want to use other than default Kind cluster name `kind`, run t
./setup-kubernetes.sh <CLUSTER_NAME>
```

### Docker Desktop

Ensure Kubernetes is enabled in Docker Desktop preferences and build the example services docker images:

```shell script
./gradlew clean dockerBuild --refresh-dependencies
```

Then in a separate shell, run the kubernetes proxy:

```shell
kubectl proxy
```

## Running all the tests

The test suite is composed of:
Expand Down

0 comments on commit 56c0ad7

Please sign in to comment.