Skip to main content
Skip table of contents

vSphere: Install Kommander

You have installed the Konvoy component and created a cluster. Now it is time to Install Kommander which will allow you to access the UI and attach new or existing clusters to monitor.

Prerequisites

  • Ensure you have reviewed all Prerequisites for Install.

  • Ensure you have a default StorageClass.

  • Note down the name of the cluster, where you want to install Kommander. If you do not know it, use kubectl get clusters -A to display it.

Create your Kommander Installer Configuration File

  1. Set the environment variable for your cluster:

    CODE
    export CLUSTER_NAME=<your-management-cluster-name>
  2. Copy the kubeconfig file of your Management cluster to your local directory:

    CODE
    dkp get kubeconfig -c ${CLUSTER_NAME} >> ${CLUSTER_NAME}.conf
  3. Create a configuration file for the deployment:

    CODE
    dkp install kommander --init > kommander.yaml 
  4. If required: Customize your kommander.yaml.
    (info) See Kommander customizations for customization options. Some of them include:
    Custom Domains and Certificates, HTTP proxy, External Load Balancer, GPU utilization, Rook Ceph customization (Pre-provisioned envs), etc.

Enable DKP Catalog Applications and Install Kommander

If you have an Enterprise license and would like to use the DKP Catalog Applications function, follow these steps:

  1. In the same kommander.yaml of the previous section, add these values for dkp-catalog-applications:

    CODE
    apiVersion: config.kommander.mesosphere.io/v1alpha1
    kind: Installation
    catalog:
      repositories:
        - name: dkp-catalog-applications
          labels:
            kommander.d2iq.io/project-default-catalog-repository: "true"
            kommander.d2iq.io/workspace-default-catalog-repository: "true"
            kommander.d2iq.io/gitapps-gitrepository-type: "dkp"
          gitRepositorySpec:
            url: https://github.com/mesosphere/dkp-catalog-applications
            ref:
              tag: v2.5.0

    (warning) If you only want to enable catalog applications to an existing configuration, add these values to an existing installer configuration file to maintain your Management cluster’s settings.

  2. Use the customized kommander.yaml to install DKP:

    CODE
    dkp install kommander --installer-config kommander.yaml --kubeconfig=${CLUSTER_NAME}.co

If your environment uses HTTP/HTTPS proxies, you must include the flags --http-proxy, --https-proxy, and --no-proxy and their related values in this command for it to be successful. More information is available in Configuring an HTTP/HTTPS Proxy.

Tips and recommendations

  • The --kubeconfig=${CLUSTER_NAME}.conf flag ensures that you install Kommander on the correct cluster. For alternatives, see (Provide Context for Commands with a kubeconfig File .

  • Applications can take longer to deploy, and time out the installation. Add the --wait-timeout <time to wait> flag and specify a period of time (for example, 1h) to allocate more time to the deployment of applications.

  • If the Kommander installation fails, or you wish to reconfigure applications, rerun the install command to retry.

Next Step:

vSphere: Verify Install and Log in to the UI

JavaScript errors detected

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

If this problem persists, please contact our support.