Add note on operator install of Che #94

johnmcollier · 2019-08-28T15:22:33Z

Adds a small note on what users need to do if they're installing Che with the Che operator.

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida · 2019-08-28T15:25:18Z

docs/_documentations/installoncloud.md

  - You do not need to set up the PV for local Kube, such as Minikube, Minishift, Docker Desktop, and others.
 - Set up the ClusterRole.
-  - **Important:** If you are running on OKD or OpenShift, install Che first and then set up the ClusterRole.
+  - **Important:** If you are installing Che with with the `deploy_che.sh` script for OpenShift, do this step *after* installing Che


Typo: Remove the double "with" in line 31.

Add a period at the end of the last sentence.

Fixed, thanks!

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida · 2019-08-28T15:29:47Z

docs/_documentations/installoncloud.md

-  4. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
-  5. Next, run `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
+  3. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
+  4. Next, run `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.


I'd add "the" before you list the command itself so that way it reads, "the kubectl apply -f setup/install_che/codewind-rolebinding.yaml command."

Thanks, fixed!

sishida · 2019-08-28T15:30:13Z

docs/_documentations/installoncloud.md

+  3. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
+  4. Next, run `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
+
+## Installing Che with the Operator


Don't need to capitalize "Operator."

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida · 2019-08-28T15:32:22Z

docs/_documentations/installoncloud.md

+
+## Installing Che with the Operator
+
+For instructions on installing Che with the Che operator, please consult https://operatorhub.io/operator/eclipse-che


Instead of "please consult" say "see".

Also, add the title instead of the URL.

Add a period at the end of the sentence.

So it looks like this:
see [Eclipse Che](https://operatorhub.io/operator/eclipse-che).

sishida · 2019-08-28T15:33:38Z

docs/_documentations/installoncloud.md

+
+For instructions on installing Che with the Che operator, please consult https://operatorhub.io/operator/eclipse-che
+
+**Note:** You must do the following prior to creating your `CheCluster` custom resource


I'd say, "Complete the following steps before you create your CheCluster custom resource."

Don't forget the period at the end of the sentence. :)

sishida · 2019-08-28T15:36:48Z

docs/_documentations/installoncloud.md

+
+2. Ensure the following fields in your `CheCluster` yaml file are set:
+- `spec.server.cheWorkspaceClusterRole` to `eclipse-codewind` (the Codewind ClusterRole applied in the previous step)
+- `spec.storage.preCreateSubPaths` to `true`


I think we could clarify this step a little more by fleshing it out.

"Ensure that the following fields in your CheCluster .yaml file are set to these values:"

"The spec.server.cheWorkspaceClusterRole field is set to eclipse-codewind when you previously applied the Codewind ClusterRole."

"The spec.storage.preCreateSubPaths field is set to true."

sishida · 2019-08-28T15:37:16Z

docs/_documentations/installoncloud.md


 ### Installing Che with deployment scripts
+
+If the Che operator was not used to install Eclipse Che, follow these steps instead, otherwise skip this step:


This line should be two sentences:
"...instead. Otherwise, skip..."

sishida · 2019-08-28T15:39:44Z

docs/_documentations/installoncloud.md


 ### Step 1: Setting up the Che Helm chart
+
+If the Che operator was not used to install Eclipse Che, follow these steps instead, otherwise skip this step:


This line should be two sentences:
"...instead. Otherwise, skip..."

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida · 2019-08-28T16:07:49Z

docs/_documentations/installoncloud.md

 # Table of Contents
 1. [Prerequisites](#prerequisites)
+2. [Installing Che with the operator](#installing-che-with-the-operator)
 2. [Setting up OKD and OpenShift](#setting-up-okd-and-openshift)


I just noticed that this Table of Contents needs to be re-numbered. There are two "2's" with the new section added.

Thanks, fixed!

sishida · 2019-08-28T16:09:27Z

docs/_documentations/installoncloud.md

+1. Create the `eclipse-codewind` cluster role: `kubectl apply -f https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/setup/install_che/codewind-clusterrole.yaml`
+
+2. Ensure the following fields in your `CheCluster` `.yaml` file are set:
+- The spec.server.cheWorkspaceClusterRole field is set to eclipse-codewind, which was created when you previously applied the Codewind ClusterRole.


We're missing the tick marks around spec.server.cheWorkspaceClusterRole and eclipse-codewind.

Thanks, fixed!

Signed-off-by: John Collier <John.J.Collier@ibm.com>

Add note on operator install of Che

johnmcollier added 2 commits August 28, 2019 11:19

Update the install docs for the Che operator

6c32645

Signed-off-by: John Collier <John.J.Collier@ibm.com>

Add note on doing step after deploy_che.sh

96afec1

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida reviewed Aug 28, 2019

View reviewed changes

Fix typo

cb9bbae

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida reviewed Aug 28, 2019

View reviewed changes

Uncapitalize operator

8671fbc

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida reviewed Aug 28, 2019

View reviewed changes

Address ID review comments

5646781

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida reviewed Aug 28, 2019

View reviewed changes

johnmcollier added 2 commits August 28, 2019 12:15

Address further review comments

602bd70

Signed-off-by: John Collier <John.J.Collier@ibm.com>

Address further review comments regard punctuation

91e094d

Signed-off-by: John Collier <John.J.Collier@ibm.com>

sishida approved these changes Aug 28, 2019

View reviewed changes

tetchel approved these changes Aug 28, 2019

View reviewed changes

johnmcollier merged commit 4ffb1dc into eclipse-archived:master Aug 28, 2019

sghung assigned johnmcollier Aug 29, 2019

jcockbain pushed a commit to jcockbain/codewind-docs that referenced this pull request May 26, 2020

Merge pull request eclipse-archived#94 from johnmcollier/OperatorInstall

6146ce4

Add note on operator install of Che


		## Installing Che with the Operator

		For instructions on installing Che with the Che operator, please consult https://operatorhub.io/operator/eclipse-che


		For instructions on installing Che with the Che operator, please consult https://operatorhub.io/operator/eclipse-che

		Note: You must do the following prior to creating your `CheCluster` custom resource


		### Installing Che with deployment scripts

		If the Che operator was not used to install Eclipse Che, follow these steps instead, otherwise skip this step:


		### Step 1: Setting up the Che Helm chart

		If the Che operator was not used to install Eclipse Che, follow these steps instead, otherwise skip this step:

Add note on operator install of Che #94

Add note on operator install of Che #94

Uh oh!

Conversation

johnmcollier commented Aug 28, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

johnmcollier commented Aug 28, 2019 •

edited

Loading