Install Kommander

Prerequisites

Before installing Kommander:

Ensure you have the version of the CLI that matches the DKP version you want to install.
You have configured a Konvoy cluster using the Advanced Konvoy Configuration for infrastructure provider specific instructions on building a cluster-based on environment.
Review the Management Cluster Application Requirements and Workspace Platform Application Defaults and Resource Requirements to ensure that your cluster has sufficient resources.
Ensure you have a default StorageClass configured as shown below.
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

Configure a Default StorageClass

The cluster where Kommander is installed must have a default StorageClass configured. Use the following command to verify one is configured:

CODE

kubectl get sc

The output should look similar to this. Note the (default) after the name:

CODE

NAME               PROVISIONER       RECLAIMPOLICY   VOLUMEBINDINGMODE      ALLOWVOLUMEEXPANSION   AGE
ebs-sc (default)   ebs.csi.aws.com   Delete          WaitForFirstConsumer   false                  41s

If the desired StorageClass is not set as default, add the following annotation to the StorageClass manifest:

CODE

annotations:
  storageclass.kubernetes.io/is-default-class: "true"

More information on setting a StorageClass as default can be found at Changing the default storage class in the Kubernetes documentation.

Install Kommander

To customize your Kommander installation, see the Kommander Install Configuration for more details.

Before running the commands below, ensure that your kubectl configuration references the cluster on which you want to install Kommander, otherwise it will install on the bootstrap cluster. You can do this by setting the KUBECONFIG environment variable to the appropriate kubeconfig file’s location.

NOTE: An alternative to initializing the KUBECONFIG environment variable as stated earlier is to use the --kubeconfig=cluster_name.conf flag. This ensures that Kommander is installed on the correct cluster.

Install Kommander:

CODE

dkp install kommander

TIP: Sometimes, applications require a longer period of time to deploy, which causes the installation to time out. Add the --wait-timeout <time to wait> flag and specify a period of time (for example, 1h) to allocate more time for the deployment of applications.

Verify Installation

Once the Konvoy cluster is built and Kommander has been installed, you will want to verify your installation of Kommander in that section of documentation.

For other environments, see the section of documentation called Advanced Kommander Configuration.

Next Step

Log in to the UI with Kommander