Skip to main content
Skip table of contents

vSphere Prerequisites

Prepare your environment to run DKP with VMware vSphere

Fulfilling the prerequisites involves completing these areas:

  • DKP prerequisites

  • vSphere prerequisites

DKP Prerequisites

Before using DKP to create a vSphere cluster, verify that you have:

  • An x86_64-based Linux® or macOS® machine.

  • Download DKP binaries and Konvoy Image Builder (KIB) image bundle for Linux or macOS.

  • Docker® version 18.09.2 or later installed. You must have Docker installed on the host where the DKP Konvoy CLI runs. For example, if you are installing Konvoy on your laptop, ensure the laptop has a supported version of Docker.

On macOS, Docker runs in a virtual machine. Configure this virtual machine with at least 8GB of memory.

  • kubectl for interacting with the running cluster, installed on the host where the DKP Konvoy command line interface (CLI) runs.

  • A valid VMware vSphere account with credentials configured.

VMware vSphere Prerequisites

Before installing, verify that your VMware vSphere Client environment meets the following basic requirements:

  • Access to a bastion VM, or other network connected host, running vSphere Client version v6.7.x with Update 3 or later version

    • You must be able to reach the vSphere API endpoint from where the Konvoy command line interface (CLI) runs.

  • vSphere account with credentials configured - this account must have Administrator privileges.

  • A RedHat® subscription with user name and password for downloading DVD ISOs

  • For air-gapped environments, a bastion VM host template with access to a configured Docker registry

  • Valid vSphere values for the following:

    • vCenter API server URL

    • Datacenter name

    • Zone name that contains ESXi hosts for your cluster’s nodes

    • Datastore name for the shared storage resource to be used for the VMs in the cluster.

      • Use of PersistentVolumes in your cluster depends on Cloud Native Storage (CNS), available in vSphere v6.7.x with Update 3 and later versions. CNS depends on this shared Datastore’s configuration.

    • Datastore URL from the datastore record for the shared datastore you want your cluster to use.

      • You need this URL value to ensure that the correct Datastore is used when DKP creates VMs for your cluster in vSphere.

    • Folder name

    • Base template name, such as base-rhel-8, or base-rhel-7

    • Name of a Virtual Network that has DHCP enabled for both air-gapped and non air-gapped environments

    • Resource Pools - at least one resource pool needed, with every host in the pool having access to shared storage, such as VSAN

      • Each host in the resource pool needs access to shared storage, such as NFS or VSAN, to make use of MachineDeployments and high-availability control planes.

Air-Gapped Registry Prerequisites

JFrog Artifactory

If you use Jfrog Artifactory or Jfrog Container Registry, you must update to a new version of the software. Any build newer than version 7.11 will work, as we have confirmed that older versions are not compatible.

Nexus Registry

If you use Nexus Registry, there is currently an issue that prevents usage with DKP 2.X and OCI Images. Support for OCI Images was added here in this publicly available Jira ticket:

A new issue was filed here determining that OCI image support is currently broken:

You can track this Jira link for status on a resolution for this issue.

Harbor Registry

Any newer version than Harbor Registry v2.1.1-5f52168e will support OCI images. 

The next step is:

JavaScript errors detected

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

If this problem persists, please contact our support.