From 4d4ffa97dc175972514d16a13f70fe299098da9b Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Fri, 25 Sep 2020 10:16:42 +0300 Subject: [PATCH 1/2] Improve installing on Minikube docs Signed-off-by: Mykola Morhun --- ...installing-che-on-minikube-using-chectl.adoc | 17 ++++++++++++++--- ...roc_using-minikube-to-set-up-kubernetes.adoc | 4 +++- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc b/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc index e7765ca46f..1aeb579ba2 100644 --- a/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc +++ b/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc @@ -14,11 +14,22 @@ This section describes how to install {prod-short} on Minikube using {prod-cli}. .Procedure -* Run the following command: +* To install {prod-short} in multi-user mode (default and recommended), run the following command: + [subs="+attributes"] ---- -$ {prod-cli} server:start --platform minikube --multiuser +$ {prod-cli} server:start --platform minikube ---- + +* To install {prod-short} in single-user mode add one if the following parameters to the command above: + + ** Use Helm installer by providing `--installer helm` option. + ** Pass `--che-operator-cr-patch-yaml patch.yaml`, where `patch.yaml` file has the following content: + -NOTE: Omit the `--multiuser` option to install a single-user instance of {prod-short}. +[source,yaml] +---- +spec: + server: + customCheProperties: + CHE_MULTIUSER: "false" +---- diff --git a/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc b/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc index a602bd4cd7..2b0de0026b 100644 --- a/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc +++ b/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc @@ -17,5 +17,7 @@ This section describes how to use Minikube to set up a local single-node {kubern . Start Minikube (it is important to *allocate at least 4 GB of RAM*): + ---- -$ minikube start --memory=4096 +$ minikube start --addons=ingress --memory=4096 ---- ++ +NOTE: For Windows and Mac users it is required to add the `--vm=true` option to run Minikube in a virtual machine. From 197ed54f9925fc0b0bc3e55888d4e354f65eee0b Mon Sep 17 00:00:00 2001 From: Mykola Morhun Date: Fri, 25 Sep 2020 12:08:17 +0300 Subject: [PATCH 2/2] Fixes Signed-off-by: Mykola Morhun --- ...c_installing-che-on-minikube-using-chectl.adoc | 15 ++------------- .../proc_using-minikube-to-set-up-kubernetes.adoc | 7 +++---- 2 files changed, 5 insertions(+), 17 deletions(-) diff --git a/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc b/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc index 1aeb579ba2..ca55c639b1 100644 --- a/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc +++ b/modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc @@ -14,22 +14,11 @@ This section describes how to install {prod-short} on Minikube using {prod-cli}. .Procedure -* To install {prod-short} in multi-user mode (default and recommended), run the following command: +* Run the following command: + [subs="+attributes"] ---- $ {prod-cli} server:start --platform minikube ---- -* To install {prod-short} in single-user mode add one if the following parameters to the command above: - - ** Use Helm installer by providing `--installer helm` option. - ** Pass `--che-operator-cr-patch-yaml patch.yaml`, where `patch.yaml` file has the following content: -+ -[source,yaml] ----- -spec: - server: - customCheProperties: - CHE_MULTIUSER: "false" ----- +NOTE: Add option `--installer helm` to use the helm chart and install a single-user instance of {prod-short}. diff --git a/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc b/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc index 2b0de0026b..f4f618f2e7 100644 --- a/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc +++ b/modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc @@ -14,10 +14,9 @@ This section describes how to use Minikube to set up a local single-node {kubern .Procedure -. Start Minikube (it is important to *allocate at least 4 GB of RAM*): +. Start Minikube (it is important to *allocate at least 4GB of RAM but 8GB are recommended*): + ---- -$ minikube start --addons=ingress --memory=4096 +$ minikube start --addons=ingress --vm=true --memory=8192 ---- -+ -NOTE: For Windows and Mac users it is required to add the `--vm=true` option to run Minikube in a virtual machine. +