Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit e8ca931

Browse files
committedNov 16, 2023
update development docs for kind
1 parent bf7a410 commit e8ca931

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed
 

‎docs/developer-guide/README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ Have a look at the architecture guide on the internal workings of the ingress co
1111
- [Go 1.20](https://go.dev/dl/)
1212
- [Helm](https://helm.sh/docs/intro/install/)
1313

14-
Both of these can be obtained via [nix-direnv](https://github.com/nix-community/nix-direnv), which will automatically configure your shell for you.
14+
Both of these can be obtained via [nix-direnv](https://github.com/nix-community/nix-direnv), which will automatically configure your shell for you. Note that it will also set `KUBECONFIG` to a file "owned" by direnv, so as not to pollute the configuration in your `$HOME`.
1515

16-
- A k8s cluster is available via your kubectl client. This can be a remote cluster or a local cluster like [minikube](https://minikube.sigs.k8s.io/docs/start/)
17-
- NOTE: Depending on your cluster, you may have to take additional steps to make the image available. For example with minikube, you may need to run `eval $(minikube docker-env)` in each terminal session to make the image from `make deploy` available to the cluster.
16+
A k8s cluster is available via your kubectl client. This can be a remote cluster or a local cluster like [kind](https://kind.sigs.k8s.io/) or [minikube](https://minikube.sigs.k8s.io/docs/start/).
17+
18+
Depending on your cluster, you may have to take additional steps to make the image available. For example with minikube, you may need to run `eval $(minikube docker-env)` in each terminal session to make the image from `make deploy` available to the cluster.
19+
20+
Support for `kind` is provided out of the box. `scripts/kind-up.sh` will create a kind cluster and an accompanying docker registry, and `scripts/kind-down.sh` will tear both down. The `docker-push` and `deploy` tasks in the provided `Makefile` are configured to use this registry.
1821

1922
### Setup
2023

0 commit comments

Comments
 (0)
Please sign in to comment.