Skip to content
Branch: master
Find file History

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
scripts
.dockerignore
DEPLOYMENT.md
Dockerfile.tmpl
INSTRUCTIONS.md
README.md
azuredeploy-advanced.json
azuredeploy-simple.json
porter.yaml

README.md

Setups up Kubernetes and Tiller on a Raspberry Pi cluster using k3s

This bundle installs the lightweight Kubernetes distribution k3s onto a cluster of Raspberry Pi devices, and configures Tiller on the cluster so you can use Helm to install Kubernetes applications.

Prerequisites

In order to use this bundle, you must first prepare your Raspberry Pi device(s).

(Note - this bundle has been tested with Raspberry Pi 4)

Follow these steps to prepare each Pi device you want to use in the cluster:

Flash SD card

Download and install balanaEtcher then use the program to flash the Rasbpian Lite image onto a mounted SD card.

Configure SSH and wifi

Follow the instructions here to add files to boot partition of the SD card so that the Pi will automatically connect to your wifi network and enable SSH on first boot.

Insert the SD card into the Pi and power it on.

Update Pi config

Connect to the Pi via SSH. By default, the username will be pi and the hostname will be raspberrypi so you can connect using:

ssh pi@raspberrypi

The default password will be raspberry.

Open the Raspberry Pi config UI using:

sudo raspbi-config

In the config UI, update the password to something more secure, and update the hostname (hint: if using multiple Pis in the cluster, give them identifiable names, e.g. pi-master, pi-node-01, etc.).

Reboot the Pi.

Add SSH key

You will need to upload the public part of an SSH key to the Pi. Later, we will use the private key for authenticating with the Pi. Use the same SSH key for each Pi.

If you haven't got an SSH key generated, you can generate one using:

ssh-keygen

Upload the public key to the Pi using the following commands:

ssh pi@<hostname> mkdir ~/.ssh
scp <path-to-public-key> pi@<hostname>:~\.ssh\authorized_keys

Running the bundle

Once the Raspberry Pi devices are setup according the instructions above, the bundle can be installed.

It's important to note that unless the Raspberry Pi devices are accessible via the Internet (see Tunnelling to Pis below), then you will have to run this bundle locally on a device connected to the same network as the Pis, and use the Docker driver for Porter (rather than the Azure driver).

You will need to have Porter and Docker installed locally, then you can use the following commands:

porter creds generate --tag cnabquickstarts.azurecr.io/porter/pi-k-three-s/bundle:latest

porter install --tag cnabquickstarts.azurecr.io/porter/pi-k-three-s/bundle:latest --cred pi-k-three-s --param master_ipAddress=<master_ipAddress>,workers_ipAddress=<workers_ipAddress>

See Parameters and Credentials below for more details on the parameters.

Tunneling to Pis

If you want to use the 'Deploy from Azure button' or 'Deploy from Cloud Shell' options below, you need to ensure that the master Raspberry Pi in your cluster is accessible from the Internet. The bundle uses the master Pi as a jumpbox to the worker Pi nodes, so only the master needs to be exposed.

Specifically, port 22 needs to be accessible for SSH and port 6443 for accessing the kubernetes API.

One option is to use a tunneling service, such as PiTunnel or ngrok, to create tunnels from the Pi for the 2 ports. If using PiTunnel, the steps would be as follows:

  1. Create a PiTunnel account at PiTunnel.com
  2. Upgrade to the Standard account (this enables static port numbers for tunnerls; this is necessary as the Pi will reboot as part of the installation, causing the port number to change if static port numbers aren't enabled)
  3. Install PiTunnel on the master Pi - curl https://pitunnel.com/install/b5KgouUVv | sudo python
  4. Create a (persistent) tunnel for SSH - pitunnel --port=22 --name=ssh --persist
  5. Create a (persistent) tunnel for kubernetes API - pitunnel --port=6443 --name=k8s --http --persist
  6. Go to the PiTunnel dashboard to find the tunnel URLs/ports

Deploy from Azure

You will need to create a service principal in order to use the 'Deploy from Azure' buttons.

For detailed instructions on deploying from Azure, including how to setup the service principal, see Consuming: Deploy from Azure

Simple deployment

Advanced deployment

Deploy from Cloud Shell

For detailed instructions on deploying from Cloud Shell, including how to setup the Cloud Shell environment, see Consuming: Deploy from Cloud Shell

porter install --tag cnabquickstarts.azurecr.io/porter/pi-k-three-s/bundle:latest -d azure

Parameters and Credentials

Name Description Default Required
master_host IP address or DNS name of the master Raspberry Pi node No
master_internal_IP Internal IP address of the master Raspberry Pi node No
master_kubernetes_host Host to use in kubeconfig file No
master_kubernetes_port Port to use in kubeconfig file No
master_port SSH port of the master Raspberry Pi node No
master_username Username for the master Raspberry Pi node No
porter-debug Print debug information from Porter when executing the bundle No
ssh_key Private ssh key for authenticating with all Raspberry Pis Yes
workers_host Comma-separated array of IP addresses or DNS names of the worker Raspberry Pi nodes, e.g. '192.168.0.60,192.168.0.61,192.168.0.62' No
workers_port Comma-separated array of ports of the worker Raspberry Pi nodes, e.g. '22,22,22,22' No
workers_username Comma-separated array of usernames for the worker Raspberry Pi nodes, e.g. 'pi,pi,pi' No
You can’t perform that action at this time.