diff --git a/docs/assets/install-saas-0-new-cluster.png b/docs/assets/install-saas-0-new-cluster.png new file mode 100644 index 0000000..658ab60 Binary files /dev/null and b/docs/assets/install-saas-0-new-cluster.png differ diff --git a/docs/assets/install-saas-1-cluster-name.png b/docs/assets/install-saas-1-cluster-name.png new file mode 100644 index 0000000..5ccde81 Binary files /dev/null and b/docs/assets/install-saas-1-cluster-name.png differ diff --git a/docs/assets/install-saas-2-cmd.png b/docs/assets/install-saas-2-cmd.png new file mode 100644 index 0000000..c1a164f Binary files /dev/null and b/docs/assets/install-saas-2-cmd.png differ diff --git a/docs/assets/install-saas-3-install-progress.png b/docs/assets/install-saas-3-install-progress.png new file mode 100644 index 0000000..abb5899 Binary files /dev/null and b/docs/assets/install-saas-3-install-progress.png differ diff --git a/docs/assets/install-saas-4-done.png b/docs/assets/install-saas-4-done.png new file mode 100644 index 0000000..b833ada Binary files /dev/null and b/docs/assets/install-saas-4-done.png differ diff --git a/docs/how-to-install/open-source-version.md b/docs/how-to-install/open-source-version.md new file mode 100644 index 0000000..60955c9 --- /dev/null +++ b/docs/how-to-install/open-source-version.md @@ -0,0 +1,26 @@ +--- +title: Install The Open Source Version +--- + +To get Kalm running on your localhost, make sure your have `kubectl` installed and you've setup a [minikube](https://minikube.sigs.k8s.io/docs/start/) cluster. + +Once you have `kubectl` configured to your minikube cluster, you can deploy Kalm with the following commands: + +```shell +# clone the repo +git clone https://github.com/kalmhq/kalm.git +cd kalm + +# run the install script +./scripts/install-local-mode.sh +``` + +This whole process typically takes around 5-10 minutes. Relax or check out our docs in the mean time. + +Once the installation is complete, run the following command to open a port to the web server: + +```shell +kubectl port-forward -n kalm-system $(kubectl get pod -n kalm-system -l app=kalm -ojsonpath="{.items[0].metadata.name}") 3010:3010 +``` + +Your freshly installed Kalm should now be accessible at [http://localhost:3010](http://localhost:3010). diff --git a/docs/how-to-install/saas-version.md b/docs/how-to-install/saas-version.md new file mode 100644 index 0000000..8fd1065 --- /dev/null +++ b/docs/how-to-install/saas-version.md @@ -0,0 +1,30 @@ +--- +title: Install the SaaS Version +--- + +Welcome! This guide shows you how to install Kalm onto your Cluster. It should take less than 20 minutes. + +1. Go to [http://kalm.dev/signin](http://kalm.dev/signin), and authenticate with either Github or Google OAuth +2. Click **INSTALL NEW CLUSTER** + + ![assets/Untitled.png](../assets/install-saas-0-new-cluster.png) + +3. Choose a name for your cluster + +4. Run the curl command to install Kalm on your cluster: + +:::note +Make sure your `kubectl` is pointing to the cluster you want to install Kalm on. To see your current cluster, use `kubectl config get-context` - the selected cluster should be marked with a * in the output. +::: + +![cmd](../assets/install-saas-2-cmd.png) + +The installation process will update while it installs: + +![install-progress](../assets/install-saas-3-install-progress.png) + +_Usually this process takes around 5 - 15 minutes_ + +That's it! Once the installation finishes, click the GO TO DASHBOARD button to start using Kalm. [Kalm.dev](https://kalm.dev) by default will now point you to your cluster management dashboard. + +![done](../assets/install-saas-4-done.png) diff --git a/sidebars.json b/sidebars.json index 47acabf..04c1ebb 100644 --- a/sidebars.json +++ b/sidebars.json @@ -4,7 +4,16 @@ "type": "category", "label": "Getting Started", "collapsed": false, - "items": ["intro", "get-started"] + "items": [ + "intro", + { + "type": "category", + "label": "How to Install", + "items": [ + "how-to-install/saas-version", "how-to-install/open-source-version" + ] + }, + "get-started"] }, { "type": "category",