Skip to main content
Skip table of contents

Create a Base OS image in vSphere

Creating a base OS image from DVD ISO files is a one-time process. Building a base OS image creates a base vSphere template in your vSphere environment. The base OS image is used by Konvoy Image Builder (KIB) to create a VM template to configure Kubernetes nodes by the DKP vSphere provider.

Create the Base OS Image

For vSphere, a username and password is populated by SSH_USERNAME and the user can use authorization via SSH_PASSWORD or SSH_PRIVATE_KEY_FILE environment variables and required by default for packer. This user should have administrator privileges. It is possible to configure a custom user and password when building the OS image, however, it requires the Konvoy Image Builder (KIB) configuration to be overridden.

While creating the base OS image, it is important to take into consideration the following elements:

  • Storage configuration: D2iQ recommends customizing disk partitions and not configuring a SWAP partition.

  • Network configuration: as KIB must download and install packages, activating the network is required.

  • Connect to Red Hat: if using RHEL, registering with Red Hat is required to configure software repositories and install software packages.

  • Software selection: D2iQ recommends choosing Minimal Install.

  • DKP recommends to install with the packages provided by the operating system package managers. Use the version that corresponds to the major version of your operating system.

  • DKP advises not to use usernames and passwords for security reasons, but instead to use private and public keys. If that is not possible, passwords should be generated and a minimum of 20 characters long.

Disk Size

For each cluster you create using this base OS image, ensure you establish the disk size of the root file system based on:


Clusters are created with a default disk size of 80 GB.

For clusters created with the default disk size, the base OS image root file system must be exactly 80 GB. The root file system cannot be reduced automatically when a machine first boots.


You can specify a disk size when you create a cluster (see the flags of the create cluster vsphere command). This allows you to use one base OS image to create multiple clusters that have different storage requirements.

Before specifying a disk size when you create a cluster, take into account:

  1. For some base OS images, the disk size option has no effect on the size of the root file system. This is because some root file systems, for example, those contained in an LVM Logical Volume, cannot be resized automatically when a machine first boots.

  2. The specified disk size must be equal to, or larger than the size of the base OS image root file system. This is because a root file system cannot be reduced automatically when a machine first boots.

Next Step:

Create a VM Template

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.