Skip to content

Latest commit

 

History

History
281 lines (199 loc) · 14.2 KB

CONTRIBUTING.md

File metadata and controls

281 lines (199 loc) · 14.2 KB
Raw

Contributing to Che

Other Che repositories

Che is composed of multiple sub projects. For each projects we provide a CONTRIBUTE.md file describing how to setup the development environment to start your contribution. Most of the time, we encourage you to use Che to contribute to Che.

Repository Component Description Devfile Contributing.md
che (this repository) the main project repository
--- wsmaster orchestrates the Che workspaces with devfiles on Kubernetes devfile doc
--- dashboard UI to manage workspaces, devfiles, etc. devfile doc
--- dockerfiles source code, dockerfiles to build our main docker images. Note that Che-theia related dockerfiles are located in che-theia repo.
--- e2e source code of our integration tests.
--- workspace-loader devfile doc
chectl The CLI to install Che, create and start workspaces and devfiles devfile doc
che-theia Theia IDE integrated in Che. devfile doc
--- generator che:theia init CLI to prepare and build che-theia doc
devfile-registry The default set of devfiles that would be made available on the Che dashboard stacks.
docs Eclipse Che documentation https://www.eclipse.org/che/docs/ source code. devfile
machine-exec Interface to execute tasks and terminals on other containers within a workspace. devfile doc
operator Che operator to deploy, update and manage K8S/OpenShift resources of Che.
plugin-broker The workspace microservice that is in charge of analyzing, preparing and installing the workspace components defined in a Devfile. devfile doc
plugin-registry The default set of Che plugins (vscode extension + containers) or editors that could be installed on any Che workspaces.
redhat-developer/devfile Contribute to the devfile documentation: https://redhat-developer.github.io/devfile/
website https://eclipse.org/che website source code. devfile
workspace-client JS library to interact with a che-server.

Devfile to contribute

We are trying to provide a devfile for each areas where you could contribute. Each devfile could be run on any Che instances to setup a ready-to-code developer environment. Beware that each of them may need a certain amount of memory. Devfile could be launched through a factory or chectl cli.

$ chectl workspace:start -f devfiles/che-theia-all.devfile.yaml

or

$ chectl workspace:start -f https://raw.githubusercontent.com/eclipse/che-theia/master/devfiles/che-theia-all.devfile.yaml

or https://<CheInstance>/f?url=https://raw.githubusercontent.com/eclipse/che-theia/master/devfiles/che-theia-all.devfile.yaml

Contribute to ...

Let's cover the developer flow for theses projects:

Dashboard

Dashboard source code is located in <this.repo>/dashboard folder. It is an AngularJS application. Here is the developer workflow if you want to contribute to it:

Devfile for dashboard development

The devfile: <this.repo>/dashboard/devfile.yaml

In this section, we show how to setup a Che environment to work on the Che dashboard, and how to use it. For the whole workflows, we will need a workspace with such containers:

  • Dashboard Dev container (a.k.a dash-dev): Dashdev is a all in one container for running commands such as build, test or start the dashboard server.

All containers have /projects folder mounted, which is shared among them.

Developer workflow:

  1. Start the workspace with the devfile, it is cloning Che repo.
  2. Build
  3. Code ...
  4. Run unit test
  5. Start dashboard server and preview

Step 1: Start the workspace with the devfile, it is cloning Che repo.

In this section we are going to start a new workspace to work on che-theia. The new workspace will have few projects cloned: theia and che-theia. It will also setup the containers and commands in the My workspace view. We will use these commands in the next steps.

The devfile could be started using chectl:

$ chectl workspace:start -f https://raw.githubusercontent.com/eclipse/che/master/dashboard/devfile.yaml

At workspace start, Che will clone Che source code (including the dashboard)

Step 2: Build

In this section we are going to build the dashboard project.

You can use the Che command dashboard_build (command pallette > Run task > … or containers view) Basically, this command will run

# [dash-dev]
$ yarn

Step 3: Code ...

Step 4: Run unit test (optional)

In this step, we will run the Dashboard unit tests:

You can use the Che command dashboard_test (command pallette > Run task > … or containers view) Basically, this command will run

# [dash-dev]
$ yarn test

Step 5: Start dashboard server and preview

In this step, we will run the dashboard server and see the live reloadable preview.

You can use the Che command dashboard_dev_server (command pallette > Run task > … or containers view)

# [dashboard_dev_server]
$ node_modules/.bin/gulp serve --server=<che_api_url>

Workspace Loader

Workspace loader source code is located in <this.repo>/workspace-loader folder. Here is the developer workflow if you want to contribute to it:

Devfile for workspace loader development

The devfile: <this.repo>/workspace-loader/devfile.yaml

This section shows you how to setup a Che environment to work on the Che Workspace Loader, and how to use it. For the whole workflows, we will need a workspace with Workspace Loader Dev container (a.k.a ws-loader-dev). Dev container is all in one container for running commands such as build, test or start the workspace loader server.

Developer workflow:

Step 1: Start the workspace with the workspace-loader devfile

In this section we are going to start a new workspace to work on workspace loader. The new workspace will clone the Eclipse Che project. Containers and commands could be found in the My workspace view. We will use these commands in the next steps.

The workspace could be created and started from a devfile using chectl:

$ chectl workspace:start --devfile=https://raw.githubusercontent.com/eclipse/che/master/workspace-loader/devfile.yaml

or as a factory https://<CheInstance>/f?url=https://raw.githubusercontent.com/eclipse/che/master/workspace-loader/devfile.yaml

At workspace start, Che will clone Che source code (including the workspace-loader)

Step 2: Install workspace-loader dependencies

Use the command [workspace loader] install dependencies

or

# [ws-loader-dev]
$ yarn

Step 3: Code workspace-loader

Now you can make changes in Workspace Loader

Step 4: Build workspace-loader

Use the command [workspace loader] run build

or

# [ws-loader-dev]
$ yarn build

Step 5: Run workspace-loader unit tests (optional)

Use the command [workspace loader] run tests

or

# [ws-loader-dev]
$ yarn test

Step 6: Start workspace loader server

Use the command [workspace loader] start dev server

or

# [ws-loader-dev]
$ yarn start --disable-host-check --public=$(echo ${server.dev-server} | sed -e s/https:\\/\\/// -e s/http:\\/\\/// -e s/\\///) --host="0.0.0.0" --env.target=${CHE_API_EXTERNAL%????}

Step 7: Testing new workspace loader

When workspace loader server is run, one probably need to test introduced changes.

To safely test the changes it is better to create a separate workspace which will be used by new loader. But by default, Che doesn't allow to run more than one workspace simultaneously. To change this behaviour one need to set che.limits.user.workspaces.run.count Che property to value greater than 1. In development environment that could be reached by adding CHE_LIMITS_USER_WORKSPACES_RUN_COUNT environment variable for Che server deployment. Please note, after changing deployment config one need to apply changes by rolling out (or rescaling) the corresponding pod (in case of Openshift just add the environment variable via Openshift dashboard in the Environment tab of the Che server deployment and the pod will be rolled out automatically).

To be able to point new workspace loader to the test workspace it is required to add the the test workspace id to the path of workspace loader route. So, first, we need to retrieve the test workspace id. This could be done using swagger (please note, it might be disabled on production environment). To open swagger just open Che dashboard and replace the path with swagger. Then navigate to workspace section GET /workspace method. It will return all user workspaces. Find the test workspace id. Second, to modify the path of the workspace loader server uri, retrieve the route of the server. To do it, find workspace loader dev workspace id from the query in swagger above and use it as a key in GET /workspace/{key} method. From the response get the workspace loader server url (if using the given defile for workspace loader development it should be under runtime.machines.ws-loader-dev.serevrs.dev-server.url key).

The uri of workspace loader pointed to the test workspace should look like: <workspace-loader-route>/<test-workspace-id>. For example: http://server60zomi2d-dev-server-3000.192.168.99.100.nip.io/workspaceztcx9u432labmvxi or http://routeu5efcg53-che.apps-crc.testing/workspaceztcx9u432labmvxi (depending on the infrastructure on which Che is run).

In most cases multiuser Che is deployed. To permit all the required connections one need to edit Keycloak settings. Open keycloak dashboard (the route could be obtained via Kubernetes or Openshift dashboard) and navigate to Clients, select che-public and Settings tab. Then add the route with /* suffix into Valid Redirect URIs section and the original route without trailing slash into Web Origins section. Save changes.

After this opening the obtained uri will open new workspace loader which will start (if not started yet) and open the test workspace.

Che server a.k.a WS master

There is a devfile for development of Che server in Che. To build Che one may run a predefined build task from the devfile.

Starting Che master requires some manual steps. Open a terminal in runtime container (che-server-runtime) and perform:

  • First, set CHE_HOME environment variable with absolute path to parent folder of Che master's Tomcat. It might look like /projects/che/assembly/assembly-main/target/eclipse-che-*-SNAPSHOT/eclipse-che-*-SNAPSHOT.
  • Then set CHE_HOST with the endpoint of new Che master. If using the devfile the endpoint is che-dev and already set.
  • After, set CHE_INFRASTRUCTURE_ACTIVE according to your environment. For example: openshift (note, use kubernetes and openshift insted of minikube and minishift correspondingly).
  • Run /entrypoint.sh. After this, new Che master should be accesible from the che-dev endpoint. To reach Swagger use url from che-dev endpoint with /swagger suffix.

To start a workspace from Che server under development some additional configuration of the cluster is needed. One should add rights for the service account to be able to perform all needed for Che server actions. Example for Openshift (in case of Kubernetes replace oc with kubectl):

cat << EOF | oc apply -f -
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
  labels:
    app: che
    component: che
  name: che-workspace-admin
  namespace: che
roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: admin
subjects:
- kind: ServiceAccount
  name: che-workspace
  namespace: che
EOF

Also CHE_API_INTERNAL, CHE_API_EXTERNAL and CHE_API should be set in runner container and point to new Che server API. If one uses provided devfile, they are already set to: http://che-dev:8080/api, which should be changed in case of https protocol.