k3d

k3s in docker

k3s is the lightweight Kubernetes distribution by Rancher: rancher/k3s

This repository is based on @zeerorg's zeerorg/k3s-in-docker, reimplemented in Go by @iwilltry42 in iwilltry42/k3d, which is now rancher/k3d.

Requirements

docker

Get

You have several options there:

use the install script to grab the latest release:
- wget: wget -q -O - https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash
- curl: curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash
Grab a release from the release tab and install it yourself.
Via go: go install github.com/rancher/k3d (Note: this will give you unreleased/bleeding-edge changes)

or...

Build

Clone this repo, e.g. via go get -u github.com/rancher/k3d
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 build to build for your current system
- go install to install it to your GOPATH (Note: this will give you unreleased/bleeding-edge changes)
- make build-cross to build for all systems

Usage

Check out what you can do via k3d help

Example Workflow: Create a new cluster and use it with kubectl

k3d create to create a new single-node cluster (docker container)
export KUBECONFIG=$(k3d get-kubeconfig) to make kubectl to use the kubeconfig for that cluster
execute some commands like kubectl get pods --all-namespaces
k3d delete to delete the default cluster

What now?

Find more details under the following Links:

Connect

Join the Rancher community on slack via slack.rancher.io
Go to rancher-users.slack.com and join our channel #k3d
Start chatting