GitHub - k3d-io/k3d: Little helper to run CNCF's k3s in Docker (original) (raw)

k3d

License Downloads

Go Module Go version Go Report Card

All Contributors

Contributor Covenant

k3s in docker

k3s is the lightweight Kubernetes distribution by Rancher: k3s-io/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

Note: k3d is a community-driven project but it's not an official Rancher (SUSE) product.Sponsoring: To spend any significant amount of time improving k3d, we rely on sponsorships:

Learning

Requirements

Releases

Platform Stage Version Release Date Downloads so far
GitHub Releases stable GitHub release (latest by date) GitHub Release Date GitHub Release Downloads
GitHub Releases latest GitHub release (latest by date including pre-releases) GitHub (Pre-)Release Date GitHub Release Downloads (incl. Pre-Releases)
Homebrew stable homebrew - -
Chocolatey stable chocolatey - -
Scoop stable scoop - -

Get

You have several options there:

or...

Build

  1. Clone this repo, e.g. via git clone git@github.com:k3d-io/k3d.git or go get github.com/k3d-io/k3d/v5@main
  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 cluster create CLUSTER_NAME to create a new single-node cluster (= 1 container running k3s + 1 loadbalancer container)
  2. [Optional, included in cluster create] k3d kubeconfig merge CLUSTER_NAME --kubeconfig-switch-context 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 cluster delete 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 in rancher/k3d and was now moved into its own GitHub organization at k3d-io/k3d.

Contributing

k3d is a community-driven project and so we welcome contributions of any form, be it code, logic, documentation, examples, requests, bug reports, ideas or anything else that pushes this project forward.

Please read our Contributing Guidelines and the related Code of Conduct.

You can find an overview of the k3d project (e.g. explanations and a repository guide) in the documentation: k3d.io/stable/design/project/

Contributor Covenant

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Thorsten Klein Thorsten Klein💻 📖 🤔 🚧 Rishabh Gupta Rishabh Gupta🤔 💻 Louis Tournayre Louis Tournayre📖 Lionel Nicolas Lionel Nicolas💻 Toon Sevrin Toon Sevrin💻 Dennis Hoppe Dennis Hoppe📖 💡 Jonas Dellinger Jonas Dellinger🚇
markrexwinkel markrexwinkel📖 Alvaro Alvaro💻 🤔 🔌 Nuno do Carmo Nuno do Carmo🖋 ✅ 💬 Erwin Kersten Erwin Kersten📖 Alex Sears Alex Sears📖 Mateusz Urbanek Mateusz Urbanek💻 Benjamin Blattberg Benjamin Blattberg💻
Simon Baier Simon Baier💻 Ambrose Chua Ambrose Chua💻 Erik Godding Boye Erik Godding Boye💻 York Wong York Wong💻 Raul Gonzales Raul Gonzales💻 📖 Sunghoon Kang Sunghoon Kang💻 Kamesh Sampath Kamesh Sampath💻
Arik Maor Arik Maor💻 ✅ 💡 Danny Gershman Danny Gershman💻 stopanko stopanko💵 Danny Breyfogle Danny Breyfogle📖 Ahmed AbouZaid Ahmed AbouZaid🤔 💻 📖 Pierre Roudier Pierre Roudier💻 Adrien Horgnies Adrien Horgnies📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsors

Thanks to our amazing sponsors! 🙏

User avatar: Johnathan W Johnathan W