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.
353 Commits
25 Branches
165 Tags
70 MiB
 
 
 
 
Tag: Branch: Tree: 52b23adec9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '52b23adec9'
${ noResults }
iwilltry42 52b23adec9
v1.0.0 as default version 		5 years ago
.github/ISSUE_TEMPLATE add docker version 5 years ago
cmd v1.0.0 as default version 5 years ago
docs disable external datastore option for now 5 years ago
pkg add proper k3d config dir and kubeconfig output path 5 years ago
vendor add proper k3d config dir and kubeconfig output path 5 years ago
version v1.0.0 as default version 5 years ago
.gitignore add utils 5 years ago
.travis.yml use golangci-lint v1.20 5 years ago
LICENSE init cobra 5 years ago
Makefile use golangci-lint v1.20 5 years ago
README.md update README 5 years ago
go.mod update vendor 5 years ago
go.sum update vendor 5 years ago
install.sh rename and add authors 6 years ago
main.go init cobra 5 years ago
thoughts.md implement load images command 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

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
  • 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

  1. k3d create cluster CLUSTER_NAME to create a new single-node cluster (= 1 container running k3s)
  2. export KUBECONFIG=$(k3d get kubeconfig CLUSTER_NAME) to make kubectl to use the kubeconfig for that cluster
  3. execute some commands like kubectl get pods --all-namespaces
  4. k3d delete cluster CLUSTER_NAME 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