Prerequisites for Install

Before you create a DKP image and deploy the initial DKP cluster, the operator's machine is required to be either an OSX or Linux-based machine of a supported version. Ensure you have all the prerequisites met for both the Konvoy and Kommander component.

Additional prerequisites are necessary for air-gapped, so verify that you have all non-air-gapped met and then any additional air-gapped prerequisites listed after non-air-gapped.

If not already done, refer to Get Started section of the documentation for:

• Resource Requirements

• Install Overview

Prerequisites for the Konvoy Component

For DKP and Konvoy Image Builder to run, the operator machine requires:

Non-air-gapped (all environments)

In a non-air-gapped environment, your environment has two-way access to and from the Internet. Below are the prerequisites required if installing in a non-air-gapped environment:

• An x86_64-based Linux or macOS machine.

• The dkp binary on the bastion by downloading. To check which version of DKP you installed for compatibility reasons, run the dkp version command (dkp version).

• A Container engine/runtime installed is required to install DKP:

  • Version Docker® container engine version 18.09.2 or higher installed for Linux or MacOS - On macOS, Docker runs in a virtual machine which needs configured with at least 8 GB of memory.

  • Version 4.0 of Podman or higher for Linux. Host requirements found here: Host Requirements

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

• Konvoy Image Builder (KIB)

• Valid Provider account with credentials configured.

  • AWS credentials configured that can manage CloudFormation Stacks, IAM Policies, IAM Roles, and IAM Instance Profiles

  • Azure credentials configured

• CLI tooling of the cloud provider being used to deploy DKP commands:

  • aws-cli

  • googlecloud-cli

  • azure-cli

• EKS and AKS only a self-managed cluster is required:

  • If you follow Day 1 - Basic Installation instructions for install, you use the --self-managed flag and therefore have a self-managed cluster. If you use the instructions under Custom Installation and Additional Infrastructure Tools, ensure you perform the self-managed process on your new cluster:

  • A Self-managed AWS Cluster

  • A Self-managed Azure Cluster

• Pre-provisioned on Premises only:

  • Pre-provisioned hosts with SSH access enabled.

  • An unencrypted SSH private key, whose public key is configured on the above hosts.

  • Pre-provisioned Override Files if needed.

• vSphere only:

  • A valid VMware vSphere account with credentials configured.

DKP requires permissions for the cloud provider that is being used. See the Supported Infrastructure Operating Systems page for further setup requirements.

Air-gapped Only (additional requirements)

In an air-gapped environment, your environment is isolated from unsecured networks, like the Internet, and therefore require additional considerations for installation. Below are the additional prerequisites required if installing in an air-gapped environment:

• Linux machine (bastion) that has access to the existing VPC. (Instead of An x86_64-based Linux or macOS machine).

• Ability to download artifacts from the internet and then copy those onto your bastion machine.

• Download the Complete DKP Air-gapped Bundle for this release - dkp-air-gapped-bundle_v2.6.2_linux_amd64.tar.gz.

• An existing local registry to seed the air-gapped environment.

Prerequisites for Kommander Component

To install the Kommander component of DKP, ensure you meet the following prerequisites:

Non-air-gapped (all environments)

In a non-air-gapped environment, your environment has two-way access to and from the Internet. Below are the prerequisites required if installing in a non-air-gapped environment:

• The version of the CLI that matches the DKP version you want to install.

• Review the Management Cluster Application Requirements and Workspace Platform Application Defaults and Resource Requirements to ensure that your cluster will have sufficient resources.

• Ensure you have a default StorageClass configured (the Konvoy component is responsible for configuring one)

• A load balancer to route external traffic. In cloud environments, this is provided by your cloud provider. In on-premises and vSphere deployments, you can configure MetalLB. It is possible to use Virtual IP also. See Load Balancing topic for more details.

NOTE: If you want to customize your cluster’s domain or certificate, ensure you review the respective documentation sections:

• Configure custom domains and certificates during the Kommander installation

• Configure custom domains and certificates after Kommander has been installed

• For pre-provisioned on-premise environments:

  • Ensure you meet the Storage requirements, default storage class and Application Storage.

  • Ensure you have added at least 40 GB of raw storage to each of your worker nodes in your clusters.

Air-gapped Only (additional requirements)

In an air-gapped environment, your environment is isolated from unsecured networks, like the Internet, and therefore require additional considerations for installation. Below are the additional prerequisites required if installing in an air-gapped environment:

• A local registry containing all the necessary installation images, including the Kommander images which were downloaded in the air-gapped bundle above - dkp-air-gapped-bundle_v2.6.2_linux_amd64.tar.gz. See the pages for Load the Registry under each provider in the Day 1 - Basic Installs by Infrastructure section for how to push the necessary images to this registry.

• Connectivity with the clusters attaching to the management cluster:

  • Both management and attached clusters must be able to connect to the registry.

  • The management cluster must be able to connect to all attached cluster’s API servers.

  • The management cluster must be able to connect to any load balancers created for platform services on the management cluster.

NOTE: If you want to customize your cluster’s domain or certificate, ensure you review the respective documentation sections:

• Configure custom domains and certificates during the Kommander installation

• Configure custom domains and certificates after Kommander has been installed

• For pre-provisioned on-premise environments:

  • Ensure you meet the Storage requirements.

  • Ensure you have added at least 40 GB of raw storage to each of your worker nodes in your cluster.

Next Step:

Day 1 - Basic Installs by Infrastructure

Proceed to the Day 1 - Basic Installation combinations to install and setup DKP based on your infrastructure environment provider.