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

Commit 74a4f3a

Browse files
committed
revised prereqs and isntructions
Signed-off-by: Jacob Berger <jacob.berger@ibm.com>
1 parent 44673c7 commit 74a4f3a

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

docs/_guides/codewind-crw-quick-guide.md

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,20 @@ tags: Codewind, CodeReady Workspaces, Openshift, Kubernetes, containers, microse
1414
* Develop a simple microservice that uses Eclipse Codewind on CodeReady Workspaces
1515

1616
## Overview
17-
Use Eclipse Codewind to develop microservice applications from application stacks in an integrated developer environment (IDE). CodeReady Workspaces provides a containerized IDE for cloud native application development on an OpenShift cluster.
17+
Use Eclipse Codewind to develop microservice applications from application stacks in an integrated developer environment (IDE).CodeReady Workspaces provides a containerized IDE for cloud native application development on an OpenShift cluster.
1818

1919
## Developing with CodeReady Workspaces
2020
CodeReady Workspaces uses Kubernetes and containers to provide a preconfigured environment. Use CodeReady Workspaces to create, build, and test your code in OpenShift containers but feel like you are working on an IDE on your local machine.
2121

2222
### Prerequisite
2323
CodeReady Workspaces require at least two 5Gi ReadWriteOnce (RWO) persistent volumes on the cluster to install and a 5Gi RWO volume for each created workspace.
2424

25-
Each Codewind workspace also requires at least on 5Gi ReadWriteMany (RWX) persistent volume.
25+
Each Codewind workspace also requires at least one 5Gi ReadWriteMany (RWX) persistent volume.
2626

27-
Before you can use Codewind with CodeReady Workspaces, apply the Codewind cluster role with `oc apply -f`.
27+
Before you can use Codewind with CodeReady Workspaces, you must:
28+
29+
1. Install an OpenShift cluster.
30+
2. Apply the Codewind cluster by going to your command line and inputting `oc apply -f`.
2831

2932
### Installing CodeReady Workspaces
3033
1\. Log in to your OpenShift cluster.
@@ -37,12 +40,6 @@ Before you can use Codewind with CodeReady Workspaces, apply the Codewind cluste
3740

3841
![Subscribe to OperatorHub](./images/codereadyworkspaces-images/CRW-OperatorHub.png){:width="900"}.
3942

40-
![Install CodeReady Workspaces](./images/codereadyworkspaces-images/CRW-Install.png){:width="800"}.
41-
42-
* If you did not set up an auth provider, set **openShiftoAuth** to **false**.
43-
* To enable HTTPS, set **tlsSupport** to **true**.
44-
* If you use a self-signed certificate, set **selfSignedCert** to **true**.
45-
4643
After you install the operator, continue to install CodeReady Workspaces:
4744

4845
1\. From the OpenShift dashboard, go to `Operators`>`Installed Operators`.
@@ -92,52 +89,51 @@ spec:
9289
pvcClaimSize: 1Gi
9390
preCreateSubPaths: true
9491
```
95-
* To manually install Codewind with CodeReady Workspaces, save this yaml to a disk and run `oc apply -f <yaml>`.
9692

93+
![Install CodeReady Workspaces](./images/codereadyworkspaces-images/CRW-Install.png){:width="800"}.
94+
95+
* To manually install Codewind with CodeReady Workspaces, save this yaml to a disk and run `oc apply -f <yaml>`.
96+
* If you did not set up an auth provider, set **openShiftoAuth** to **false**.
97+
* To enable HTTPS, set **tlsSupport** to **true**.
98+
* If you use a self-signed certificate, set **selfSignedCert** to **true**.
99+
97100
6\. CodeReady Workspaces now installs and you can access the CodeReady Workspaces URL and Red Hat SSO Admin Console URL:
98101

99102
![Install CheCluster](./images/codereadyworkspaces-images/CRW-CheCluster.png){:width="900"}.
100103

101104
After you install CodeReady Workspaces, log in and create a Codewind workspace from the Codewind devfile:
102105

103-
1\. Log in to Che. Che loads.
106+
1\. Log in to CodeReady Workspaces.
104107

105108
2\. Go to **Workspaces** then click **Add Workspace**.
106109

107110
3\. Click **Import Devfile**.
108111

109112
4\. From **Source**, click **YAML**.
110113

111-
5\. Go to the link, [codewind-che-plugin/0.12.0/devfile.yaml](https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.12.0/devfiles/0.12.0/devfile.yaml), then copy and paste the contents into the YAML text box in your Codewind workspace.
114+
5\. Go to the link, [codewind-che-plugin/0.12.0/devfile.yaml](https://raw.githubusercontent.com/eclipse/codewind-che-plugin/0.13.0/devfiles/0.13.0/devfile.yaml), then copy and paste the contents into the YAML text box in your Codewind workspace.
112115

113116
6\. Click **Create & Open**.
114117

115118
### Setting up Codewind
116119
Because of its dependency on `buildah`, Codewind needs to run as root and privileged. To enable Codewind, run the following commands:
117-
* `oc adm policy add-scc-to-user anyuid system:serviceaccounts:<namespace>:che-workspace`
118-
* `oc adm policy add-scc-to-user privileged system:serviceaccounts:<namespace>:che-workspace`
120+
* `oc adm policy add-scc-to-user anyuid system:serviceaccounts:<namespace where you installed CodeReady Workspaces>:che-workspace`
121+
* `oc adm policy add-scc-to-user privileged system:serviceaccounts:<namespace where you installed CodeReady Workspaces>:che-workspace`
119122

120123
CodeReady Workspaces starts Codewind and installs the Codewind plug-ins. This process might take a couple of minutes for all of the necessary components to be pulled and started.
121124

122125
### Configuring Codewind to use application stacks
123126
Configure Codewind to use Appsody templates so you can focus exclusively on your code. Complete the following steps to select the Appsody templates:
124127

125-
1. Under the Explorer pane, select **Codewind**.
126-
2. Right-click **Local**.
128+
1. Select **Codewind**.
129+
2. Right-click **Projects**.
127130
3. Select **Template Source Manager**.
128131
4. Enable **Appsody Stacks - incubator** and **Default templates**.
129132

130133
After you configured Codewind to use Appsody templates, continue to develop your microservice within Codewind.
131134

132-
If your organization uses customized application stacks and gives you a URL that points to an `index.json` file, you can add it to Codewind:
133-
134-
1. Return to **Codewind** and right-click **Local**.
135-
2. Select **Template Source Manager**.
136-
3. Click **Add New +** to add your URL.
137-
4. Add your URL in the pop-up window and save your changes.
138-
139135
### Creating an Appsody project
140-
Throughout the application lifestyle, Appsody helps you develop containerized applications and maximize containers curated for your usage. If you want more context about Appsody, see [Appsody welcome page](https://appsody.dev/docs).
136+
Throughout the application lifestyle, Appsody helps you develop containerized applications and maximize containers curated for your usage.
141137

142138
1. Under the Explorer pane, select **Codewind**.
143139
2. Expand **Codewind** by clicking the drop-down arrow.
@@ -217,9 +213,9 @@ Any changes that you make to your code are automatically built and redeployed by
217213
### Working with the example calculator microservice
218214
You now can work with the example calculator microservice.
219215

220-
1. Use the port number that you saw when you first opened the application.
216+
1. Use the URL that you saw when you first opened the application.
221217
2. Make sure to remove the `< >` symbol in the URL.
222-
3. `http://127.0.0.1:<port>/starter/calculator/aboutme`
218+
3. `http://127.0.0.1:<url>/starter/calculator/aboutme`
223219
4. You see the following response:
224220

225221
```
@@ -228,8 +224,8 @@ You can add (+), subtract (-), and multiply (*) with this simple calculator.
228224

229225
You can also try a few of the sample calculator functions:
230226

231-
* `http://127.0.0.1:<port>/starter/calculator/{op}/{a}/{b}`, where you can input one of the available operations `(+, _, *)`, and an integer a, and an integer b.
232-
* So for `http://127.0.0.1:<port>/starter/calculator/+/10/3` you see: `10+3=13`.
227+
* `http://127.0.0.1:<url>/starter/calculator/{op}/{a}/{b}`, where you can input one of the available operations `(+, _, *)`, and an integer a, and an integer b.
228+
* So for `http://127.0.0.1:<url>/starter/calculator/+/10/3` you see: `10+3=13`.
233229

234230
## What you have learned
235231
Now that you have completed this quick guide, you have learned to:

0 commit comments

Comments
 (0)