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

Commit 0525bc0

Browse files
sishidasghung
authored andcommitted
Update to latest 050 (#194)
Signed-off-by: Sarah Ishida <[email protected]>
1 parent dd4fe42 commit 0525bc0

11 files changed

+242
-31
lines changed

docs/_data/newstoc.yml

+3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
- title: 'Codewind 0.50'
2+
url: news05.html
3+
14
- title: 'Codewind 0.40'
25
url: news04.html
36

docs/_documentations/dockerregistry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Before you deploy your project with Codewind, first specify a deployment registr
5050
1. When you first deploy a project in Codewind, Codewind prompts you to set a deployment registry.
5151
- If Codewind detects the registry is unset, Codewind prompts before deploying a project.
5252
2. Enter a path with which to push your container.
53-
- **Important:** Before attempting this step, ensure that you have entered the registry credentials with the Che dashboard.
53+
- **Important:** Before attempting this step, ensure that you have correctly entered the registry credentials in the Che dashboard in Step 1.
5454
3. Codewind asks if you want to verify push permissions. If you select **yes**, Codewind pushes a small `hello-world` image to the registry to verify permissions.
5555

5656
### Instructions specific to IBM Cloud Private

docs/_documentations/installoncloud.md

+27-11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ parent: root
1919
4. [After installing Che](#after-installing-che)
2020
5. [Creating the Codewind workspace](#creating-the-codewind-workspace)
2121
6. [Updating the version](#updating-the-version)
22+
7. [Adding additional rules to support Codewind ODO extension](#adding-additional-rules-to-support-codewind-odo-extension)
2223

2324
## Prerequisites
2425
- Set up the PersistentVolume (PV) with either Network File System (NFS) or GlusterFS.
@@ -27,7 +28,7 @@ parent: root
2728
- Ensure the cluster can pull images from `docker.io/eclipse`.
2829
- Both Eclipse Che and Eclipse Codewind host their Docker images on `docker.io/eclipse`. Ensure that your cluster can pull from that registry and does not have `PodSecurityPolicies` blocking it from accessing Docker Hub.
2930
- Set up the ClusterRole for Codewind.
30-
1. Clone the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin)
31+
1. Clone the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin).
3132
2. Enter the `cd` command to go to the `codewind-che-plugin` repository.
3233
3. Run the `kubectl apply -f setup/install_che/codewind-clusterrole.yaml` command to create a cluster role with the required permission.
3334
4. Next, run the `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
@@ -41,7 +42,7 @@ Complete the following steps after you install `chectl`:
4142
1. Download the [codewind-che checluster yaml](https://github.com/eclipse/codewind-che-plugin/blob/master/setup/install_che/che-operator/codewind-checluster.yaml) file to your machine.
4243
- You can modify this file, but leave the `spec.server.cheWorkspaceClusterRole` field set to `eclipse-codewind` and the `spec.storage.preCreateSubPaths` field set to `true`.
4344
2. If you're installing on a Kubernetes platform other than OpenShift, determine your Ingress domain. If you're unsure of your Ingress domain, ask your cluster administrator.
44-
- Set the `spec.server.ingressDomain` field in the Che .yaml to the Ingress domain.
45+
- Set the `spec.server.ingressDomain` field in the Che `.yaml` to the Ingress domain.
4546
3. Install Che:
4647
- On OpenShift 3.x run the following command: `chectl server:start --platform=openshift --installer=operator --che-operator-cr-yaml=<codewind-che.yaml file>`
4748
- On Kubernetes run the following command: `chectl server:start --platform=k8s --installer=operator --domain=<ingress-domain> --che-operator-cr-yaml=<codewind-che.yaml file>`
@@ -55,29 +56,28 @@ Codewind is required to run as privileged and as root, because it builds contain
5556

5657
### Adding registries in Che
5758
After Che is started and running, add the container registry that will be used with Codewind.
58-
- On IBM Cloud Private, push your
59-
to any Docker registry *except* the internal Docker registry
60-
- On OpenShift or other Kube platforms, you can push your images to any Docker registry, such as Dockerhub, Quay.io, Google Cloud Registry (GCR), and more.
59+
- On OpenShift or other Kube platforms, you can push your images to any Docker registry, such as Docker Hub, Quay.io, Google Cloud Registry (GCR), and more.
60+
- On IBM Cloud Private, you can push your image to any Docker registry *except* the internal Docker registry.
6161

62-
Complete the following instructions to add the registries:
62+
You'll need the following information to complete the instructions to add the registries:
6363
- Server: `<registry-to-push-images-to>`
6464
- Username: `<Your username>`
6565
- Password: `<Your password>`
6666

67-
For further information on adding deployment registries to Che, consult our [registry documentation](https://www.eclipse.org/codewind/dockerregistry.html)
67+
For information on adding deployment registries to Che, consult our [registry documentation](https://www.eclipse.org/codewind/dockerregistry.html).
6868

6969
## Creating the Codewind workspace
7070

7171
### Confirm the Docker registry secrets.
72-
Confirm that you added the docker registry secrets in the Che dashboard. Go to **Administration**>**Add Registry** to check for the secrets.
72+
Confirm that you added the Docker registry secrets in the Che dashboard. Go to **Administration**>**Add Registry** to check for the secrets.
7373

7474
### Creating the Codewind workspace with a Devfile
7575
The general format for creating a Che workspace via a factory is:
7676
```
7777
http://<che ingress domain>/f?url=<hosted devfile URL>
7878
```
7979

80-
We provide a ready-to-use devfile with the Codewind plug-ins. Enter the following URL to create a workspace from the devfile:
80+
Codewind includes a ready-to-use devfile with its plug-ins. Enter the following URL to create a workspace from the devfile:
8181
```
8282
http://<che ingress domain>/f?url=https://raw.githubusercontent.com/eclipse/codewind-che-plugin/master/devfiles/0.4/devfile.yaml
8383
```
@@ -101,7 +101,7 @@ For more information about Tekton, see [Getting started with the Tekton Dashboar
101101
## After installing Codewind
102102

103103
### Setting the Docker registry
104-
Upon creating a Codewind workspace. The container registry to deploy your projects to must be set. When you go to create or add an existing project to Codewind, Codewind will prompt you for the registry. See (Docker registry docs) for guidance on using proper container registries
104+
After creating a Codewind workspace. The container registry to deploy your projects to must be set. When you go to create or add an existing project to Codewind, Codewind will prompt you for the registry. See [Docker registry docs](https://www.eclipse.org/codewind/dockerregistry.html) for guidance on using proper container registries.
105105

106106
If you would like to change the registry that's used at any time, run the `Codewind: Set Deployment Registry` command in Theia to dynamically set a new registry for your workspace. <br>
107107

@@ -136,4 +136,20 @@ Go to **View**>**Find Command…**>**Codewind: Build**.
136136
- Enter the following command: `curl -k -H "Content-Type: application/json" -X POST https://codewind-release:9191/api/v1/projects/8801a6d0-7805-11e9-b22f-19482c5ffbd6/build -d '{"action": "build"}'`
137137

138138
## Updating the version
139-
Restart the Codewind workspace in Che. Che automatically pulls the newest version of Codewind and the Theia extension.
139+
Restart the Codewind workspace in Che. Che automatically pulls the newest version of Codewind and the Theia extension.
140+
141+
## Adding additional rules to support Codewind ODO extension
142+
The Codewind ODO extension needs to add additional rules for accessing OpenShift resources:
143+
1. In your home directory, run the following command to clone the Codewind ODO extension repository:
144+
```
145+
git clone https://github.com/eclipse/codewind-odo-extension
146+
```
147+
2. Login to your OpenShift/OKD cluster
148+
3. Go into `~/codewind-odo-extension/odo-RBAC` then run the following commands to add additional rules:
149+
```
150+
kubectl apply -f codewind-odoclusterrole.yaml
151+
kubectl apply -f codewind-odoclusterrolebinding.yaml
152+
```
153+
154+
# Codewind OpenShift Do (ODO) extension
155+
Extension to Codewind providing support for OpenShift projects: https://github.com/eclipse/codewind-odo-extension

docs/_documentations/mdt-che-overview.md

+12
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,15 @@ The Eclipse tools are [open source](https://github.com/eclipse/codewind-eclipse)
2121
To get started, see [Getting started with Codewind](mdteclipsegettingstarted.html).
2222

2323
To uninstall Codewind, see [Uninstalling Codewind for Eclipse](mdteclipseuninstall.html)
24+
25+
## Codewind OpenShift (ODO) extension
26+
Extension to Codewind providing support for ODO projects: https://codewind.dev
27+
28+
### Add additional rules to support Codewind ODO extension
29+
The ODO extension needs to add additional rules for accessing OpenShift resources:
30+
1. In your home directory, run the following command to clone the ODO extension repository:
31+
`git clone https://github.com/eclipse/codewind-odo-extension`
32+
2. Login to your OpenShift/OKD cluster
33+
3. Go into `~/codewind-odo-extension/odo-RBAC` then run the following commands to add additional rules:
34+
`kubectl apply -f codewind-odoclusterrole.yaml`
35+
`kubectl apply -f codewind-odoclusterrolebinding.yaml`

docs/_documentations/mdt-eclipse-importedprojects.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ order: 0
1212

1313
# Adding existing projects
1414

15-
Modifications are usually required to successfully add and deploy projects that have never been run in Codewind before. <!--The add process creates required files if they do not exist.--> This guide covers the basics of configuring a project to run in Codewind.
15+
Modifications are usually required to successfully add and deploy projects that have never been run in Codewind before. This guide covers the basics of configuring a project to run in Codewind.
1616

1717
## What kind of projects can I add?
1818

@@ -23,6 +23,7 @@ Codewind is designed to develop cloud native microservices. Therefore, each proj
2323
* [Node.js projects](#nodejs-projects)
2424
* [Swift projects](#swift-projects)
2525
* [Generic Docker projects](#generic-docker-projects)
26+
* [Appsody projects](#appsody-projects)
2627

2728
## MicroProfile/Java EE projects
2829

@@ -191,3 +192,8 @@ For example, you should be able to build the project by using the command
191192
## Generic Docker projects
192193

193194
If you have a Dockerized application that doesn't fit an existing template, you can still add the project to Codewind by selecting the **Other (Basic Container)** option as the project type. For the application state detection to work, the Dockerfile needs to include an `EXPOSE` instruction to point to the port that is used to determine whether the project is running.
195+
196+
## Appsody projects
197+
198+
If you have an existing Appsody project, or a project that you want to add to Codewind as an Appsody project, select the corresponding Appsody project type and, if applicable, the Appsody stack when adding the project.
199+
For more information about Appsody and Appsody stacks, see [https://appsody.dev](https://appsody.dev).

docs/_documentations/mdt-vsc-commands-project.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,23 @@ Right-click a project in the **Codewind view** to see most project commands. All
2323

2424
- **Open app**: Open the project application root endpoint in the system browser. The project must be in the *Running* or *Debugging* state, or the application server won't be available.
2525

26-
- **Open application monitor**: Open the Codewind **Application Monitor** page for this project in the system browser.
26+
- **Open Project Overview**: Open an editor Tab that displays all of the Codewind information for the project. From this page, you can build, disable, or delete the project, and you can change the project auto build setting.
2727

28-
- **Open folder as workspace**: Open the project as your VS Code workspace folder. This command is useful if you want to work on just one project at a time per window. If you want the folder to open in a new window, set *window.openFoldersInNewWindow* to **true**.
28+
- **Open Container Shell**: Open a shell, either *bash* or *sh*, in the project application container with *docker exec*. The project must have a container running. The VS Code integrated terminal needs access to your *PATH* environment variable so that it can run the *docker* command.
2929

30-
- **Show project overview**: Open an editor tab that displays all of the Codewind information for the project. From this page, you can build, disable, or delete the project, and you can change the project auto build setting. This page is the only place in the extension where you can delete a project. If you delete a project, you remove it from both Codewind and from your file system.
30+
- **Open Application Monitor**: Open the Codewind **Application Monitor** page for this project in the system browser.
3131

32-
- **Build**: Manually request an application build for this project. If the project has auto build enabled, this command should not be necessary because builds are triggered automatically with a code change. This command is also available in the project info page.
33-
This command is equivalent to clicking the **Build** button in the Codewind **Overview** page.
32+
- **Open Performance Dashboard**: Opens the performance dashboard in the browser. This action is available only when the application is running or debugging.
3433

35-
- **Toggle auto build**: Enable or disable auto build for the project. This command is also available in the project info page. This command is equivalent to clicking the **Auto Build** toggle in the Codewind **Overview** page.
34+
- **Add Project to Workspace**: Add this project's folder on your local disk to your VS Code workspace.
3635

37-
- **Open container shell**: Open a shell, either *bash* or *sh*, in the project application container with *docker exec*. The project must have a container running. The VS Code integrated terminal needs access to your *PATH* environment variable so that it can run the *docker* command.
36+
- **Build**: Manually request an application build for this project. If the project has auto build enabled, this command should not be necessary because builds are triggered automatically with a code change. This command is also available in the project overview page. This command is equivalent to clicking the **Build** button in the Codewind **Overview** page.
3837

39-
- **Enable or disable project**: Enable or disable the project. This command is also available in the project info page.<br>
38+
- **Toggle auto build**: Enable or disable auto build for the project. This command is also available in the project overview.
39+
40+
- **Enable or disable project**: Enable or disable the project. This command is also available in the project overview.
41+
42+
- **Remove project**: Removes the project from Codewind. The project folder can optionally be deleted from disk after removal. This command is also available in the project overview.
4043

4144
## Logs
4245

@@ -46,8 +49,6 @@ This command is equivalent to clicking the **Build** button in the Codewind **Ov
4649

4750
- **Manage logs**: This command presents a list of all logs for this project, which you can toggle individually.
4851

49-
- **Project-specific settings**: Edit the internal app and debug ports as well as the **application endpoint**, sometimes known as the **context root**, from the **Project Overview** page.
50-
5152
## Configuring project settings
5253

5354
Project settings tell Codewind more about the specifics of your project and can affect the status and/or behaviour of your application. Project settings can be configured from the Project Overview page that is accessible from a project's context menu, or you can find the project settings in the `.cw-settings` file of the project which you can edit from the IDE. Changes to these fields are automatically picked up by the workspace.

docs/_documentations/mdt-vsc-importedprojects.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ order: 0
1212

1313
# Adding existing projects
1414

15-
Modifications are usually required to successfully add and deploy projects that have never been run in Codewind before. <!--The add process creates required files if they do not exist.--> This guide covers the basics of configuring a project to run in Codewind.
15+
Modifications are usually required to successfully add and deploy projects that have never been run in Codewind before. This guide covers the basics of configuring a project to run in Codewind.
1616

1717
## What kind of projects can I add?
1818

@@ -23,6 +23,7 @@ Codewind is designed to develop cloud native microservices. Therefore, each proj
2323
* [Node.js projects](#nodejs-projects)
2424
* [Swift projects](#swift-projects)
2525
* [Generic Docker projects](#generic-docker-projects)
26+
* [Appsody projects](#appsody-projects)
2627

2728
## MicroProfile/Java EE projects
2829

@@ -192,3 +193,8 @@ For example, you should be able to build the project by using the command
192193
## Generic Docker projects
193194

194195
If you have a Dockerized application that doesn't fit an existing template, you can still add the project to Codewind by selecting the **Other (Basic Container)** option as the project type. For the application state detection to work, the Dockerfile needs to include an `EXPOSE` instruction to point to the port that is used to determine whether the project is running.
196+
197+
## Appsody projects
198+
199+
If you have an existing Appsody project, or a project that you want to add to Codewind as an Appsody project, select the corresponding Appsody project type and, if applicable, the Appsody stack when adding the project.
200+
For more information about Appsody and Appsody stacks, see [https://appsody.dev](https://appsody.dev).

docs/_documentations/mdt-vsc-overview.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
layout: docs
3-
title: "Codewindfor VS Code"
3+
title: "Codewind for VS Code"
44
description: "Codewind for VS Code"
55
keywords: introducing, introduction, overview, what is, tools, vscode, visual, studio, code, java, microprofile, spring, node, nodejs, node.js, javascript, Codewind for VS Code, tools, view, debug, integrate, open a shell session, toggle auto build, manually build, scope VS Code workspace, disable, enable, delete
66
duration: 1 minute

0 commit comments

Comments
 (0)