Little helper to run CNCF's k3s in Docker

docker kubernetes go cluster rancher k3d k3s

iwilltry42 42b7dc30b9 docs: use awesome-pages structure and add content		4 years ago
.github/ISSUE_TEMPLATE	add docker version	5 years ago
cmd	deleteCluster: remove cluster details from kubeconfig	4 years ago
docs	docs: use awesome-pages structure and add content	4 years ago
pkg	getLogs: return error if container is not in running state to avoid long unnecessary wait	4 years ago
proxy	Proxy: deploy a configurable nginx proxy in front of the cluster	5 years ago
tests	tests/e2e: add failure case for importing images	4 years ago
vendor	Merge branch 'master-v3' of ssh://github.com/rancher/k3d into feature/kubeconfig-modification	4 years ago
version	fix tests and add Dockerfile	5 years ago
.gitignore	docs: use awesome-pages structure and add content	4 years ago
.travis.yml	use go 1.14	5 years ago
Dockerfile	E2E-Tests: init test for multi-master setups	5 years ago
LICENSE	cleanup and prepare for push to rancher/k3d	5 years ago
Makefile	Makefile: update golangci-lint version	4 years ago
README.md	init mkdocs	4 years ago
go.mod	Merge branch 'master-v3' of ssh://github.com/rancher/k3d into feature/kubeconfig-modification	4 years ago
go.sum	Merge branch 'master-v3' of ssh://github.com/rancher/k3d into feature/kubeconfig-modification	4 years ago
install.sh	rename and add authors	6 years ago
main.go	cleanup and prepare for push to rancher/k3d	5 years ago
mkdocs.yml	docs: use awesome-pages structure and add content	4 years ago
thoughts.md	getKubeConfig: consider the KUBECONFIG env var when updating default kubeconfig	4 years ago

README.md

k3d

k3s in docker

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

k3d creates containerized k3s clusters. This means, that you can spin up a multi-node k3s cluster on a single machine using docker.

This repository is based on @zeerorg's zeerorg/k3s-in-docker, reimplemented in Go by @iwilltry42 in iwilltry42/k3d, which got adopted by Rancher inrancher/k3d.

Requirements

docker

Get

You have several options there:

via brew (homebrew/linuxbrew): brew install k3d
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 cluster CLUSTER_NAME to create a new single-node cluster (= 1 container running k3s)
export KUBECONFIG=$(k3d get kubeconfig CLUSTER_NAME) to make kubectl to use the kubeconfig for that cluster
execute some commands like kubectl get pods --all-namespaces
k3d delete cluster CLUSTER_NAME to delete the default cluster

Exposing Services

If you want to access your services from the outside (e.g. via Ingress), you need to map the ports (e.g. port 80 for Ingress) using the --publish flag (or aliases). Check out the examples here.

What now?

More Information

Connect

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