Version: v0.1.0-alpha.5

Installation

Compatibility

Kalm is optimized to work with the latest version of Kubernetes (currently 1.18.x), and is backwards compatible down to 1.14.x

Kalm versionk8s 1.15.xk8s 1.16.xk8s 1.17.xk8s 1.18.x
v0.1.0โœ”โœ”โœ”โœ”

For smooth performance, we recommend a Kubernetes cluster with at least 4 vCPUs and 8G of memory.

Step 1: Prerequisites

Cluster Setup

Kalm can be used to manage any Kubernetes cluster. For the purpose of this tutorial, we recommend that you try Kalm using Minikube localhost cluster first.

Alternatively, see the References sections for provisioning clusters on AWS, Google Cloud and Azure.

Install Kubectl

Installation of Kalm requires kubectl, which can be installed according to the official Install and Set Up kubectl docs.

note

Please make sure that the version of kubectl is sufficient. It is strongly recommended that you use the version corresponding to the cluster. Using an earlier version of kubectl may cause errors in the installation process.

Step 2: Install Kalm

caution

Before proceeding, please make sure that the current context of your kubectl is set to the correct cluster.

Kalm can be installed as a Kubernetes Operator directly onto your cluster via:

curl -sL https://get.kalm.dev | bash

This command installs Kalm plus a few dependencies, and typically takes 3-5 minutes to complete. Relax in the meantime, or watch this short video on how Kalm works:


The installation script will give you real-time feedback of services spinning up. Once you see Installation Complete, move on to the next step.

Step 3: Access Webserver

To enable browser access, open a port via:

kubectl port-forward -n kalm-system \
$(kubectl get pod -n kalm-system \
-l app=kalm \
-ojsonpath="{.items[0].metadata.name}") \
3010:3010

Now open http://localhost:3010/

login screen

Step 4: (Optional) Configure Access

Although we can visit Kalm through localhost port forwarding, it is a good idea to setup a domain and basic login, so you can access Kalm on any computer and share it with colleagues.

To setup permanent acess, click FINISH THE SETUP STEPS button in the top navigation bar and follow the onscreen directions.

setup domain

Point a domain to the cluster ip. If you don't have a domain, you can use the wildcard DNS nip.io:

<CLUSTER_IP>.nip.io

note

For minikube, if no ip is shown, run minikube tunnel and refresh the page.

Click Check and Continue. After configuration is complete, record the generated Email and Password login information. From this point on, port-forwarding is no longer required, and you should be able to login via the domain you specified.

Next Step

Congratulations! Kalm is now properly setup and running. Next, let's create our first application to see how Kalm works.

Last updated on by iAladdin