Inspired by the docker CLI, --publish take same input as docker CLI and provides similar functions. For the k3s cluster server node, it behaves the same as docker cli; it exports the k3d server ports to the host ports. Handling for worker nodes will be added in the subsequent patches. This option can be used mutiple times for exposing more ports. --add-port is an alias to this option. |
||
---|---|---|
cli | ||
vendor | ||
version | ||
.gitignore | ||
.travis.yml | ||
go.mod | ||
go.sum | ||
install.sh | ||
LICENSE | ||
main.go | ||
Makefile | ||
README.md |
k3d
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
Install
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
- wget:
- Grab a release from the release tab and install it yourself.
- Via go:
go install github.com/rancher/k3d
or...
Build
- Clone this repo, e.g. via
go get -u github.com/rancher/k3d
- Inside the repo run
- 'make install-tools' to make sure required go packages are installed
- Inside the repo run
make build
to build for your current systemgo install
to install it to yourGOPATH
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
k3d create
to create a new single-node cluster (docker container)export KUBECONFIG=$(k3d get-kubeconfig)
to makekubectl
to use the kubeconfig for that cluster- execute some commands like
kubectl get pods --all-namespaces
k3d delete
to delete the default cluster