github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
683 Commits
30 Branches
851 Tags
628 MiB
 
 
 
 
Tree: d8b6ac8d3e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd8b6ac8d3e'
${ noResults }
Erik Wilson d8b6ac8d3e
Update airgap images to include rancher/local-path-provisioner 		5 years ago
.github/ISSUE_TEMPLATE Update feature_request.md 5 years ago
cmd Separate CNI plugin dependencies 5 years ago
contrib/ansible
…
e2e
…
manifests Add default local storage provisioner 5 years ago
package
…
pkg Merge pull request #867 from galal-hussein/private_reg 5 years ago
scripts Update airgap images to include rancher/local-path-provisioner 5 years ago
vendor Vendor update 5 years ago
.dockerignore Add strongswan utilities for ipsec 5 years ago
.drone.yml Test arm64 with sonobuoy 5 years ago
.gitignore Add strongswan utilities for ipsec 5 years ago
.golangci.json
…
Dockerfile.dapper Upgrade to go v1.13.1 5 years ago
Dockerfile.sonobuoy.dapper Update sonobuoy to v0.16.1 and use e2e go runner 5 years ago
LICENSE
…
Makefile
…
README.md
…
Vagrantfile Upgrade dev Vagrantfile to alpine 3.10 5 years ago
docker-compose.yml
…
go.mod Merge pull request #867 from galal-hussein/private_reg 5 years ago
go.sum Vendor update 5 years ago
install.sh Merge branch 'master' into joakimr-axis_quotes 5 years ago
k3s.service
…
main.go
…
vendor.go Switch to building runc-v1 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. 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}