Setting up kubernetes cluster on raspberry pi
While Kubernetes is often experienced through the virtual world of public cloud computing, it can be very rewarding experience to physically build a kubernetes cluster. This article is all about the steps needed to setup a k8s cluster on a raspberry pi. And Yes — you can create a Kubernetes cluster with Raspberry Pis with the default operating system Raspbian. This means you can carry on using all the tools and packages you’re used to with the officially-supported OS.
Pre-reqs:
- You must use an RPi 2 or 3 for use with Kubernetes
- I’m assuming you’re using wired ethernet (Wi-Fi also works, but it’s not recommended)
- You must have a Raspbean OS running on yout raspberry pi (Raspbian Jessie recommented)
Lets talk a bit on kubernetes (k8s)
Kubernetes is a powerful open-source system, initially developed by Google, for managing containerized applications in a clustered environment. It aims to provide better ways of managing related, distributed components and services across varied infrastructure.
At its basic level, k8s is a system for running and coordinating containerized applications across a cluster of machines. It is a platform designed to completely manage the life cycle of containerized applications and services using methods that provide predictability, scalability, and high availability.
The picture shown below gives some idea of the architecture of a kubernetes system.
Master node setup
- Change hostname
Use the raspi-config
utility to change the hostname to k8s-master-1 or similar and then reboot.
- Set a static IP address
It’s not fun when your cluster breaks because the IP of your master changed. The master’s certificates will be bound to the IP address, so let’s fix that problem ahead of time:
cat >> /etc/dhcpcd.conf
Paste this block:
profile static_eth0
static ip_address=192.168.0.100/24
static routers=192.168.0.1
static domain_name_servers=8.8.8.8
Hit Control + D.
Change 100 for 101, 102, 103 etc.
You may also need to make a reservation on your router’s DHCP table so these addresses don’t get given out to other devices on your network.
- Install Docker Take care while installing docker, ned to make sure the latest verified docker version by kubernetes, here i am adding code for bth downloadng latest version as well as specified version (I spend a lot time figuring out the version mismatch issue)
Use the specified docker version
export VERSION=18.03 && curl -sSL get.docker.com | sh && \
sudo usermod pi -aG docker
Download the latest docker version
$ curl -sSL get.docker.com | sh && \
sudo usermod pi -aG docker
newgrp docker
- Disable swap
For Kubernetes 1.7 and onwards you will get an error if swap space is enabled.
Turn off swap:
$ sudo dphys-swapfile swapoff && \
sudo dphys-swapfile uninstall && \
sudo update-rc.d dphys-swapfile remove
This should now show no entries:
$ sudo swapon --summary
- Edit
/boot/cmdline.txt
Add this text at the end of the line, but don’t create any new lines:
You can use vim (or any editor of you choice (nano))
sudo vim /boot/cmdline.txtcgroup_enable=cpuset cgroup_memory=1 cgroup_enable=memory
Now reboot — do not skip this step.
- Add repo lists & install
kubeadm
$ curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | sudo apt-key add - && \
echo "deb http://apt.kubernetes.io/ kubernetes-xenial main" | sudo tee /etc/apt/sources.list.d/kubernetes.list && \
sudo apt-get update -q && \
sudo apt-get install -qy kubeadm
I realise this says ‘xenial’ in the apt listing, don’t worry. It still works.
Initialize your master node
- You now have two new commands installed:
- kubeadm — used to create new clusters or join an existing one
- kubectl — the CLI administration tool for Kubernetes
If using Weave Net
- Initialize your master node:
$ sudo kubeadm init --token-ttl=0
If using Flannel:
- Initialize your master node with a Pod network CIDR:
$ sudo kubeadm init --token-ttl=0 --pod-network-cidr=10.244.0.0/16
We pass in --token-ttl=0
so that the token never expires - do not use this setting in production. The UX for kubeadm
means it's currently very hard to get a join token later on after the initial token has expired.
Optionally also pass
--apiserver-advertise-address=192.168.0.27
with the IP of the Pi as found by typingifconfig
.
Note: This step can take a long time, even up to 15 minutes.
Sometimes this stage can fail, if it does then you should patch the API Server to allow for a higher failure threshold during initialization around the time you see [controlplane] wrote Static Pod manifest for component kube-apiserver to "/etc/kubernetes/manifests/kube-apiserver.yaml"
sudo sed -i 's/failureThreshold: 8/failureThreshold: 20/g' /etc/kubernetes/manifests/kube-apiserver.yaml
After the init
is complete run the snippet given to you on the command-line:
mkdir -p $HOME/.kube
sudo cp -i /etc/kubernetes/admin.conf $HOME/.kube/config
sudo chown $(id -u):$(id -g) $HOME/.kube/config
This step takes the key generated for cluster administration and makes it available in a default location for use with kubectl
.
- Now save your join-token
Your join token is valid for 24 hours, so save it into a text file. Here’s an example of mine:
$ kubeadm join --token 9e700f.7dc97f5e3a45c9e5 192.168.0.27:6443 --discovery-token-ca-cert-hash sha256:95cbb9ee5536aa61ec0239d6edd8598af68758308d0a0425848ae1af28859bea
- Check everything worked:
$ kubectl get pods --namespace=kube-system
NAME READY STATUS RESTARTS AGE
coredns-576cbf47c7-n85xt 1/1 Running 0 6m25s
coredns-576cbf47c7-rq6lc 1/1 Running 0 6m25s
etcd-raspberrypi 1/1 Running 0 5m55s
kube-apiserver-raspberrypi 1/1 Running 1 7m57s
kube-controller-manager-raspberrypi 1/1 Running 0 7m58s
kube-proxy-w26jz 1/1 Running 0 6m25s
kube-scheduler-raspberrypi 1/1 Running 0 5m47s
weave-net-wdq4f 2/2 Running 0 2m39s
You should see the “READY” count showing as 1/1 for all services as above. DNS uses three pods, so you’ll see 3/3 for that.
Setup networking with Weave Net or Flannel
Some users have reported stability issues with Weave Net on ARMHF. These issues do not appear to affect x86_64 (regular PCs/VMs). You may want to try Flannel instead of Weave Net for your RPi cluster.
Weave Net
Install Weave Net network driver
$ kubectl apply -f \
"https://cloud.weave.works/k8s/net?k8s-version=$(kubectl version | base64 | tr -d '\n')"
If you run into any issues with Weaveworks’ networking then flannel is also a popular choice for the ARM platform.
Flannel (alternative)
Apply the Flannel driver on the master:
$ kubectl apply -f https://raw.githubusercontent.com/coreos/flannel/c5d10c8/Documentation/kube-flannel.yml
On each node that joins including the master:
$ sudo sysctl net.bridge.bridge-nf-call-iptables=1
Adding Worker Nodes
On the other RPis, repeat everything apart from kubeadm init
.
- Change hostname
Use the raspi-config
utility to change the hostname to k8s-worker-1
or similar and then reboot.
- Join the cluster
Replace the token / IP for the output you got from the master node, for example:
$ sudo kubeadm join --token 1fd0d8.67e7083ed7ec08f3 192.168.0.27:6443
You can now run this on the master:
$ kubectl get nodes
NAME STATUS AGE VERSION
k8s-1 Ready 5m v1.7.4
k8s-2 Ready 10m v1.7.4
Deploy a container
This container will expose a HTTP port and convert Markdown to HTML. Just post a body to it via curl
- follow the instructions below.
function.yml
apiVersion: v1
kind: Service
metadata:
name: markdownrender
labels:
app: markdownrender
spec:
type: NodePort
ports:
- port: 8080
protocol: TCP
targetPort: 8080
nodePort: 31118
selector:
app: markdownrender
---
apiVersion: apps/v1beta1 # for versions before 1.6.0 use extensions/v1beta1
kind: Deployment
metadata:
name: markdownrender
spec:
replicas: 1
template:
metadata:
labels:
app: markdownrender
spec:
containers:
- name: markdownrender
image: functions/markdownrender:latest-armhf
imagePullPolicy: Always
ports:
- containerPort: 8080
protocol: TCP
Deploy and test:
$ kubectl create -f function.yml
Once the Docker image has been pulled from the hub and the Pod is running you can access it via curl
:
$ curl -4 http://127.0.0.1:31118 -d "# test"
<p><h1>test</h1></p>
If you want to call the service from a remote machine such as your laptop then use the IP address of your Kubernetes master node and try the same again.
Start up the Kubernetes dashboard
The dashboard can be useful for visualising the state and health of your system, but it does require the equivalent of “root” in the cluster. If you want to proceed you should first run in a ClusterRole from the docs.
echo -n 'apiVersion: rbac.authorization.k8s.io/v1beta1
kind: ClusterRoleBinding
metadata:
name: kubernetes-dashboard
labels:
k8s-app: kubernetes-dashboard
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: ClusterRole
name: cluster-admin
subjects:
- kind: ServiceAccount
name: kubernetes-dashboard
namespace: kube-system' | kubectl apply -f -
This is the development/alternative dashboard which has TLS disabled and is easier to use.
$ kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/master/src/deploy/alternative/kubernetes-dashboard-arm.yaml
You can then find the IP and port via kubectl get svc -n kube-system
. To access this from your laptop you will need to use kubectl proxy
and navigate to http://localhost:8001/
on the master, or tunnel to this address with ssh
.
See also: Kubernetes Dashboard docs.
Summary
You should now have an operational Kubernetes master and several worker nodes ready to accept workloads.
Now let’s head back over to the tutorial and deploy OpenFaaS to put the cluster through its paces with Serverless functions.
See also: Kubernetes documentation
You can find the automated scripts and other necessary at : https://github.com/sonujose/kubernetes_raspberrypi
This chapter is an adaptation of https://github.com/teamserverless/k8s-on-raspbian