kind README

The project's README from github.com/kubernetes-sigs/kind. As one markdown file: README.md.

kind

Please see Our Documentation for more in-depth installation etc.

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 and docker, podman or nerdctl installed go install sigs.k8s.io/[email protected] && kind create cluster is all you need!

kind consists of:

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

For a complete install guide see the documentation here.

You can install kind with go install sigs.k8s.io/[email protected].

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 put kind in $(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 make build.

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 $PATH:

On Linux:

# For AMD64 / x86_64
[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.33.0/kind-$(uname)-amd64
# For ARM64
[ $(uname -m) = aarch64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.33.0/kind-$(uname)-arm64
chmod +x ./kind
sudo 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.33.0/kind-darwin-amd64
# For M1 / ARM Macs
[ $(uname -m) = arm64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.33.0/kind-darwin-arm64
chmod +x ./kind
mv ./kind /some-dir-in-your-PATH/kind

On Windows:

curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.33.0/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:

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

Community

Please reach out for bugs, feature requests, and other issues! The maintainers of this project are reachable via:

Current maintainers are @aojea, @BenTheElder, and @stmcginnis - 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.

Why kind?

Code of conduct

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

kind (kubernetes-sigs/kind)

Searching Database…

15.6K ·GitHub
Kind
What is this?kind (Kubernetes IN Docker) runs local Kubernetes clusters using Docker containers as 'nodes'. It was primarily designed for testing Kubernetes itself, but also works for local development or CI.
Is kind a CLI I run, or a Go library I import?You run it as a CLI. Go packages implement cluster creation and image building, the kind command wraps them, and there are node images that run systemd and Kubernetes inside Docker containers.
How do I get my first cluster running?With go and a container runtime installed, go install sigs.k8s.io/[email protected] && kind create cluster is all you need. You can also grab a binary from the releases page or use Homebrew on macOS; kind delete cluster cleans up.
Is Docker mandatory, or will other runtimes do?Docker, Podman and nerdctl all work. Go is only needed for the go install route - without it, kind can be built reproducibly with make build via Docker.
Is kind production-ready or still experimental?The README still calls it a work in progress with a 1.0 roadmap ahead, but it is a CNCF certified conformant installer, and stable releases are recommended for CI usage in particular.
Will it run on Windows and macOS, or is it Linux-only?All three: kind supports Linux, macOS and Windows, with Homebrew and MacPorts among the macOS install options.
Can I run multi-node or HA clusters on my laptop?Yes - kind supports multi-node clusters, including HA setups. Multi-node and other advanced options are configured through a config file rather than command flags.
Can I spin up a cluster from Kubernetes source code?Yes. Clone Kubernetes to $(go env GOPATH)/src/k8s.io/kubernetes, build a node image from it, and create a cluster with that image - handy for testing your own Kubernetes changes.
How does kind actually build each node?Each node is a Docker container that kind bootstraps with kubeadm, the standard Kubernetes bootstrap tool, running systemd and Kubernetes components inside; the design documentation covers the details.
What are similar projects?velero, slim, buildkit, containerd, kops, dive, litmus, kompose
Which topics is it in?podman, cncf, containers, cloud-native, homebrew, ci, cli-tool, golang, kubernetes, testing, devops, go
Creator
kubernetes-sigs
Size
13.6 MB
Stars
15.6K
Updated
CommitOct 13Releasev0.33.0Aug 26
Age
8y
Commits · 90 Days