training-minikube

This project contains files to extend the original container image with Jupyter notebooks, including a bash kernel, Systemd service file and a Go development environment.

Minikube is the testbed to test Kubernetes, Jupyter is the standard for using notebooks running complex scenarios.

Goals

The intended use is for trainings, where Minikube is running a Kubernetes environment inside a container using Jupyter notebooks as lessons. Go has been added to build tools and applications for Kubernetes, like kube-bench on the fly using go get ....

Requirements

The image and the scripts have been tested using

• Ubuntu 20.4.3 LTS
• Docker Community 19.03.12
• derived from Minikube version v1.23.2 using container image gcr.io/k8s-minikube/kicbase:v0.0.27
• Go version go1.17.3
• Kubernetes version used inside 1.22.2

Especially the minikube version must fit to the image version! If some of the services are failing or restarting, please check the version numbers!

Other operating systems should work, but have not been tested. Inside the container another Docker runtime is used to run Kubernetes pods. Cri-o and containerd should work and can be tested as far as Minikube is supporting them.

Installation

Setup environment

0. Make free space available

   Make sure you've got at least 5 GiB free space available.

1. Install minikube

   Follow https://minikube.sigs.k8s.io/docs/start/ for the mainstream linux distributions. To install it on Arch Linux run pacman -S minikube.

2. Fix permissions to run minikube with docker-driver:

   sudo usermod -aG docker $USER && newgrp docker
   

Modify environment

Docker

Make sure you've got docker installed and you are member of the docker-group.

gpasswd -a $USERNAME docker

Fedora 33

Please make sure you run your kernel with cgroups v1. Using cgroups v2 will break the build-script.

Please pass systemd.unified_cgroup_hierarchy=0 to the kernel for newer Fedoras >= 31 in /etc/sysconfig/grub (Red Hat) to disable cgroups v1.

Configure SELinux via /etc/selinux/config to be permissive.

SELINUX=permissive

Remove the corresponding setting for the docker daemon in /etc/sysconfig/docker.

# OPTIONS="--selinux-enabled
OPTIONS="
  --log-driver=journald \
  --storage-driver=overlay2 \
  --live-restore \
  --default-ulimit nofile=1024:1024 \
  --init-path /usr/libexec/docker/docker-init \
  --userland-proxy-path /usr/libexec/docker/docker-proxy \
"

Build and Run image

1. Clone this repository

   git clone https://github.com/thomasfricke/training-minikube
   

   .
   ├── audit-policy.yaml
   ├── bin                            # Scripts
   ├── Dockerfile
   ├── fsroot                         # Filesystem for the Docker Image
   .
   .
   .
   └── share
       └── notebooks                  # Place for the notebooks
           └── HelloWorld.ipynb
   

2. Setup default local environment

   bin/setup installs kubectl and minikube. MINIKUBE_VERSION:=v1.16.0 bin/setup chooses a specific minikube version.

3. Build local image

   Run the bin/build script. This creates a local container image tagged training-minikube.

4. Start minikube

   Boot minikube with bin/start. It shows the url to access the Jupyter notebooks. Copy the url.

   😄  minikube v1.16.0 on Arch rolling
   ✨  Using the docker driver based on user configuration
   ❗  docker is currently using the overlay storage driver, consider switching to overlay2 for better performance
   👍  Starting control plane node minikube in cluster minikube
   🔥  Creating docker container (CPUs=4, Memory=8192MB) ...
   🐳  Preparing Kubernetes v1.20.0 on Docker 20.10.2 ...
       ▪ Generating certificates and keys ...
       ▪ Booting up control plane ...
       ▪ Configuring RBAC rules ...
   🔎  Verifying Kubernetes components...
   🌟  Enabled addons: storage-provisioner, default-storageclass
   
   ❗  /home/d/bin/kubectl is version 1.7.0, which may have incompatibilites with Kubernetes 1.20.0.
       ▪ Want kubectl v1.20.0? Try 'minikube kubectl -- get pods -A'
   🏄  Done! kubectl is now configured to use "minikube" cluster and "default" namespace by default
   open the URI
   
                   http://192.168.49.2:8888/lab?token=52b93e80e5a6e8577e20efc3af4fa87f92cc1f17669db025
   
           # or if you use X11
   
                   echo "http://192.168.49.2:8888/lab?token=52b93e80e5a6e8577e20efc3af4fa87f92cc1f17669db025" | xclip -selection clipboard
   
   to connect to Jupyterlab in Minikube
   

5. Open a browser on your local machine

   Paste url in your browser. If it fails to execute the commands, please try another one.

6. Download Jupyter-Notebooks

   Download notebooks and place the *.ipynb files in share/notebooks/. The directory is mounted into the "minikube"-container.

Other commands

Reset "minikube" environment

bin/reset

Stop minikube

bin/stop

Reset and start a fresh instance in one go

bin/reset && bin/start

Run "minikube" with audit backend

bin/start_audit

Run "minikube" with calico networks

bin/start_calico