Skip to content
Little helper to run Rancher Lab's k3s in Docker
Branch: master
Clone or download
iwilltry42 Merge pull request #16 from mmatur/fix/readme
Fix bad go get command in the readme
Latest commit ce4f9d2 Apr 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cli add server-arg and env flags Apr 11, 2019
vendor add vendor Apr 4, 2019
version Added version tags, separated command implementaitons, added wait and… Apr 9, 2019
.gitignore
.travis.yml
LICENSE update README Apr 3, 2019
Makefile
README.md fix readme Apr 23, 2019
go.mod rename and add authors Apr 12, 2019
go.sum enhanced list Apr 4, 2019
install.sh
main.go rename and add authors Apr 12, 2019

README.md

k3d

Build Status Go Report Card

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

Install

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

or...

Build

  1. Clone this repo, e.g. via go get -u github.com/rancher/k3d
  2. Inside the repo run
    • make to build for your current system
    • go install to install it to your GOPATH
    • 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

  1. k3d create to create a new single-node cluster (docker container)
  2. export KUBECONFIG=$(k3d get-kubeconfig) to make kubectl to use the kubeconfig for that cluster
  3. execute some commands like kubectl get pods --all-namespaces
  4. k3d delete to delete the default cluster
You can’t perform that action at this time.