Building the minikube ISO

Overview

The minikube ISO is booted by each hypervisor to provide a stable minimal Linux environment to start Kubernetes from. It is based on coreboot, uses systemd, and includes all necessary container runtimes and hypervisor guest drivers.

Prerequisites

  • A recent Go distribution (>=1.12)
  • If you are on Windows, you’ll need Docker to be installed.
  • 4GB of RAM
  • Build tools:

    sudo apt-get install build-essential gnupg2 p7zip-full git wget cpio python \
    unzip bc gcc-multilib automake libtool locales

Additionally, if you are on Fedora, you will need to install glibc-static:

sudo dnf install -y glibc-static

Downloading the source

git clone https://github.com/kubernetes/minikube.git
cd minikube

Building

$ make buildroot-image
$ make out/minikube.iso

The build will occur inside a docker container. If you want to do this on baremetal, replace make out/minikube.iso with IN_DOCKER=1 make out/minikube.iso. The bootable ISO image will be available in out/minikube.iso.

Using a local ISO image

$ ./out/minikube start --iso-url=file://$(pwd)/out/minikube.iso

Modifying buildroot components

To change which Linux userland components are included by the guest VM, use this to modify the buildroot configuration:

cd out/buildroot
make menuconfig
make

To save these configuration changes, execute:

make savedefconfig

The changes will be reflected in the minikube-iso/configs/minikube_defconfig file.

Adding kernel modules

To make kernel configuration changes and save them, execute:

$ make linux-menuconfig

This will open the kernel configuration menu, and then save your changes to our iso directory after they’ve been selected.

Adding third-party packages

To add your own package to the minikube ISO, create a package directory under iso/minikube-iso/package. This directory will require at least 3 files:

<package name>.mk - A Makefile describing how to download the source code and build the program <package name>.hash - Checksums to verify the downloaded source code Config.in - buildroot configuration.

For a relatively simple example to start with, you may want to reference the podman package.

Continuous Integration Builds

We publish CI builds of minikube, built at every Pull Request. Builds are available at (substitute in the relevant PR number):

We also publish CI builds of minikube-iso, built at every Pull Request that touches deploy/iso/minikube-iso. Builds are available at:

Last modified August 9, 2019: Improve contrib doc organization (3cf9fcaab)