Skip to main content
Skip table of contents

Install Overview

Prepare Your Environment for Install:

Follow the steps below to install the basic package requirements for your environment to achieve a successful install of DKP. Next install DKP, and then you can begin any custom configurations based on your environment.

  1. Install required packages. In most cases, you can install the required software using your preferred package manager. For example, on a macOS computer, you can use Homebrew to install kubectl and the aws command-line utility by running the following command:

    brew install kubernetes-cli awscli
  2. Check the Kubernetes client version. Many important Kubernetes functions do not work if your client is outdated. You can verify that the version of kubectl you have installed is supported by running the following command:

    kubectl version --short=true
  3. Check supported Kubernetes versions after finding your version with the command above.

  4. For air-gapped, create a bastion host for the cluster nodes to use within the air-gapped network. This bastion host needs access to a local registry in lieu of an Internet connection for pulling images. The recommended template naming pattern is ../folder-name/dkp-e2e-bastion-template or similar. Each infrastructure provider has its own set of bastion host instructions. Refer to your provider’s site for details - Azure, AWS, GCP, or vSphere.

  5. For creating DKP machine images, you need to download Konvoy Image Builder and extract it.

  6. To download DKP, see the Download topic for information. You will need to download and extract the DKP binary package tarball.

  7. Verify you have valid cloud provider security credentials to deploy the cluster on that platform.

This step regarding provider security credentials is not required if you are installing DKP on an on-premises environment. For information about installing in an on-premises environment, see Install Pre-provisioned.

  1. Install Konvoy depending on which infrastructure you have. Consult the Day 1 - Basic Installs by Infrastructure for provider specific installs. To use customized YAML and other advanced features, consult the Custom Installation and Additional Infrastructure Tools section of the documentation for steps on creating a customized cluster with the Konvoy component of DKP using YAML. Find your infrastructure provider listed in that section.

  2. Now that you have a basic Kubernetes cluster installed through Konvoy, configure the Kommander component.

  3. Lastly, continue with initializing the configuration file under the Kommander Installer Configuration File component of DKP.

You may also want to test operations by deploying a simple, sample application, customizing the cluster configuration, or checking the status of cluster components.

Next Step:

Prerequisites for Install

JavaScript errors detected

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

If this problem persists, please contact our support.