Kommander DocumentationPrerequisites
Prior to installing Kommander, you must know the version you’d like to install, which is provided by D2iQ.
Set the VERSION environment variable to the version of Kommander you would like to install, for example:
export VERSION=v2.0.0
Kommander ships in a Helm chart, so prior to installing Kommander, make Helm aware of the Helm repository providing the Kommander chart:
helm repo add kommander https://mesosphere.github.io/kommander/charts
helm repo update
Default StorageClass
To ensure the Git repository shipped with Kommander deploys successfully, the cluster you install Kommander on must have a default StorageClass configured. Run the following command:
kubectl get sc
The output should look similar to this. Note the (default) after the name:
NAME PROVISIONER RECLAIMPOLICY VOLUMEBINDINGMODE ALLOWVOLUMEEXPANSION AGE
ebs-sc (default) ebs.csi.aws.com Delete WaitForFirstConsumer false 41s
If the StorageClass is not set as default, add the following annotation to the StorageClass manifest:
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 Kubernetes docs
Install Kommander on Konvoy
Before running these commands, ensure that your kubectl configuration references the cluster where you want to install Kommander, otherwise it installs on the bootstrap cluster. 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 workload cluster.
To install Kommander with http proxy setting enabled, you need to follow the instructions outlined in enable gatekeeper section before proceeding further. To enable a gatekeeper proxy, you must pass the values.yaml you created to the following commands using --values=values.yaml
helm install -n kommander --create-namespace kommander-bootstrap kommander/kommander-bootstrap --version=${VERSION} --set certManager=$(kubectl get ns cert-manager > /dev/null 2>&1 && echo "false" || echo "true")
Verify installation
After Helm successfully installs the chart, you must wait for all HelmReleases to deploy.
The Kommander installation is a two-step process: Flux and cert-manager install first, then the Git repository spins up and permits Flux to consume further HelmReleases from that repository.
After running helm install, the cert-manager HelmRelease is ready and, after additional time, HelmReleases appear on the cluster.
kubectl -n kommander wait --for condition=Released helmreleases --all --timeout 15m
This will wait for each of the helm charts to reach their Released condition, eventually resulting in:
helmrelease.helm.toolkit.fluxcd.io/centralized-grafana condition met
helmrelease.helm.toolkit.fluxcd.io/dex condition met
helmrelease.helm.toolkit.fluxcd.io/dex-k8s-authenticator condition met
helmrelease.helm.toolkit.fluxcd.io/fluent-bit condition met
helmrelease.helm.toolkit.fluxcd.io/grafana-logging condition met
helmrelease.helm.toolkit.fluxcd.io/grafana-loki condition met
helmrelease.helm.toolkit.fluxcd.io/karma condition met
helmrelease.helm.toolkit.fluxcd.io/kommander condition met
helmrelease.helm.toolkit.fluxcd.io/kube-oidc-proxy condition met
helmrelease.helm.toolkit.fluxcd.io/kube-prometheus-stack condition met
helmrelease.helm.toolkit.fluxcd.io/kubecost condition met
helmrelease.helm.toolkit.fluxcd.io/kubefed condition met
helmrelease.helm.toolkit.fluxcd.io/kubernetes-dashboard condition met
helmrelease.helm.toolkit.fluxcd.io/kubetunnel condition met
helmrelease.helm.toolkit.fluxcd.io/logging-operator condition met
helmrelease.helm.toolkit.fluxcd.io/logging-operator-logging condition met
helmrelease.helm.toolkit.fluxcd.io/minio-operator condition met
helmrelease.helm.toolkit.fluxcd.io/prometheus-adapter condition met
helmrelease.helm.toolkit.fluxcd.io/reloader condition met
helmrelease.helm.toolkit.fluxcd.io/thanos condition met
helmrelease.helm.toolkit.fluxcd.io/traefik condition met
helmrelease.helm.toolkit.fluxcd.io/traefik-forward-auth condition met
helmrelease.helm.toolkit.fluxcd.io/velero condition met
Access Kommander Web UI
When all the HelmReleases are ready, use the following command to retrieve the URL to access Kommander’s Web interface:
kubectl -n kommander get svc kommander-traefik -o go-template='https://{{with index .status.loadBalancer.ingress 0}}{{or .hostname .ip}}{{end}}/dkp/kommander/dashboard{{ "\n"}}'
Use the following command to access the Username and Password stored on the cluster:
kubectl -n kommander get secret dkp-credentials -o go-template='Username: {{.data.username|base64decode}}{{ "\n"}}Password: {{.data.password|base64decode}}{{ "\n"}}'