All Projects → rancher → K3d

rancher / K3d

Licence: mit
Little helper to run Rancher Lab's k3s in Docker

Programming Languages

go
31211 projects - #10 most used programming language
shell
77523 projects
Makefile
30231 projects
Dockerfile
14818 projects

Projects that are alternatives of or similar to K3d

k3d-action
A GitHub Action to run lightweight ephemeral Kubernetes clusters during workflow. Fundamental advantage of this action is a full customization of embedded k3s clusters. In addition, it provides a private image registry and multi-cluster support.
Stars: ✭ 137 (-95.57%)
Mutual labels:  cluster, rancher, k3s, k3d
k3d-demo
Demo of k3d: Tool to run k3s (Kubernetes) in Docker
Stars: ✭ 197 (-93.62%)
Mutual labels:  rancher, k3s, k3d
paas-templates
Bosh, CFAR, CFCR and OSB services templates for use with COA (cf-ops-automation) framework
Stars: ✭ 16 (-99.48%)
Mutual labels:  rancher, k3s
firework8s
Firework8s is a collection of kubernetes objects (yaml files) for deploying workloads in a home lab.
Stars: ✭ 35 (-98.87%)
Mutual labels:  k3s, k3d
multipass-k3s
Use multipass instances to create your k3s cluster
Stars: ✭ 50 (-98.38%)
Mutual labels:  rancher, k3s
terraform-metal-k3s
Manage K3s (k3s.io) region clusters on Equinix Metal
Stars: ✭ 41 (-98.67%)
Mutual labels:  rancher, k3s
gitops-playground
Reproducible infrastructure to showcase GitOps workflows and evaluate different GitOps Operators on Kubernetes
Stars: ✭ 77 (-97.51%)
Mutual labels:  k3s, k3d
kubernetes-marketplace
Marketplace of Kubernetes applications available for quick and easy installation in to Civo Kubernetes clusters
Stars: ✭ 136 (-95.6%)
Mutual labels:  cluster, k3s
Fluentdispatch
🌊 .NET Standard 2.1 framework which makes easy to scaffold distributed systems and dispatch incoming load into units of work in a deterministic way.
Stars: ✭ 152 (-95.08%)
Mutual labels:  cluster
Rayo.js
Micro framework for Node.js
Stars: ✭ 170 (-94.5%)
Mutual labels:  cluster
Gardener
Kubernetes-native system managing the full lifecycle of conformant Kubernetes clusters as a service on Alicloud, AWS, Azure, GCP, OpenStack, EquinixMetal, vSphere, MetalStack, and Kubevirt with minimal TCO.
Stars: ✭ 2,093 (-32.27%)
Mutual labels:  cluster
Puppeteer Cluster
Puppeteer Pool, run a cluster of instances in parallel
Stars: ✭ 2,175 (-29.61%)
Mutual labels:  cluster
Logi Kafkamanager
一站式Apache Kafka集群指标监控与运维管控平台
Stars: ✭ 3,280 (+6.15%)
Mutual labels:  cluster
Graphview
Flutter GraphView is used to display data in graph structures. It can display Tree layout, Directed and Layered graph. Useful for Family Tree, Hierarchy View.
Stars: ✭ 152 (-95.08%)
Mutual labels:  cluster
Ansible Kubernetes Openshift Pi3
Ansible playbooks for setting up a Kubernetes Raspberry Pi 3 cluster
Stars: ✭ 189 (-93.88%)
Mutual labels:  cluster
Rancher Active Proxy
All in one active reverse proxy for Rancher ! For Kubernetes : https://github.com/adi90x/kube-active-proxy
Stars: ✭ 149 (-95.18%)
Mutual labels:  rancher
Justindb
⚛️ JustinDB is a highly available globally distributed key-value data store.
Stars: ✭ 147 (-95.24%)
Mutual labels:  cluster
Deploykit
A toolkit for creating and managing declarative, self-healing infrastructure.
Stars: ✭ 2,237 (-27.61%)
Mutual labels:  cluster
Gateway
🚀构建分布式即时聊天、消息推送系统。 Building distributed instant messaging, push notification systems.
Stars: ✭ 188 (-93.92%)
Mutual labels:  cluster
K8s1.13
微服务容器化持续交付总体流程:开发代码提交到Gitlab;Rahcher设置代码库为Gitlab;Rahcher流水线配置编译源码;Rahcher流水线Build Docker镜像;Rancher流水线Push Docker镜像到私有镜像库Harbor;Rancher流水线根据k8s yaml部署文件部署容器。
Stars: ✭ 166 (-94.63%)
Mutual labels:  rancher

k3d

Build Status License Downloads

Go Module Go version Go Report Card

All Contributors

Contributor Covenant

Please Note: main is now v5.0.0 and the code for v4.x can be found in the main-v4 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

  • docker
    • Note: k3d v5.x.x requires at least Docker v20.10.4 to work properly

Releases

  • May 2020: v1.7.x -> v3.0.0 (rewrite)
  • January 2021: v3.x.x -> v4.0.0 (breaking changes)
  • September 2021: v4.4.8 -> v5.0.0 (breaking changes)
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 - -

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/main/install.sh | bash
    • curl: curl -s https://raw.githubusercontent.com/rancher/k3d/main/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/main/install.sh | TAG=v5.0.0 bash
    • curl: curl -s https://raw.githubusercontent.com/rancher/k3d/main/install.sh | TAG=v5.0.0 bash
  • use Homebrew: brew install k3d (Homebrew is available for MacOS and Linux)

  • install via MacPorts: sudo port selfupdate && sudo port install k3d (MacPorts is available for MacOS)

  • 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@latest (Note: this will give you unreleased/bleeding-edge changes)

  • use Chocolatey: choco install k3d (Chocolatey package manager is available for Windows)

or...

Build

  1. Clone this repo, e.g. via git clone [email protected]:rancher/k3d.git or go get github.com/rancher/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 inrancher/k3d.

Related Projects

  • k3x: GUI (Linux) to k3d
  • vscode-k3d: vscode plugin for k3d
  • AbsaOSS/k3d-action: fully customizable GitHub Action to run lightweight Kubernetes clusters.
  • AutoK3s: a lightweight tool to help run K3s everywhere including k3d provider.
  • nolar/setup-k3d-k3s: setup K3d/K3s for GitHub Actions.

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/internals/project

Contributor Covenant

Contributors

Thanks goes to these wonderful people (emoji key):


Thorsten Klein

💻 📖 🤔 🚧

Rishabh Gupta

🤔 💻

Louis Tournayre

📖

Lionel Nicolas

💻

Toon Sevrin

💻

Dennis Hoppe

📖 💡

Jonas Dellinger

🚇

markrexwinkel

📖

Alvaro

💻 🤔 🔌

Nuno do Carmo

🖋 💬

Erwin Kersten

📖

Alex Sears

📖

Mateusz Urbanek

💻

Benjamin Blattberg

💻

Simon Baier

💻

Ambrose Chua

💻

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

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].