Konvoy Image Builder (KIB) is a complete solution for building Cluster API compliant images. The goal of Konvoy Image Builder is to produce a common operating surface to run Konvoy across heterogeneous infrastructure. KIB relies on ansible to install software, configure, and sanitize systems for running Konvoy. Packer is used to build images for cloud environments. Goss is used to validate systems are capable of running Konvoy.
This section describes how to use KIB to create a Cluster API compliant machine images. Machine images contain configuration information and software to create a specific, pre-configured, operating environment. For example, you can create an image of your current computer system settings and software. The machine image can then be replicated and distributed, creating your computer system for other users. KIB uses variable overrides to specify base image and container images to use in your new machine image. The variable overrides files for Nvidia and FIPS can be ignored unless adding an overlay feature.
Before you begin, you must ensure your versions of KIB and DKP are compatible:
Check the supported DKP version.
Check the Supported Infrastructure Operating Systems.
Download the Konvoy Image Builder bundle from the KIB Version column of the chart below for your version of DKP prefixed with
konvoy-image-bundlefor your Operating System.
Create a working
Compatible DKP to KIB Versions
Along with the KIB Bundle, we publish a file containing checksums for the bundle files. The recommendation for using these checksums is to verify the integrity of the downloads.
On the link, download the package prefixed with
konvoy-image-bundlefor your OS.
KIB Version (Click for bundle download)
KIB will run and print out the name of the created image for your infrastructure provider as shown on specific provider KIB pages below. Use this name when creating a Kubernetes cluster.