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 | Documentation |
|---|---|---|---|---|
| che | (this repository) the main project repository | devfile | doc | |
| --- | dockerfiles | source code, dockerfiles to build our main docker images. Note that Che-theia related dockerfiles are located in che-theia repo. | ||
| --- | wsmaster | orchestrates the Che workspaces with devfiles on Kubernetes | ||
| --- | tests | source code of our integration tests. | ||
| che-theia | Theia IDE integrated in Che. | devfile | doc | |
| --- | generator | che:theia init CLI to prepare and build che-theia |
||
| chectl | The CLI to install Che, create and start workspaces and devfiles | devfile | doc | |
| dashboard | UI to manage workspaces, devfiles, etc. | devfile | 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 | doc | |
| 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. | devfile | ||
| 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. | |||
| website | https://eclipse.org/che website source code. | devfile | ||
| workspace-client | JS library to interact with a che-server. | |||
| che-sidecar-bazel | Eclipse Che Sidecar container for Bazel tooling | |||
| che-sidecar-protobuf | Eclipse Che Sidecar container for Protobuf tooling | |||
| che-sidecar-tekton | Eclipse Che Sidecar container for Tekton tooling | |||
| che-sidecar-kubernetes-tooling | Eclipse Che Sidecar container for Kubernetes tooling | |||
| che-sidecar-openshift-connector | Eclipse Che Sidecar container for OpenShift connector tooling | |||
| che-container-tools | Base image used for sidecars that service container tooling plugins | |||
| che-sidecar-python | Eclipse Che Sidecar container for python tooling | |||
| che-custom-nodejs-deasync | Provides a custom nodejs binary embedding deasync node-gyp module as builtin module | |||
| che-sidecar-go | Eclipse Che sidecar container for go | |||
| che-sidecar-sonarlint | Eclipse Che sidecar container for sonalint extension | |||
| che-sidecar-dotnet | Eclipse Che sidecar container for dotnet | |||
| che-sidecar-shellcheck | Eclipse Che sidecar container for shellcheck | |||
| che-sidecar-camelk | Eclipse Che sidecar container for camelk | |||
| che-sidecar-vale | Eclipse Che sidecar container for vale | |||
| che-cert-manager-ca-cert-generator-image | CA cert generation job image used by chectl | |||
| che-buildkit-base | Eclipse Che Sidecar container for buildkit tooling | |||
| che-sidecar-scala | Eclipse Che Sidecar container for scala tooling | |||
| che-buildah-base | Use this image to build docker images using buildah | |||
| che-docker-registry-image-copier | copy images between public and private docker registry inside k8s cluster | |||
| che-php-base | Base image to be used for the PHP devfile | |||
| che-tls-secret-creator | This images generates TLS certificates | |||
| build-action | Custom GitHub Action for building sidecar Dockerfiles | |||
| che-sidecar-podman | Eclipse Che Sidecar container for podman tooling | |||
| che-sidecar-clang | Eclipse Che Sidecar container for clang tooling | |||
| che-sidecar-php | Eclipse Che Sidecar container for php tooling | |||
| che-sidecar-java | Eclipse Che Sidecar container for java tooling | |||
| che-sidecar-dependency-analytics | Eclipse Che Sidecar container for dependency analytics tooling | |||
| che-sidecar-node | Eclipse Che Sidecar container for node tooling | |||
| che-theia-openshift-auth | OpenShift authentication plugin | |||
| configbump | Simple Kubernetes controller that is able to quickly synchronize a set of config maps | |||
| workspace-data-sync | Provides the ability to increase I/O performance for a developer workspaces | |||
| che-workspace-telemetry-client | abstract telemetry API and a Typescript implementation of the API. | |||
| kubernetes-image-puller | ensures that all nodes in the cluster have those images cached |
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.yamlor
$ chectl workspace:start -f https://github.com/raw/eclipse/che-theia/master/devfiles/che-theia-all.devfile.yamlor https://<CheInstance>/f?url=https://github.com/raw/eclipse/che-theia/master/devfiles/che-theia-all.devfile.yaml
Let's cover the developer flow for theses projects:
Dashboard source code is located in https://github.com/eclipse-che/che-dashboard repository. It is an AngularJS application. Here is the developer workflow if you want to contribute to it:
The devfile: https://github.com/eclipse-che/che-dashboard/blob/master/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:
- Start the workspace with the devfile, it is cloning Che repo.
- Build
- Code ...
- Run unit test
- Start dashboard server and preview
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://github.com/raw/eclipse-che/che-dashboard/master/devfile.yamlIn 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]
$ yarnIn 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 testIn 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>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_HOMEenvironment 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_HOSTwith the endpoint of new Che master. If using the devfile the endpoint ische-devand already set. - After, set
CHE_INFRASTRUCTURE_ACTIVEaccording to your environment. For example:openshift(note, usekubernetesandopenshiftinsted ofminikubeandminishiftcorrespondingly). - Run
/entrypoint.sh. After this, new Che master should be accesible from theche-devendpoint. To reach Swagger use url fromche-devendpoint with/swaggersuffix.
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
EOFAlso 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.
Che repositories includes a GitHub Pull Request Template. Contributors must read and complete the template. In particular there is a list of requirements that the author needs to fulfil to merge the PR. This sections goes into the details of this checklist.
The author has completed the Eclipse Contributor Agreement and has signed the commits using his email.
No TODO comments left in the PR source code.
The author has verified that code builds, tests pass and linters are happy.
If the Pull Request fixes a bug it must includes a new automated test. The test validates the fix and protect against future regressions.
The devfile commands used to build and run the application are still working.
Never omit the two sections "What issues does this PR fix or reference" and "How to test this PR".
The author has documented the changes to Che installation, usage or management in Che documentation.
Document changes to the steps to contribute to the project in the CONTRIBUTING.md files.
Update CI/CD scripts and documentation when the PR includes changes to the build, test, distribute or deploy procedures. Communicate CI/CD changes to the whole community with an email.