Chapter 5. Selecting a workspace IDE

To define the same in-browser IDE for all workspaces that will clone the same remote Git repository of your project, you can use the che-editor.yaml file.

This way, you can set a common default editor for your team and provide new contributors with the most suitable editor for your project. You can also use the che-editor.yaml file when you need to set a different IDE default for a particular project repository rather than the default IDE of your organization’s OpenShift Dev Spaces instance.

The simplest way to select an IDE in the che-editor.yaml is to specify the id of an IDE that is available in the table of supported in-browser IDEs in Chapter 5, Selecting a workspace IDE:

id: che-incubator/che-code/insiders

As alternatives to providing the id parameter, the che-editor.yaml file supports a reference to the URL of another che-editor.yaml file or an inline definition for an IDE outside of a plug-in registry:

reference: https://<hostname_and_path_to_a_remote_file>/che-editor.yaml

inline:
  schemaVersion: 2.1.0
  metadata:
    name: theia-ide
  commands:
    ...
  events:
    ...
  components:
    - name: che-machine-exec
      container:
        image: 'quay.io/eclipse/che-machine-exec:next'
        command:
          ...
        memoryLimit: 128Mi
        memoryRequest: 32Mi
        cpuLimit: 500m
        cpuRequest: 30m
      attributes:
...

For more complex scenarios, the che-editor.yaml file supports the registryUrl and override parameters:

id: <editor_id> 1
registryUrl: <url_of_custom_plug-in_registry>

... 1
override:
  containers:
    - name: theia-ide
      memoryLimit: 1280Mi
      cpuLimit: 1510m
      cpuRequest: 102m
    ...