Improve installing on Minikube docs #1613
Conversation
Signed-off-by: Mykola Morhun <mmorhun@redhat.com>
mmorhun
requested review from
themr0c,
benoitf,
l0rd,
rkratky and
MichalMaler
| ---- | ||
| + | ||
| NOTE: For Windows and Mac users it is required to add the `--vm=true` option to run Minikube in a virtual machine. |
There was a problem hiding this comment.
FYI notes are described with
[NOTE]
====
text here
There was a problem hiding this comment.
did you run vale plug-in on the changes ?
you should see error on passive is required
There was a problem hiding this comment.
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.
modules/installation-guide/partials/proc_installing-che-on-minikube-using-chectl.adoc
Outdated
Show resolved
Hide resolved
| @@ -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: | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
ok, I'll revert this line
| + | ||
| NOTE: Omit the `--multiuser` option to install a single-user instance of {prod-short}. |
There was a problem hiding this comment.
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}.
| @@ -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 | |||
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Agree, the memory amount is very minimal.
mmorhun
force-pushed
the
che-17952
branch
2 times, most recently
from
761064f
to
dbeba97
Compare
|
In this PR vale checks failed with weird errors. However, in my workspace I do not see them: |
|
It seems 2 things are happening:
|
Signed-off-by: Mykola Morhun mmorhun@redhat.com
What does this PR do?
Fixes installation on Minikube guide
What issues does this PR fix or reference?
eclipse-che/che#17952
Specify the version of the product this PR applies to.
Eclipse Che 7.x
PR Checklist
As the author of this Pull Request I made sure that:
valehas been run successfully against the PR branch