Lightweight Kubernetes
 
 
 
 
Go to file
galal-hussein 94da8b8e12 update helm-controller 2020-04-23 00:34:19 +02:00
.github/ISSUE_TEMPLATE Ask more clearly for K3s args and logs 2020-03-13 15:24:19 -07:00
cmd Update check-config.sh for k3s 2019-11-13 08:34:24 -07:00
contrib contrib/ansible: Add reset role and playbook to reset a node (#1565) 2020-03-25 12:36:28 -07:00
e2e Add e2e tests 2019-02-28 10:31:59 -07:00
manifests feat: add master taint toleration to klipper, coredns, metrics-server, traefik and local-storage 2020-03-25 19:11:10 +01:00
package Fix error when get version using Wget 2020-03-22 17:29:51 +07:00
pkg Update generated code 2020-04-18 23:59:08 -07:00
scripts Disable conformance test for arm64 2020-04-19 08:52:51 -07:00
tests/perf Merge pull request #1494 from joakimr-axis/joakimr-axis_backticks 2020-03-25 12:15:41 -07:00
vendor update helm-controller 2020-04-23 00:34:19 +02:00
.dockerignore Add rpm build & repo publish 2020-03-10 11:48:14 -07:00
.drone.yml Use curl to send dispatch event to k3s-upgrade repo 2020-03-16 19:30:40 +02:00
.gitignore Check for changes in the airgap image list 2020-03-09 19:58:00 -07:00
.golangci.json Upgrade to golangci-lint 2019-03-25 16:04:28 -07:00
BUILDING.md Fix markdown files according to markdownlint recommendations 2020-03-04 11:06:55 +01:00
Dockerfile.dapper Dockerfile.dapper: Add proxy handling (#1499) 2020-03-25 12:34:20 -07:00
Dockerfile.manifest Upgrade golang to v1.13.8 2020-02-14 15:14:49 -07:00
Dockerfile.test.dapper Update sonobouy to v0.17.2 2020-04-18 23:59:08 -07:00
LICENSE
Makefile Use contemporary $() instead of legacy `` in shell commands 2020-03-04 16:16:27 +01:00
README.md Fix markdown files according to markdownlint recommendations 2020-03-04 11:06:55 +01:00
Vagrantfile Reduce memory for dev vms 2020-03-16 17:12:21 -07:00
channel.yaml Add channel yaml to k3s 2020-04-06 09:45:19 -07:00
docker-compose.yml Remove docker-compose default token 2019-12-12 18:02:54 -07:00
go.mod update helm-controller 2020-04-23 00:34:19 +02:00
go.sum update helm-controller 2020-04-23 00:34:19 +02:00
install.sh Use channel server for install script 2020-04-08 14:32:52 -07: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}