This repo exists for showing some example installation and usage of Kubernetes, focusing on Windows, though it should work wherever you can install Virtual Box and Vagrant.
The reference system for this is using Windows 10 Pro version 1909, build 18363.1139. It has Docker Desktop 2.5 (which leverages Hyper-V) and Virtual Box 6.1 (which can work with Hyper-V). You should not need WSL in order to use the examples below, and you should only need either Virtual Box or Hyper-V in order to work with Multipass.
You will need to install Multipass (docs) to use the Multipass installations below. Before doing so, decide if you will want to use Hyper-V with it, or Virtual Box, and install whichever of those you would like first. Hyper-V can sometimes conflict with other software on your system.
If you want to use Kubernetes from your host OS, the following are recommended, though only kubectl is required:
- Install kubectl either by using Chocolatey or by downloading it and storing it as kubectl.exe somewhere in your path.
- Install helm using Chocolatey.
- Install jq either by using Chocolatey or by downloading it and storing it as jq.exe somewhere in your path.
- Install yq using Chocolatey.
You can also install command completion in PowerShell (not nearly as good as the Bash completion at this time, but still very useful) by running Install-Module -Name PSKubectlCompletion from an Administrator shell and then using Import-Module PSKubectlCompletion from the shell instance you will be using.
minikube is tried and true and has good plugin support in VS Code. It runs as services in Windows without a full VM, so it may use less resources than other solutions.
- Grab the installer and run it
- Start a shell running as Administrator and run
minikube start - Open a new shell
- If you use Windows Terminal you can open a new tab
k3s is a new option from Rancher that runs as a single binary, with most of the capabilities of a full Kubernetes cluster. To get it running in a Multipass VM and configure kubectl locally, run the following:
multipass launch --name k3s --cpus 4 --mem 4g --disk 20g
multipass exec k3s -- bash -c 'curl -sfL https://get.k3s.io | K3S_KUBECONFIG_MODE="644" sh -'
multipass exec k3s -- sudo bash -c 'apt-get update && su apt-get install jq -y'
multipass exec k3s -- sudo bash -c 'wget -O /usr/local/bin/yq -q https://github.com/mikefarah/yq/releases/download/3.4.1/yq_linux_amd64 && chmod +x /usr/local/bin/yq'
multipass exec k3s -- sudo bash -c 'wget -O /tmp/helm.tgz https://get.helm.sh/helm-v3.4.2-linux-amd64.tar.gz && cd /tmp && tar -zxf helm.tgz && mv linux-amd64/helm /usr/local/bin/'
$mpIP = (multipass list --format json | jq -r '.list[] | select(.name == \"k3s\") | .ipv4[0]')
((multipass exec k3s -- sudo cat /etc/rancher/k3s/k3s.yaml) -replace '127.0.0.1',$mpIP) | Set-Content -Path $env:USERPROFILE\.kube\configIf all pods are stuck pending and have an event with a message like "0/1 nodes are available: 1 node(s) had taint {node.cloudprovider.kubernetes.io/uninitialized: true}, that the pod didn't tolerate." you can remove the taint manually with the following:
kubectl taint nodes k3s node.cloudprovider.kubernetes.io/uninitialized-Credit to Jason Yee for his article Rancher 2.4 & Kubernetes on your Windows 10 laptop with multipass & k3s — Elasticsearch/Kibana in minutes!, which inspired this solution.
While minikube is great for basic Kubernetes functionality, if you want to be able to see how HA, anti-affinity, affinity, taints, tolerations, etc. work in a more realistic scenario, you need to have more than one worker. This cluster will give you a three node cluster, composed of one control plane node and two worker nodes. You should be able to launch the VMs and get them setup by running:
.\multipass\cluster-init.ps1Depending on how your system is set up, you may need to relax execution policies. To disable them outright, you can just run Set-ExecutionPolicy -ExecutionPolicy Unrestricted to allow the unsigned script to run.
Credit to Kanchana Wickremasinghe for his article Kubernetes Multi-Node Cluster with Multipass on Ubuntu 18.04 Desktop which was the base I created this off of.
If you end up with errors like "remote error: tls: bad record MAC" during image pull (and other activities) while using Multipass, it sounds like there may be some bugs with using WiFi with Hyper-V and/or WSL. I resolved this by plugging in an wired connection.