k3s

Installation Commands

Install k3s server and agent nodes using the official install script with customization options.

12 commands

Pro Tips

Use --write-kubeconfig-mode 644 for easier kubectl access

Add --disable traefik to use your own ingress controller

Common Mistakes

k3s requires root or sudo for installation

Commands

Install k3s server

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

Install k3s server with defaults.

Install without traefik

$ curl -sfL https://get.k3s.io | sh -s - --disable traefik

Install without built-in ingress.

Install with kubeconfig mode

$ curl -sfL https://get.k3s.io | sh -s - --write-kubeconfig-mode 644

Install with readable kubeconfig.

Uninstall k3s

$ /usr/local/bin/k3s-uninstall.sh

Completely remove k3s server.

Install specific version

$ curl -sfL https://get.k3s.io | INSTALL_K3S_VERSION=v1.28.0+k3s1 sh -

Install specific k3s version.

Install agent node

$ curl -sfL https://get.k3s.io | K3S_URL=https://server:6443 K3S_TOKEN=<token> sh -

Install k3s in agent-only mode joining an existing server.

Install with INSTALL_K3S_EXEC

$ curl -sfL https://get.k3s.io | INSTALL_K3S_EXEC="--disable servicelb --disable traefik" sh -

Pass server flags via INSTALL_K3S_EXEC env var.

Install with embedded etcd

$ curl -sfL https://get.k3s.io | sh -s - server --cluster-init

Initialize HA cluster with embedded etcd datastore.

Install with external database

$ curl -sfL https://get.k3s.io | sh -s - server --datastore-endpoint="postgres://user:pass@host:5432/k3s"

Install using an external PostgreSQL or MySQL datastore.

Air-gap install

$ sudo mkdir -p /var/lib/rancher/k3s/agent/images/ && sudo cp k3s-airgap-images.tar.gz /var/lib/rancher/k3s/agent/images/ && INSTALL_K3S_SKIP_DOWNLOAD=true ./install.sh

Install k3s in an air-gapped environment with pre-downloaded images.

Install with TLS SAN

$ curl -sfL https://get.k3s.io | sh -s - --tls-san my-load-balancer.example.com

Add additional Subject Alternative Name for the TLS certificate.

Join server to HA cluster

$ curl -sfL https://get.k3s.io | sh -s - server --server https://first-server:6443 --token <token>

Join additional server node to an existing HA etcd cluster.

k3s