Lightweight Kubernetes
 
 
 
 
Go to file
Erik Wilson 4370fc1482 Remove old runc & containerd shims on build 2020-02-28 17:32:42 -07:00
.github/ISSUE_TEMPLATE bug template update 2019-10-30 14:30:29 -07:00
cmd Update check-config.sh for k3s 2019-11-13 08:34:24 -07:00
contrib Merge pull request #1430 from St0rmingBr4in/fix-home 2020-02-24 15:24:33 -07:00
e2e Add e2e tests 2019-02-28 10:31:59 -07:00
manifests Add lease permissions to ccm cluster role 2019-12-21 04:41:24 +02:00
package Include nsswitch so golang will read /etc/hosts file in docker container 2019-11-12 01:12:24 +00:00
pkg Merge pull request #1464 from erikwilson/selinux-update 2020-02-28 15:42:45 -07:00
scripts Remove old runc & containerd shims on build 2020-02-28 17:32:42 -07:00
tests/perf randomize the secrets 2019-11-27 20:30:56 +02:00
vendor Update vendor 2020-02-24 16:03:11 -07:00
.dockerignore Add strongswan utilities for ipsec 2019-09-27 18:26:39 -07:00
.drone.yml use github_token for dispatch event 2020-02-28 21:37:56 +02:00
.gitignore Attempt drone docker tagging from .tags 2020-01-06 15:54:48 -07:00
.golangci.json Upgrade to golangci-lint 2019-03-25 16:04:28 -07:00
BUILDING.md 📰 Modify BUILDING description 2019-11-14 18:54:50 +08:00
Dockerfile.dapper Clean up building && provide Vagrant centos7 setup 2020-02-28 15:39:11 -07:00
Dockerfile.manifest Upgrade golang to v1.13.8 2020-02-14 15:14:49 -07:00
Dockerfile.test.dapper Upgrade golang to v1.13.8 2020-02-14 15:14:49 -07:00
LICENSE Initial Commit 2019-01-01 01:23:01 -07:00
Makefile Update to dapper v0.4.2 2019-07-02 16:13:42 -07:00
README.md README.md: k3s does not exclude legacy/alpha/non-default features anymore 2019-12-10 02:28:48 +09:00
Vagrantfile Clean up building && provide Vagrant centos7 setup 2020-02-28 15:39:11 -07:00
docker-compose.yml Remove docker-compose default token 2019-12-12 18:02:54 -07:00
go.mod Update vendor 2020-02-24 16:03:11 -07:00
go.sum Update vendor 2020-02-24 16:03:11 -07:00
install.sh Start cgroups service in OpenRC script 2020-01-26 19:28:36 +01:00
k3s.service Add a little extra delay between restart attempts 2019-07-25 13:02:19 -05:00
main.go Drop openapi hack 2019-08-28 20:53:39 -07:00
vendor.go Update k3s for k8s 1.17.0 2019-12-15 23:28:19 -07:00

README.md

k3s - 5 less than k8s

Lightweight Kubernetes. Easy to install, half the memory, all in a binary less than 40mb.

Great for:

  • Edge
  • IoT
  • CI
  • ARM
  • Situations where a PhD in k8s clusterology is infeasible

What is this?

k3s is intended to be a fully compliant Kubernetes distribution with the following changes:

  1. Removed most in-tree plugins (cloud providers and storage plugins) which can be replaced with out of tree addons.
  2. Add sqlite3 as the default storage mechanism. etcd3 is still available, but not the default.
  3. Wrapped in simple launcher that handles a lot of the complexity of TLS and options.
  4. Minimal to no OS dependencies (just a sane kernel and cgroup mounts needed). k3s packages required dependencies
    • containerd
    • Flannel
    • CoreDNS
    • CNI
    • Host utilities (iptables, socat, etc)

Documentation

Please see the official docs site for complete documentation on k3s.

Quick-Start - Install Script

The k3s install.sh script provides a convenient way for installing to systemd or openrc, to install k3s as a service just run:

curl -sfL https://get.k3s.io | sh -

A kubeconfig file is written to /etc/rancher/k3s/k3s.yaml and the service is automatically started or restarted. The install script will install k3s and additional utilities, such as kubectl, crictl, k3s-killall.sh, and k3s-uninstall.sh, for example:

sudo kubectl get nodes

K3S_TOKEN is created at /var/lib/rancher/k3s/server/node-token on your server. To install on worker nodes we should pass K3S_URL along with K3S_TOKEN or K3S_CLUSTER_SECRET environment variables, for example:

curl -sfL https://get.k3s.io | K3S_URL=https://myserver:6443 K3S_TOKEN=XXX sh -

Manual Download

  1. Download k3s from latest release, x86_64, armhf, and arm64 are supported.
  2. Run server.
sudo k3s server &
# Kubeconfig is written to /etc/rancher/k3s/k3s.yaml
sudo k3s kubectl get nodes

# On a different node run the below. NODE_TOKEN comes from 
# /var/lib/rancher/k3s/server/node-token on your server
sudo k3s agent --server https://myserver:6443 --token ${NODE_TOKEN}