diff --git a/docs/index.rst b/docs/index.rst index fa8f3ea2648fb70e47fc76e21dfd8dd7352021ff..a6c9c7c1754feb5ce7a1b0457766b4f97e35c636 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,12 +4,12 @@ contain the root `toctree` directive. Welcome to Stackspin's documentation! -======================================== +===================================== -Stackspin (Stackspin) is a platform that will offer self-managed, click-and-play -provisioning of online applications for Civil Society Organisations (CSOs). -Users will be able to easily set up a self-hosted instance of Stackspin, so -they can keep control over the data that gets entered into these applications. +Stackspin is a platform that offers self-managed, click-and-play +provisioning of online applications for Civil Society Organisations (CSOs). +Users will be able to easily set up a self-hosted instance of Stackspin, so +they can keep control over the data that gets entered into these applications. Stackspin is: diff --git a/docs/installation/_install_on_existing_cluster.rst b/docs/installation/_install_on_existing_cluster.rst index 74461986c6dd9c226c42919348c9b079e0819ef9..8cc477a888807ef54bc8dcfc027e0ccf8e4941d8 100644 --- a/docs/installation/_install_on_existing_cluster.rst +++ b/docs/installation/_install_on_existing_cluster.rst @@ -1,3 +1,7 @@ +Below, we describe how you can install Stackspin on an existing Kubernetes +cluster. This process can be followed if you have a "managed Kubernetes" +setup, or if you want to use a Kubernetes version other than K3s. + .. Note:: - Installation on an existing Kubernetes cluster ist still experiental and might not work depending on the setup of your cluster/cloud provider. @@ -6,7 +10,8 @@ **Prerequisites** -- A single-node Kubernetes cluster +- A single-node Kubernetes cluster (multi-node support has not been tested by + the Stackspin team) - A ``kube_config.yml`` file for API access **Configure DNS** diff --git a/docs/installation/install_cli.rst b/docs/installation/install_cli.rst index 4cb34dfb609a6152109abb25f54d5a2727af18d2..6278611d21d50354525dd6915f50fb50bb29f4f4 100644 --- a/docs/installation/install_cli.rst +++ b/docs/installation/install_cli.rst @@ -15,9 +15,6 @@ Installation overview please do not use a server that functions as anything other than a testing ground. -Setup -===== - This page will guide you through the installation of the "Stackspin CLI". The CLI can be used to set up Stackspin on a different machine that is connected to the internet. It also functions as a starting point for running tests. @@ -25,7 +22,7 @@ the internet. It also functions as a starting point for running tests. Common prerequisites -------------------- -Wether you want to create a kubernetes cluster first or want to install +Whether you want to create a Kubernetes cluster first or want to install Stackspin on an existing cluster, these are the common prerequisites: - You need Python 3 with its development files, Pip and Git installed @@ -101,8 +98,5 @@ directory of the git repository. In this tutorial, we're using $ python -m stackspin stackspin.example.org --help -Kubernetes Cluster -================== - The next chapter, :ref:`create_kubernetes_cluster`, will explain setting up and/or configuring a Kubernetes cluster to install Stackspin on.