Skip to content
This repository was archived by the owner on Nov 28, 2022. It is now read-only.

Commit 4ffb1dc

Browse files
authored
Merge pull request #94 from johnmcollier/OperatorInstall
Add note on operator install of Che
2 parents 0d345da + 91e094d commit 4ffb1dc

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

docs/_documentations/installoncloud.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,41 @@ To setup a Codewind-ready install of Che, follow these instructions. Alternative
1717

1818
# Table of Contents
1919
1. [Prerequisites](#prerequisites)
20-
2. [Setting up OKD and OpenShift](#setting-up-okd-and-openshift)
21-
3. [Setting up other Kubernetes](#setting-up-other-kubernetes)
22-
4. [After installing Che](#after-installing-che)
23-
5. [Creating the Codewind workspace](#creating-the-codewind-workspace)
20+
2. [Installing Che with the operator](#installing-che-with-the-operator)
21+
3. [Setting up OKD and OpenShift](#setting-up-okd-and-openshift)
22+
4. [Setting up other Kubernetes](#setting-up-other-kubernetes)
23+
5. [After installing Che](#after-installing-che)
24+
6. [Creating the Codewind workspace](#creating-the-codewind-workspace)
2425

2526
## Prerequisites
2627
- Set up the PersistentVolume (PV) with either Network File System (NFS) or GlusterFS.
2728
- For NFS, if running on IBM Cloud Private, follow these instructions:[NFS Storage Install Instructions](https://www.ibm.com/developerworks/community/blogs/fe25b4ef-ea6a-4d86-a629-6f87ccf4649e/entry/Working_with_storage?lang=en) and use 777 permissions for the folders.
2829
- You do not need to set up the PV for local Kube, such as Minikube, Minishift, Docker Desktop, and others.
2930
- Set up the ClusterRole.
30-
- **Important:** If you are running on OKD or OpenShift, install Che first and then set up the ClusterRole.
31+
- **Important:** If you are installing Che with the `deploy_che.sh` script for OpenShift, do this step *after* installing Che.
3132
1. Clone the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin)
3233
2. Enter the `cd` command to go to the `codewind-che-plugin` repository.
33-
3. Log in to the IBM Cloud Private cluster and target cluster to the namespace that you are planning to install.
34-
4. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
35-
5. Next, run `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
34+
3. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
35+
4. Next, run the `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
36+
37+
## Installing Che with the operator
38+
39+
For instructions on installing Che with the Che operator, please see the [Eclipse Che operator on Operator Hub](https://operatorhub.io/operator/eclipse-che).
40+
41+
**Note:** Complete the following steps before you create your `CheCluster` custom resource.
42+
43+
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`.
44+
45+
2. Ensure the following fields in your `CheCluster` `.yaml` file are set:
46+
- The `spec.server.cheWorkspaceClusterRole` field is set to `eclipse-codewind`, which was created when you previously applied the Codewind ClusterRole.
47+
- The `spec.storage.preCreateSubPaths` field is set to `true`.
3648

3749
## Setting up OKD and OpenShift
3850

3951
### Installing Che with deployment scripts
52+
53+
If the Che operator was not used to install Eclipse Che, follow these steps instead. Otherwise skip these steps:
54+
4055
1. Git clone the [Eclipse Che repository](https://github.com/eclipse/che).
4156
2. Enter the `cd` command to go to the `deploy/openshift` directory.
4257
3. Deploy Che with `./deploy_che.sh`.
@@ -61,6 +76,9 @@ If you're running on IBM Cloud Private, you must add the images that Che uses to
6176
```
6277

6378
### Step 1: Setting up the Che Helm chart
79+
80+
If the Che operator was not used to install Eclipse Che, follow these steps instead. Otherwise skip these steps:
81+
6482
1. Clone the [Che repository](https://github.com/eclipse/che).
6583
2. Enter the `cd` command to go to the `deploy/kubernetes/helm/che` directory. Then, edit the `values.yaml` file.
6684
- Set up multiuser if you need the multiple users feature: `multiuser: true`

0 commit comments

Comments
 (0)