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

Commit

Permalink
Update to latest 050 (#194)
Browse files Browse the repository at this point in the history
Signed-off-by: Sarah Ishida <[email protected]>
  • Loading branch information
sishida authored and sghung committed Oct 24, 2019
1 parent dd4fe42 commit 0525bc0
Show file tree
Hide file tree
Showing 11 changed files with 242 additions and 31 deletions.
3 changes: 3 additions & 0 deletions docs/_data/newstoc.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
- title: 'Codewind 0.50'
url: news05.html

- title: 'Codewind 0.40'
url: news04.html

Expand Down
2 changes: 1 addition & 1 deletion docs/_documentations/dockerregistry.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Before you deploy your project with Codewind, first specify a deployment registr
1. When you first deploy a project in Codewind, Codewind prompts you to set a deployment registry.
- If Codewind detects the registry is unset, Codewind prompts before deploying a project.
2. Enter a path with which to push your container.
- **Important:** Before attempting this step, ensure that you have entered the registry credentials with the Che dashboard.
- **Important:** Before attempting this step, ensure that you have correctly entered the registry credentials in the Che dashboard in Step 1.
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.

### Instructions specific to IBM Cloud Private
Expand Down
38 changes: 27 additions & 11 deletions docs/_documentations/installoncloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ parent: root
4. [After installing Che](#after-installing-che)
5. [Creating the Codewind workspace](#creating-the-codewind-workspace)
6. [Updating the version](#updating-the-version)
7. [Adding additional rules to support Codewind ODO extension](#adding-additional-rules-to-support-codewind-odo-extension)

## Prerequisites
- Set up the PersistentVolume (PV) with either Network File System (NFS) or GlusterFS.
Expand All @@ -27,7 +28,7 @@ parent: root
- Ensure the cluster can pull images from `docker.io/eclipse`.
- 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.
- Set up the ClusterRole for Codewind.
1. Clone the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin)
1. Clone the [Codewind Che plug-in repository](https://github.com/eclipse/codewind-che-plugin).
2. Enter the `cd` command to go to the `codewind-che-plugin` repository.
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 the `kubectl apply -f setup/install_che/codewind-rolebinding.yaml` command.
Expand All @@ -41,7 +42,7 @@ Complete the following steps after you install `chectl`:
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.
- 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`.
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.
- Set the `spec.server.ingressDomain` field in the Che .yaml to the Ingress domain.
- Set the `spec.server.ingressDomain` field in the Che `.yaml` to the Ingress domain.
3. Install Che:
- On OpenShift 3.x run the following command: `chectl server:start --platform=openshift --installer=operator --che-operator-cr-yaml=<codewind-che.yaml file>`
- On Kubernetes run the following command: `chectl server:start --platform=k8s --installer=operator --domain=<ingress-domain> --che-operator-cr-yaml=<codewind-che.yaml file>`
Expand All @@ -55,29 +56,28 @@ Codewind is required to run as privileged and as root, because it builds contain

### Adding registries in Che
After Che is started and running, add the container registry that will be used with Codewind.
- On IBM Cloud Private, push your
to any Docker registry *except* the internal Docker registry
- 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.
- 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.
- On IBM Cloud Private, you can push your image to any Docker registry *except* the internal Docker registry.

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

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

## Creating the Codewind workspace

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

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

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

### Setting the Docker registry
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
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.

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>

Expand Down Expand Up @@ -136,4 +136,20 @@ Go to **View**>**Find Command…**>**Codewind: Build**.
- 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"}'`

## Updating the version
Restart the Codewind workspace in Che. Che automatically pulls the newest version of Codewind and the Theia extension.
Restart the Codewind workspace in Che. Che automatically pulls the newest version of Codewind and the Theia extension.

## Adding additional rules to support Codewind ODO extension
The Codewind ODO extension needs to add additional rules for accessing OpenShift resources:
1. In your home directory, run the following command to clone the Codewind ODO extension repository:
```
git clone https://github.com/eclipse/codewind-odo-extension
```
2. Login to your OpenShift/OKD cluster
3. Go into `~/codewind-odo-extension/odo-RBAC` then run the following commands to add additional rules:
```
kubectl apply -f codewind-odoclusterrole.yaml
kubectl apply -f codewind-odoclusterrolebinding.yaml
```

# Codewind OpenShift Do (ODO) extension
Extension to Codewind providing support for OpenShift projects: https://github.com/eclipse/codewind-odo-extension
12 changes: 12 additions & 0 deletions docs/_documentations/mdt-che-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,15 @@ The Eclipse tools are [open source](https://github.com/eclipse/codewind-eclipse)
To get started, see [Getting started with Codewind](mdteclipsegettingstarted.html).

To uninstall Codewind, see [Uninstalling Codewind for Eclipse](mdteclipseuninstall.html)

## Codewind OpenShift (ODO) extension
Extension to Codewind providing support for ODO projects: https://codewind.dev

### Add additional rules to support Codewind ODO extension
The ODO extension needs to add additional rules for accessing OpenShift resources:
1. In your home directory, run the following command to clone the ODO extension repository:
`git clone https://github.com/eclipse/codewind-odo-extension`
2. Login to your OpenShift/OKD cluster
3. Go into `~/codewind-odo-extension/odo-RBAC` then run the following commands to add additional rules:
`kubectl apply -f codewind-odoclusterrole.yaml`
`kubectl apply -f codewind-odoclusterrolebinding.yaml`
8 changes: 7 additions & 1 deletion docs/_documentations/mdt-eclipse-importedprojects.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ order: 0

# Adding existing projects

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.
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.

## What kind of projects can I add?

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

## MicroProfile/Java EE projects

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

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.

## Appsody projects

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.
For more information about Appsody and Appsody stacks, see [https://appsody.dev](https://appsody.dev).
21 changes: 11 additions & 10 deletions docs/_documentations/mdt-vsc-commands-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,23 @@ Right-click a project in the **Codewind view** to see most project commands. All

- **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.

- **Open application monitor**: Open the Codewind **Application Monitor** page for this project in the system browser.
- **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.

- **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**.
- **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.

- **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.
- **Open Application Monitor**: Open the Codewind **Application Monitor** page for this project in the system browser.

- **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.
This command is equivalent to clicking the **Build** button in the Codewind **Overview** page.
- **Open Performance Dashboard**: Opens the performance dashboard in the browser. This action is available only when the application is running or debugging.

- **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.
- **Add Project to Workspace**: Add this project's folder on your local disk to your VS Code workspace.

- **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.
- **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.

- **Enable or disable project**: Enable or disable the project. This command is also available in the project info page.<br>
- **Toggle auto build**: Enable or disable auto build for the project. This command is also available in the project overview.

- **Enable or disable project**: Enable or disable the project. This command is also available in the project overview.

- **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.

## Logs

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

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

- **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.

## Configuring project settings

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.
Expand Down
8 changes: 7 additions & 1 deletion docs/_documentations/mdt-vsc-importedprojects.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ order: 0

# Adding existing projects

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.
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.

## What kind of projects can I add?

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

## MicroProfile/Java EE projects

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

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.

## Appsody projects

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.
For more information about Appsody and Appsody stacks, see [https://appsody.dev](https://appsody.dev).
2 changes: 1 addition & 1 deletion docs/_documentations/mdt-vsc-overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: docs
title: "Codewindfor VS Code"
title: "Codewind for VS Code"
description: "Codewind for VS Code"
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
duration: 1 minute
Expand Down
Loading

0 comments on commit 0525bc0

Please sign in to comment.