kind-on-dev

This repo helps to setup a KinD (and K3s, MicroK8S, Vagrant+kubeadm) cluster from scratch. Usage is published at Environment for comparing several on-premise Kubernetes distributions (K3s, KinD, kubeadm).

The solution is make-based, see more details in Makefile and .env.

On Windows, only below combinations are supported with limitaitons:

Vagrant+kubeadm
WSL2 with KinD

Warning: This deployment is not secure and must be hardened before using it in production.

Preparation

Install below packages, if it's missing:

make
git

On Ununtu, run below commands, if something is missing or needed:

make install-kubectl (if not installed yet)
make install-micro (if MicroK8S not installed yet)
make install-docker (only for KinD)
make install-kind (only for KinD)
make install-kvm (only for Vagrant + libvirt/KVM)
make generate-vagrant (only for Vagrant, needed)
DO_VAGRANT_ALIAS=true make install-vagrant (only for Vagrant, if not installed yet and vagrant would be used in CLI)
make install-helm (if not installed yet)

Note: /etc/docker/daemon.json:insecure-registries may be set for MicroK8S, if Docker is installed, see: https://microk8s.io/docs/registry-built-in.

Note: the Vagrant+kubeadm variant uses own vagrant in Docker, which contains all needed plugins. See more details at kubeadm-vagrant/Ubuntu/README.md.

Note: There are several limitations and workarounds with Vagrant, See more details at kubeadm-vagrant/Ubuntu/README.md.

A few Linux filesystem limits should be increased, for example:

cat /proc/sys/fs/inotify/max_user_watches; echo fs.inotify.max_user_watches=524288 | sudo tee /etc/sysctl.d/50_max_user_watches.conf && sudo sysctl --system; cat /proc/sys/fs/inotify/max_user_watches

cat /proc/sys/fs/inotify/max_user_instances; echo fs.inotify.max_user_instances=8196 | sudo tee /etc/sysctl.d/50_max_user_instances.conf && sudo sysctl --system; cat /proc/sys/fs/inotify/max_user_instances

On Windows with Vagrant+kubeadm, do below steps:

Install official Vagrant and needed plugins (mutate and hostmanager), if not installed yet.
Install kubectl, if not installed yet.
Install a Cygwin distribution, which has make and git or it can be installed (for example on MobaXterm: apt-get install make git)
run make generate-vagrant

Configuration

Review .env.

Review *.yaml files.

Review kubeadm-vagrant/Ubuntu/Vagrantfile, if Vagrant is used. Hint: RAM allocation for VMs is very low!

Review kind-config_wsl2.yaml, if WSL2 with KinD is used.

Help for Prometheus configuration:

Passwords:

Grafana: admin / prometheus-values.yaml:grafana.adminPassword

Setup cluster

Warning: ~/.kube/config will be overwritten!

Install:

make all

Example for install without Prometheus:

make all DO_PROMETHEUS=false

Example for installing a non-default distro (the default can be set in .env):

make all K8S_DISTRIBUTION=k3s

Example for installing WSL2 with KinD:

make all OAM_DOMAIN=admin.ncd.local OAM_IP="" TRAEFIK_SERVICETYPE=NodePort KIND_CONFIG=kind-config_wsl2.yaml DO_CNI=false DO_METALLB=false

Post-install steps: please follow instructions of make info-post. Note: info-post target is called at the end of make all.

Optional components

Monitoring

Metrics server and Prometheus deployment can de disabled by DO_... flags in .env file.

Storage

Before using NFS in K3s, nfs-common package must be installed, for example:

sudo apt install nfs-common

Nfs storage can be deployed by make nfs. It can be configured in nfs-values.yaml.

Warning! It's experimental.

Example for using NFS:

kubectl apply -f pvc-example.yaml

kubectl get pod -l app=busybox-with-pv -o wide --show-labels

for pod in $(kubectl get pod -l app=busybox-with-pv -o name); do echo -e "\n$pod /mnt"; kubectl exec -ti $pod -- find /mnt -type f -exec cat '{}' ';' ; done

Note: the default storage is https://github.com/rancher/local-path-provisioner, which is used by the deployed NFS server.

Destroy cluster

Warning: if the selected K8s distribution is K3s, it will be uninstalled!

make destroy

Known issues

WSL2

Only WSL2 with KinD combination is supported. Only 1 worker node is supported.

Before starting the install, max_user_watches and max_user_instances must be set properly (sysctl --system).

After restart, the WSL2 IP address will be changed. The WSL2 IP address for C:\windows\system32\drivers\etc\hosts can be determined by one of below commands:

wsl.exe hostname -I
wsl.exe -- ip -4 a show dev eth0 scope global

It may be a solution: microsoft/WSL#4210 (comment)

Flannel

Flannel is the CNI for MicroK8S, if HA is disabled (if HA is enabled, Calico is the CNI). So, this solution disables HA in MicroK8S automatically.

Flannel on Vagrant+kubeadm is deployed automatically.

Flannel cannot be deployed on KinD, because a binary is missing on the nodes. See more details:

Flannel on MicroK8s

The microk8s inspect returns errors:

 FAIL:  Service snap.microk8s.daemon-flanneld is not running
For more details look at: sudo journalctl -u snap.microk8s.daemon-flanneld
 FAIL:  Service snap.microk8s.daemon-etcd is not running
For more details look at: sudo journalctl -u snap.microk8s.daemon-etcd
  Copy service arguments to the final report tarball

Because of why, the daemon was unable to start:

$ systemctl status snap.microk8s.daemon-flanneld.service
● snap.microk8s.daemon-flanneld.service - Service for snap application microk8s.daemon-flanneld
     Loaded: loaded (/etc/systemd/system/snap.microk8s.daemon-flanneld.service; enabled; vendor preset: enabled)
     Active: inactive (dead) since Sat 2021-01-16 18:59:25 CET; 7min ago
    Process: 20890 ExecStart=/usr/bin/snap run microk8s.daemon-flanneld (code=exited, status=0/SUCCESS)
   Main PID: 20890 (code=exited, status=0/SUCCESS)

jan 16 18:59:25 ubuntu-20 systemd[1]: Started Service for snap application microk8s.daemon-flanneld.
jan 16 18:59:25 ubuntu-20 systemd[1]: snap.microk8s.daemon-flanneld.service: Succeeded.

Workaround: Uninstall MicroK8s (with --purge), install it again, restart the computer.

pgillich / kind-on-dev