mirrors/k3d
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
349 Commits 12 Branches 130 Tags 31 MiB
Go 89.6%
Shell 8.3%
Makefile 1.7%
Dockerfile 0.4%
e6d7726ffb
Go to file
iwilltry42 e6d7726ffb add image volume
2019-12-04 08:19:42 +01:00
.github/ISSUE_TEMPLATE add docker version 2019-05-21 23:04:12 +02:00
cmd add image volume 2019-12-04 08:19:42 +01:00
docs disable external datastore option for now 2019-11-26 17:07:23 +01:00
pkg add image volume 2019-12-04 08:19:42 +01:00
vendor update README 2019-10-16 14:13:39 +02:00
version add version command 2019-10-16 14:46:02 +02:00
.gitignore add utils 2019-09-06 17:39:56 +02:00
.travis.yml use golangci-lint v1.20 2019-10-10 11:42:34 +02:00
go.mod init get kubeconfig 2019-10-24 14:57:15 +02:00
go.sum prepare volume flag 2019-11-05 19:17:47 +01:00
install.sh rename and add authors 2019-04-12 07:36:59 +02:00
LICENSE init cobra 2019-09-03 12:04:02 +02:00
main.go init cobra 2019-09-03 12:04:02 +02:00
Makefile use golangci-lint v1.20 2019-10-10 11:42:49 +02:00
README.md update README 2019-10-16 14:13:39 +02:00
thoughts.md add image volume 2019-12-04 08:19:42 +01:00

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