Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve installing on Minikube docs #1613

Merged
merged 2 commits into from
Sep 28, 2020
Merged

Improve installing on Minikube docs #1613

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d4ffa9
Improve installing on Minikube docs
mmorhun Sep 25, 2020
197ed54
Fixes
mmorhun Sep 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions ...s/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a getting started, we should keep things simple. Since it's the default and recommended we should not go through much of the details. I would not change this line.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, I'll revert this line

+
[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:
mmorhun marked this conversation as resolved.
Show resolved Hide resolved

** 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}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To keep things simple can we just say:

NOTE: Add option `--installer helm` to use the helm chart and install a single-user instance of {prod-short}.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

[source,yaml]
----
spec:
server:
customCheProperties:
CHE_MULTIUSER: "false"
----
4 changes: 3 additions & 1 deletion modules/installation-guide/partials/proc_using-minikube-to-set-up-kubernetes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On linux isn't --vm=true the default?
If that's the case we could start using the same command on all platforms:

minikube start --addons=ingress --memory=4096 --vm=true

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another doubt: is 4G enough to run Che multi-user, start Quarkus stack, compile and run it? I am afraid that this is not enough anymore. If that's the case I would change to "at least 4GB of RAM but 8GB are recommended" and use --memory=8192 in the command line.

Copy link
Contributor Author

@mmorhun mmorhun Sep 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On Linux option --vm=true is not required. And from resource usage docker driver behaves better.
But if you think that we should include --vm=true as default, I may add it.

Copy link
Contributor Author

@mmorhun mmorhun Sep 25, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree, the memory amount is very minimal.

----
+
NOTE: For Windows and Mac users it is required to add the `--vm=true` option to run Minikube in a virtual machine.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI notes are described with

[NOTE]
====
text here

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you run vale plug-in on the changes ?
you should see error on passive is required

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've seen the NOTE: definition as well in many places. Is there any rule for this?

I didn't run vale on my branch (as checklist says) because I have problems with workspace from default devfile.