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 system's are capable of running Konvoy.

This section describes how to use the 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. The 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.

Prerequisites

Before you begin, you must ensure your versions of KIB and DKP are compatible:

  • Check the supported DKP version and download the Konvoy Image Builder bundle from the KIB Version section of the chart below (prefixed with konvoy-image-bundle) for your Operating System.

  • Create a working Docker setup.

Compatible 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.

DKP Version

KIB Version (Click for bundle download)

v2.4.0

v1.24.2

v2.3.1

v1.19.12

v2.3.0

v1.19.12

v2.2.2

v1.17.4

v2.2.1

v1.13.2

v2.2.0

v1.11.0

v2.1.5

v1.5.2

v2.1.4

v1.5.0

v2.1.3

v1.5.0

v2.1.2

v1.5.0

v2.1.1

v1.5.0

v2.1.0

v1.5.0

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.