Repository files navigation

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 havego 1.16+ anddocker,podman ornerdctl installedgo install sigs.k8s.io/kind@v0.29.0 && kind create cluster is all you need!

kind consists of:

• Gopackages implementingcluster creation,image build, etc.
• A command line interface (kind) built on these packages.
• Dockerimage(s) written to run systemd, Kubernetes, etc.
• kubetest integration also built on these packages (WIP)

kind bootstraps each "node" withkubeadm. For more details seethe design documentation.

NOTE: kind is still a work in progress, see the1.0 roadmap.

For a completeinstall guide seethe documentation here.

You can install kind withgo install sigs.k8s.io/kind@v0.29.0.

NOTE: please use the latest go to do this. KIND is developed with the latest stable go, see.go-version for the exact version we're using.

This will putkind in$(go env GOPATH)/bin. If you encounter the errorkind: command not found after installation then you may need to either add that directory to your$PATH asshownhere or do a manual installation by cloning the repo and runmake build from the repository.

Without installing go, kind can be built reproducibly with docker usingmake build.

Stable binaries are also available on thereleases page. Stable releases aregenerally recommended for CI usage in particular.To install, download the binary for your platform from "Assets" and place thisinto your$PATH:

On Linux:

#For AMD64 / x86_64[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.29.0/kind-$(uname)-amd64#For ARM64[ $(uname -m) = aarch64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.29.0/kind-$(uname)-arm64chmod +x ./kindsudo mv ./kind /usr/local/bin/kind

On macOS via Homebrew:

brew install kind

On macOS via MacPorts:

sudo port selfupdate && sudo port install kind

On macOS via Bash:

#For Intel Macs[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.29.0/kind-darwin-amd64#For M1 / ARM Macs[ $(uname -m) = arm64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.29.0/kind-darwin-arm64chmod +x ./kindmv ./kind /some-dir-in-your-PATH/kind

On Windows:

curl.exe-Lokind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.29.0/kind-windows-amd64Move-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 toinstall 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-imagekind create cluster --image kindest/node:latest

Multi-node clusters and other advanced features may be configured with a configfile, for more usage seethe docs or runkind [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 KubernetesSIG-Testing Mailing List

Current maintainers are@aojea,@BenTheElder, and@stmcginnis - feel free toreach 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 theissue tracker forhelp wanted issues if you're unsure where tostart, or feel free to reach out to discuss. 🙂

See also: our owncontributor guide and the Kubernetescommunity page.

• kind supports multi-node (including HA) clusters
• kind supports building Kubernetes release builds from source
  • support for make / bash or docker, in addition to pre-published builds
• kind supports Linux, macOS and Windows
• kind is aCNCF certified conformant Kubernetes installer

Participation in the Kubernetes community is governed by theKubernetes Code of Conduct.