codewind-che-plugin

README

Codewind Che Plug-in

Create and develop cloud-native, containerized web applications with Codewind on Eclipse Che

Installing Codewind on Eclipse Che

To install Codewind on Eclipse Che, please consult Installing and Using Codewind on Kubernetes

What is the Eclipse Codewind sidecar container?

The Codewind sidecar container includes the following responsibilities:

• The sidecar deploys the Codewind server and Performance Dashboard containers.
  • The Golang-based deploy-pfe utility handles this
  • When the workspace is shut down or deleted, the Codewind containers and projects are automatically torn down too.
• The sidecar sets up a reverse proxy for the Theia extension.
  • Nginx is used for the proxy because it can handle both HTTP requests and socket.io.
  • The Theia plug-in communicates with the reverse proxy, which then forwards requests to Codewind. This chain of communication avoids the addition of code in the Theia plug-in to discover and manage the connection to Codewind.
• The sidecar runs the filewatcherd daemon to track user code changes.
  • The filewatcherd daemon watches for changes in each user's project and communicates with Codewind, letting it know to start a build if required.
  • For more information on filewatcherd, see eclipse/codewind-filewatchers.

Developing

Prerequisites

• Install Docker 17.05 or later.

Building

To build the sidecar image, run ./build.sh.

Deploying

For instructions on deploying custom builds of the Codewind Che plugin, consult DEVELOPING.md

Contributing

We use the main Codewind git repo (https://github.com/eclipse/codewind) for issue tracking.

Submit issues and contributions:

1. Submitting issues
2. Contributing