k3s is the lightweight Kubernetes distribution by Rancher: k3s-io/k3s
k3d creates containerized k3s clusters. This means, that you can spin up a multi-node k3s cluster on a single machine using docker.
Note: k3d is a community-driven project but it's not an official Rancher (SUSE) product. Sponsoring: To spend any significant amount of time improving k3d, we rely on sponsorships:
- Website with documentation: k3d.io
- Rancher Meetup - May 2020 - Simplifying Your Cloud-Native Development Workflow With K3s, K3c and K3d (YouTube)
- k3d demo repository: iwilltry42/k3d-demo
- Note: k3d v5.x.x requires at least Docker v20.10.5 (runc >= v1.0.0-rc93) to work properly (see #807)
- May 2020: v1.7.x -> v3.0.0 (rewrite)
- January 2021: v3.x.x -> v4.0.0 (breaking changes)
- September 2021: v4.4.8 -> v5.0.0 (breaking changes)
|Platform||Stage||Version||Release Date||Downloads so far|
You have several options there:
use the install script to grab the latest release:
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | bash
use the install script to grab a specific release (via
wget -q -O - https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
curl -s https://raw.githubusercontent.com/k3d-io/k3d/main/install.sh | TAG=v5.0.0 bash
brew install k3d(Homebrew is available for MacOS and Linux)
install via MacPorts:
sudo port selfupdate && sudo port install k3d(MacPorts is available for MacOS)
grab a release from the release tab and install it yourself.
install via go:
go install github.com/k3d-io/k3d/v5@latest(Note: this will give you unreleased/bleeding-edge changes)
choco install k3d(Chocolatey package manager is available for Windows)
- package source can be found in erwinkersten/chocolatey-packages
- Clone this repo, e.g. via
git clone email@example.com:k3d-io/k3d.gitor
go get github.com/k3d-io/k3d/v5@main
- Inside the repo run
- 'make install-tools' to make sure required go packages are installed
- Inside the repo run one of the following commands
make buildto build for your current system
go installto install it to your
GOPATH(Note: this will give you unreleased/bleeding-edge changes)
make build-crossto build for all systems
Check out what you can do via
k3d help or check the docs @ k3d.io
Example Workflow: Create a new cluster and use it with
k3d cluster create CLUSTER_NAMEto create a new single-node cluster (= 1 container running k3s + 1 loadbalancer container)
- [Optional, included in cluster create]
k3d kubeconfig merge CLUSTER_NAME --kubeconfig-switch-contextto update your default kubeconfig and switch the current-context to the new one
- execute some commands like
kubectl get pods --all-namespaces
k3d cluster delete CLUSTER_NAMEto delete the default cluster
- Join the Rancher community on slack via slack.rancher.io
- Go to rancher-users.slack.com and join our channel #k3d
- Start chatting
This repository is based on @zeerorg's zeerorg/k3s-in-docker, reimplemented in Go by @iwilltry42 in iwilltry42/k3d, which got adopted by Rancher in rancher/k3d and was now moved into its own GitHub organization at k3d-io/k3d.
- k3x: GUI (Linux) to k3d
- vscode-k3d: vscode plugin for k3d
- AbsaOSS/k3d-action: fully customizable GitHub Action to run lightweight Kubernetes clusters.
- AutoK3s: a lightweight tool to help run K3s everywhere including k3d provider.
- nolar/setup-k3d-k3s: setup K3d/K3s for GitHub Actions.
k3d is a community-driven project and so we welcome contributions of any form, be it code, logic, documentation, examples, requests, bug reports, ideas or anything else that pushes this project forward.
You can find an overview of the k3d project (e.g. explanations and a repository guide) in the documentation: k3d.io/stable/design/project/
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!