gregandev
/
k3d
mirror of https://github.com/k3d-io/k3d
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
498 Commits
25 Branches
165 Tags
70 MiB
 
 
 
 
Tag: Branch: Tree: 898dbda4fc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '898dbda4fc'
${ noResults }
Izzat Zuliya R 898dbda4fc
Update install.sh 		4 years ago
.github/ISSUE_TEMPLATE add docker version 5 years ago
cmd fix: re-add support for named volumes used with --volume flag 4 years ago
docs fix typo 4 years ago
pkg fix: re-add support for named volumes used with --volume flag 4 years ago
proxy MasterLoadBalancer: add nodefilter & extra treatment 4 years ago
tests tests/e2e: add E2E_SKIP env var to skip specific e2e tests, as test_multi_master tends to fail in travis 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 travis-ci: fix target branch for gh-pages 4 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 installScript: fix duplication in curl command 4 years ago
README.md readme/docs: change logo format 4 years ago
go.mod createNode: copy as many details as possible from existing 4 years ago
go.sum Merge branch 'master-v3' of ssh://github.com/rancher/k3d into feature/kubeconfig-modification 4 years ago
install.sh Update install.sh 4 years ago
main.go cleanup and prepare for push to rancher/k3d 5 years ago
mkdocs.yml readme/docs: add k3d logo 4 years ago
thoughts.md new section in docs 4 years ago

README.md

k3d

Build Status Go Report Card License Downloads

Please Note: master is now v3.0.0 and the code for v1.x can be found in the master-v1 branch!

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.

asciicast

Learning

Requirements

Releases

Note: In May 2020 we upgraded from v1.7.x to v3.0.0 after a complete rewrite of k3d!

Platform Stage Version Release Date
GitHub Releases stable GitHub release (latest by date) GitHub Release Date
GitHub Releases latest GitHub release (latest by date including pre-releases) GitHub (Pre-)Release Date
Homebrew - homebrew -

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

  • use the install script to grab a specific release (via TAG environment variable):

    • wget: wget -q -O - https://raw.githubusercontent.com/rancher/k3d/master/install.sh | TAG=v3.0.0-beta.0 bash
    • curl: curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh | TAG=v3.0.0-beta.0 bash

  • use Homebrew: brew install k3d (Homebrew is available for MacOS and Linux)

  • install via AUR package rancher-k3d-bin: yay -S rancher-k3d-bin

  • grab a release from the release tab and install it yourself.

  • install via go: go install github.com/rancher/k3d (Note: this will give you unreleased/bleeding-edge changes)

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 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 or check the docs @ k3d.io

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

  1. k3d create cluster CLUSTER_NAME to create a new single-node cluster (= 1 container running k3s)
  2. k3d get kubeconfig CLUSTER_NAME --switch to update your default kubeconfig and switch the current-context to the new one
  3. execute some commands like kubectl get pods --all-namespaces
  4. k3d delete cluster CLUSTER_NAME to delete the default cluster

Connect

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

History

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.