此内容没有您所选择的语言版本。

Chapter 5. Selecting a workspace IDE

The default in-browser IDE in a new workspace is Microsoft Visual Studio Code - Open Source.

Note

Because the OpenShift Dev Spaces build of Microsoft Visual Studio Code - Open Source supports custom branding, your organization might be using a branded build.

You can select another supported in-browser IDE by either method:

When you start a new workspace by visiting a URL, you can choose an IDE for that workspace by adding the che-editor parameter to the URL. See Section 5.1, “Selecting an in-browser IDE for one new workspace”.
You can specify an IDE in the .che/che-editor.yaml file of the Git repository for all new workspaces that will feature a clone of that repository. See Section 5.2, “Selecting an in-browser IDE for all workspaces that clone the same Git repository”.

Expand

Table 5.1. Supported in-browser IDEs
IDE	`id`	Note
Microsoft Visual Studio Code - Open Source	`che-incubator/che-code/insiders`	This is the default IDE that loads in a new workspace when the URL parameter or `che-editor.yaml` is not used.
JetBrains IntelliJ IDEA Community Edition	`che-incubator/che-idea/latest`	Technology Preview.
Eclipse Theia	`eclipse/che-theia/latest`	Deprecated and will be removed in a future release.

5.1. Selecting an in-browser IDE for one new workspace
复制链接

You can select your preferred in-browser IDE when using a URL for starting a new workspace. This way, each developer using OpenShift Dev Spaces can start a workspace with a clone of the same project repository and the personal choice of the in-browser IDE.

Procedure

Include the Section 2.2.2, “URL parameter for the workspace IDE” in the URL for starting a new workspace.
Visit the URL in the browser.

Verification

Verify that the selected in-browser IDE loads in the browser tab of the started workspace.

5.2. Selecting an in-browser IDE for all workspaces that clone the same Git repository
复制链接

5.2.1. Setting up che-editor.yaml
复制链接

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.

Procedure

In the remote Git repository of your project, create a /.che/che-editor.yaml file with lines that specify the relevant parameter, as described in the next section.

Verification

Visit the URL for starting a new workspace.
Verify that the selected in-browser IDE loads in the browser tab of the started workspace.

5.2.2. Parameters for che-editor.yaml
复制链接

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:

Example 5.1. id selects an IDE from the plugin registry

id: che-incubator/che-idea/latest

id: che-incubator/che-idea/latest

Copy to Clipboard

Toggle word wrap

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 plugin registry:

Example 5.2. reference points to a remote che-editor.yaml file

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

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

Copy to Clipboard

Toggle word wrap

Example 5.3. inline specifies a complete definition for a customized IDE without a plugin registry

inline:
  schemaVersion: 2.1.0
  metadata:
    name: JetBrains IntelliJ IDEA Community IDE
  components:
    - name: intellij
      container:
        image: 'quay.io/che-incubator/che-idea:next'
        volumeMounts:
          - name: projector-user
            path: /home/projector-user
        mountSources: true
        memoryLimit: 2048M
        memoryRequest: 32Mi
        cpuLimit: 1500m
        cpuRequest: 100m
        endpoints:
          - name: intellij
            attributes:
              type: main
              cookiesAuthEnabled: true
              urlRewriteSupported: true
              discoverable: false
              path: /?backgroundColor=434343&wss
            targetPort: 8887
            exposure: public
            secure: false
            protocol: https
      attributes: {}
    - name: projector-user
      volume: {}

inline:
  schemaVersion: 2.1.0
  metadata:
    name: JetBrains IntelliJ IDEA Community IDE
  components:
    - name: intellij
      container:
        image: 'quay.io/che-incubator/che-idea:next'
        volumeMounts:
          - name: projector-user
            path: /home/projector-user
        mountSources: true
        memoryLimit: 2048M
        memoryRequest: 32Mi
        cpuLimit: 1500m
        cpuRequest: 100m
        endpoints:
          - name: intellij
            attributes:
              type: main
              cookiesAuthEnabled: true
              urlRewriteSupported: true
              discoverable: false
              path: /?backgroundColor=434343&wss
            targetPort: 8887
            exposure: public
            secure: false
            protocol: https
      attributes: {}
    - name: projector-user
      volume: {}

Copy to Clipboard

Toggle word wrap

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

Example 5.4. registryUrl points to a custom plugin registry rather than to the default OpenShift Dev Spaces plugin registry

id: <editor_id> 
registryUrl: <url_of_custom_plugin_registry>

id: <editor_id>


registryUrl: <url_of_custom_plugin_registry>

Copy to Clipboard

Toggle word wrap

1: The id of the IDE in the custom plugin registry.

Example 5.5. override of the default value of one or more defined properties of the IDE

... 
override:
  containers:
    - name: che-idea
      memoryLimit: 1280Mi
      cpuLimit: 1510m
      cpuRequest: 102m
    ...

...


override:
  containers:
    - name: che-idea
      memoryLimit: 1280Mi
      cpuLimit: 1510m
      cpuRequest: 102m
    ...

Copy to Clipboard

Toggle word wrap

1: id:, registryUrl:, or reference:.

此内容没有您所选择的语言版本。

Chapter 5. Selecting a workspace IDE

5.1. Selecting an in-browser IDE for one new workspace
复制链接

5.2. Selecting an in-browser IDE for all workspaces that clone the same Git repository
复制链接

5.2.1. Setting up che-editor.yaml
复制链接

5.2.2. Parameters for che-editor.yaml
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

此内容没有您所选择的语言版本。

Chapter 5. Selecting a workspace IDE

5.1. Selecting an in-browser IDE for one new workspace复制链接链接已复制到粘贴板!

5.2. Selecting an in-browser IDE for all workspaces that clone the same Git repository复制链接链接已复制到粘贴板!

5.2.1. Setting up che-editor.yaml复制链接链接已复制到粘贴板!

5.2.2. Parameters for che-editor.yaml复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

5.1. Selecting an in-browser IDE for one new workspace
复制链接

5.2. Selecting an in-browser IDE for all workspaces that clone the same Git repository
复制链接

5.2.1. Setting up che-editor.yaml
复制链接

5.2.2. Parameters for che-editor.yaml
复制链接