Lightweight Kubernetes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Go to file
Erik Wilson 2cf88ae2c4
Merge pull request #1172 from simnalamburt/readme
5 years ago
.github/ISSUE_TEMPLATE bug template update 5 years ago
cmd Update check-config.sh for k3s 5 years ago
contrib Revert check-config's "Silence modprobe warnings" 5 years ago
e2e Add e2e tests 6 years ago
manifests Bump Traefik to 1.7.19 5 years ago
package Include nsswitch so golang will read /etc/hosts file in docker container 5 years ago
pkg remove []byte trans, handle func error 5 years ago
scripts Merge pull request #1111 from dduportal/patch-1 5 years ago
tests/perf randomize the secrets 5 years ago
vendor Bump kine/k8s to fix broken label based pagination 5 years ago
.dockerignore Add strongswan utilities for ipsec 5 years ago
.drone.yml Upload logs to gcloud 5 years ago
.gitignore Add strongswan utilities for ipsec 5 years ago
.golangci.json Upgrade to golangci-lint 6 years ago
BUILDING.md 📰 Modify BUILDING description 5 years ago
Dockerfile.dapper Bump dqlite to support arm 32-bit 5 years ago
Dockerfile.sonobuoy.dapper Bump go to 1.13.4 5 years ago
LICENSE Initial Commit 6 years ago
Makefile Update to dapper v0.4.2 5 years ago
README.md README.md: k3s does not exclude legacy/alpha/non-default features anymore 5 years ago
Vagrantfile Upgrade dev Vagrantfile to alpine 3.10 5 years ago
docker-compose.yml Updated to v1.0.0 image versions 5 years ago
go.mod Bump kine/k8s to fix broken label based pagination 5 years ago
go.sum Bump kine/k8s to fix broken label based pagination 5 years ago
install.sh Verify selinux status before downloading 5 years ago
k3s.service Add a little extra delay between restart attempts 5 years ago
main.go Drop openapi hack 5 years ago
vendor.go Use containerd-shim-run-v2 5 years ago

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}