k3d

Little helper to run Rancher Lab's k3s in Docker

Github星跟踪图

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

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=v1.3.4 bash
    • curl: curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh, TAG=v1.3.4 bash
  • Use Homebrew: brew install k3d (Homebrew is avaiable for MacOS and Linux)

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

  • 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

Example Workflow: Create a new cluster and use it with kubectl
(Note: kubectl is not part of k3d, so you have to install it first if needed)

  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

Exposing Services

If you want to access your services from the outside (e.g. via Ingress), you need to map the ports (e.g. port 80 for Ingress) using the --publish flag (or aliases).
Check out the examples here.

What now?

Find more details under the following Links:

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

主要指标

概览
名称与所有者k3d-io/k3d
主编程语言Go
编程语言Go (语言数: 5)
平台
许可证MIT License
所有者活动
创建于2019-04-02 11:30:11
推送于2025-07-08 13:28:25
最后一次提交
发布数170
最新版本名称v5.8.3 (发布于 )
第一版名称v0.0.1 (发布于 )
用户参与
星数5.9k
关注者数55
派生数495
提交数1.6k
已启用问题?
问题数819
打开的问题数230
拉请求数430
打开的拉请求数20
关闭的拉请求数75
项目设置
已启用Wiki?
已存档?
是复刻?
已锁定?
是镜像?
是私有?