Lightweight Kubernetes
 
 
 
 
Go to file
Darren Shepherd 59177e58b7 Bump dynamiclistener to support RSA keys 2019-11-15 21:51:51 -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 Revert check-config's "Silence modprobe warnings" 2019-11-14 10:56:37 -07:00
e2e Add e2e tests 2019-02-28 10:31:59 -07:00
manifests Move metrics-server manifests to sub-directory 2019-11-05 14:30:50 -07:00
package Include nsswitch so golang will read /etc/hosts file in docker container 2019-11-12 01:12:24 +00:00
pkg Delete unused code 2019-11-15 21:51:51 -07:00
scripts Merge pull request #914 from erikwilson/validation-utilities 2019-11-13 09:00:08 -07:00
vendor Bump dynamiclistener to support RSA keys 2019-11-15 21:51:51 -07:00
.dockerignore Add strongswan utilities for ipsec 2019-09-27 18:26:39 -07:00
.drone.yml Upload logs to gcloud 2019-11-11 20:19:19 -07:00
.gitignore Add strongswan utilities for ipsec 2019-09-27 18:26:39 -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 Disable go modules only in dapper, not always 2019-11-13 14:49:54 +00:00
Dockerfile.sonobuoy.dapper Bump go to 1.13.4 2019-11-12 16:35:54 -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 Update README fix docs site link 2019-07-17 12:46:05 -07:00
Vagrantfile Upgrade dev Vagrantfile to alpine 3.10 2019-09-27 18:26:39 -07:00
docker-compose.yml update image to v0.10.0 in docker-compose.yml 2019-10-26 23:51:57 +09:00
go.mod Bump dynamiclistener to support RSA keys 2019-11-15 21:51:51 -07:00
go.sum Bump dynamiclistener to support RSA keys 2019-11-15 21:51:51 -07:00
install.sh Merge pull request #967 from erikwilson/killall-cleanup 2019-10-26 16:54:09 -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 Use containerd-shim-run-v2 2019-10-18 12:34:27 -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. Legacy, alpha, non-default features are removed. Hopefully, you shouldn't notice the stuff that has been removed.
  2. Removed most in-tree plugins (cloud providers and storage plugins) which can be replaced with out of tree addons.
  3. Add sqlite3 as the default storage mechanism. etcd3 is still available, but not the default.
  4. Wrapped in simple launcher that handles a lot of the complexity of TLS and options.
  5. 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}