Little helper to run CNCF's k3s in Docker
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Chris Carty e82e95a23d update default K3sVersion to use latest tag 5 years ago
cli fix output order for logs 5 years ago
vendor connect workers and server via own docker network 5 years ago
version update default K3sVersion to use latest tag 5 years ago
.gitignore exclude binary folders 6 years ago
.travis.yml rename and add authors 6 years ago
LICENSE update README 6 years ago
Makefile Makefile: Add the install-tools target 5 years ago
README.md Makefile: Add the install-tools target 5 years ago
go.mod use docker sdk wherever possible 6 years ago
go.sum enhanced list 6 years ago
install.sh rename and add authors 6 years ago
main.go automatically get latest k3s version tag at build time 5 years ago

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 install-tools' to make sure required go packages are installed
  3. Inside the repo run
    • make build 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