kind is a tool for running local Kubernetes clusters using Docker container "nodes".
kind is primarily designed for testing Kubernetes 1.11+, initially targeting the conformance tests.
If you have go and docker installed go get sigs.k8s.io/kind && kind create is all you need!
kind consists of:
- Go packages implementing cluster creation, image build, etc.
- A command line interface (
kind) built on these packages. - Docker image(s) written to run systemd, Kubernetes, etc.
kubetestintegration also built on these packages (WIP)
kind bootstraps each "node" with kubeadm. For more details see the design documentation.
NOTE: kind is still a work in progress, see docs/todo.md.
You can install kind with go get sigs.k8s.io/kind
To use kind, you will need to install docker.
Once you have docker running you can create a cluster with kind create
To delete your cluster use kind delete
To create a cluster from Kubernetes source:
- ensure that Kubernetes is cloned in
$(go env GOPATH)/src/k8s.io/kubernetes - build a node image and create a cluster with
kind build node && kind create
For more usage see the docs or run kind [command] --help
Please reach out for bugs, feature requests, and other issues!
The maintainers of this project are reachable via:
- Kubernetes Slack in the #sig-testing channel
- filing an issue against this repo
- The Kubernetes SIG-Testing Mailing List
Current maintainers (approvers) are @BenTheElder and @munnerz.
Pull Requests are very welcome!
See the issue tracker if you're unsure where to start, or feel free to reach out to discuss.
See also: the Kubernetes community page.
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.