Our Documentation for more in-depth installation etc.Please see
kind is a tool for running local Kubernetes clusters using Docker container "nodes".
kind was primarily designed for testing Kubernetes itself, but may be used for local development or CI.
If you have go (1.11+) and docker installed
GO111MODULE="on" go get sigs.k8s.io/[email protected] && kind create cluster 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 the 1.0 roadmap.
Installation and usage
You can install kind with
GO111MODULE="on" go get sigs.k8s.io/[email protected].
NOTE: please use the latest go to do this, ideally go 1.13 or greater.
This will put
$(go env GOPATH)/bin. If you encounter the error
kind: command not found after installation then you may need to either add that directory to your
$PATH as shown here or do a manual installation by cloning the repo and run
make build from the repository.
Without installing go, kind can be built reproducibly with docker using
Stable binaries are also available on the releases page. Stable releases are generally recommended for CI usage in particular. To install, download the binary for your platform from "Assets" and place this into your
On Mac & Linux:
curl -Lo ./kind "https://kind.sigs.k8s.io/dl/v0.8.1/kind-$(uname)-amd64" chmod +x ./kind mv ./kind /some-dir-in-your-PATH/kind
On Mac via Homebrew:
brew install kind
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.8.1/kind-windows-amd64 Move-Item .\kind-windows-amd64.exe c:\some-dir-in-your-PATH\kind.exe # OR via Chocolatey (https://chocolatey.org/packages/kind) choco install kind
To use kind, you will need to install docker.
Once you have docker running you can create a cluster with:
kind create cluster
To delete your cluster use:
kind delete cluster
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-image kind create cluster --image kindest/node:latest
Multi-node clusters and other advanced features may be configured with a config file, 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 #kind channel
- filing an issue against this repo
- The Kubernetes SIG-Testing Mailing List
Current maintainers are @BenTheElder and @munnerz - feel free to reach out if you have any questions!
Pull Requests are very welcome!
If you're planning a new feature, please file an issue to discuss first.
Check the issue tracker for
help wanted issues if you're unsure where to start, or feel free to reach out to discuss.
See also: our own contributor guide and the Kubernetes community page.
- kind supports multi-node (including HA) clusters
- kind supports building Kubernetes release builds from source
- support for make / bash / docker or bazel, in addition to pre-published builds
- kind supports Linux, macOS and Windows
- kind is a CNCF certified conformant Kubernetes installer
Code of conduct
Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.