Skip to content
Kubernetes IN Docker - local clusters for testing Kubernetes
Branch: master
Clone or download
Latest commit 161151a Apr 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
cmd/kind Add shell auto completions Mar 28, 2019
hack patch e2e.sh now that kubernetes uses go modules Apr 3, 2019
images Bump to version Docker 18.09 and enable CRI for containerd Apr 2, 2019
logo add project logo Jan 21, 2019
pkg bump the docker start timeout Apr 13, 2019
site document known issue with docker installed via snap Apr 3, 2019
vendor hack/update-deps.sh Mar 7, 2019
.gitignore fix gitignore Nov 17, 2018
CONTRIBUTING.md Initial Commit Sep 12, 2018
LICENSE
OWNERS Updated link to docs in OWNERS file Feb 5, 2019
README.md update demo gif Mar 9, 2019
SECURITY_CONTACTS
code-of-conduct.md Revert "move COC so github will recognize it" Sep 25, 2018
go.mod hack/update-deps.sh Mar 7, 2019
go.sum hack/update-deps.sh Mar 7, 2019
main.go clarify main.go Nov 17, 2018
netlify.toml

README.md

kind

Build Status Go Report Card

View The Documentation

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 -u sigs.k8s.io/kind && kind create cluster is all you need!

2x speed `kind create cluster` demo

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

You can install kind with go get -u sigs.k8s.io/kind. This will put kind in $(go env GOPATH)/bin. You may need to add that directory to your $PATH as shown here if you encounter the error kind: command not found after installation.

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

Community, discussion, contribution, and support

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

Current maintainers are @BenTheElder and @munnerz - feel free to reach out if you have any questions!

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: our own contributor guide and the Kubernetes community page.

Why kind?

  • kind supports multi-node (including HA) clusters
  • kind supports building Kubernetes release builds from source
    • support for make / bash / docker, bazel, or installing from apt, in addition to pre-published builds.
  • kind is written in go, and can be used as a library, has stable releases
  • kind supports Windows in addition to MacOS and Linux
  • kind is a CNCF certified conformant Kubernetes installer

Alternatives

Some other open source projects with slightly different but overlapping use cases, features etc.

Code of conduct

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

You can’t perform that action at this time.