Chapter 2. Calculating CodeReady Workspaces resource requirements

Procedure

1. Identify the workspace components explicitly specified in the components section of the Authoring a devfile 2.0.0.

2. Identify the implicit workspace components:

   1. CodeReady Workspaces implicitly loads the default cheEditor: che-theia, and the chePlugin that allows commands execution: che-machine-exec-plugin. To change the default editor, add a cheEditor component section in the devfile.
   2. The JWT Proxy component is responsible for the authentication and authorization of the external communications of the workspace components.

3. Calculate the requirements for each component:

   1. Default values:

      The following table displays the default requirements for all workspace components, and the corresponding CodeReady Workspaces server properties. Use the CodeReady Workspaces server properties to modify the defaults cluster-wide.

      Expand

      Table 2.2. Default requirements of workspace components by type

      Component types	CodeReady Workspaces server property	Default memory limit	Default memory request
      chePlugin	che.workspace.sidecar.default_memory_limit_mb	128 MiB	64 MiB
      cheEditor	che.workspace.sidecar.default_memory_limit_mb	128 MiB	64 MiB
      kubernetes, openshift, dockerimage	che.workspace.default_memory_limit_mb, che.workspace.default_memory_request_mb	1 Gi	200 MiB
      JWT Proxy	che.server.secure_exposer.jwtproxy.memory_limit, che.server.secure_exposer.jwtproxy.memory_request	128 MiB	15 MiB

      Show more

   2. Custom requirements for chePlugins and cheEditors components:

      1. Custom memory limit and request:

         Define the memoryLimit and memoryRequest attributes of the containers section of the meta.yaml file to configure the memory limit of the chePlugins or cheEditors components. CodeReady Workspaces automatically sets the memory request to match the memory limit if it is not specified explicitly.

         Example 2.1. The chePlugin che-incubator/typescript/latest

         meta.yaml spec section:

         spec:
          containers:
            - image: docker.io/eclipse/che-remote-plugin-node:next
              name: vscode-typescript
              memoryLimit: 512Mi
              memoryRequest: 256Mi

         Copy to Clipboard Toggle word wrap

         This results in a container with the following memory limit and request:

         Expand

         Memory limit	512 MiB
         Memory request	256 MiB

         Show more
         Note

         For IBM Power Systems (ppc64le), the memory limit for some plugins has been increased by up to 1.5G to allow pods sufficient RAM to run. For example, on IBM Power Systems (ppc64le), the Theia editor pod requires 2G; the OpenShift connector pod requires 2.5G. For AMD64 and Intel 64 (x86_64) and IBM Z (s390x), memory requirements remain lower at 512M and 1500M respectively. However, some devfiles may still be configured to set the lower limit valid for AMD64 and Intel 64 (x86_64) and IBM Z (s390x), so to work around this, edit devfiles for workspaces that are crashing to increase the default memoryLimit by at least 1 - 1.5 GB.

         Note

         How to find the meta.yaml file of chePlugin

         Community plug-ins are available in the CodeReady Workspaces plug-ins registry repository in folder v3/plugins/${organization}/${name}/${version}/.

         For non-community or customized plug-ins, the meta.yaml files are available on the local OpenShift cluster at ${pluginRegistryEndpoint}/v3/plugins/${organization}/${name}/${version}/meta.yaml.

      2. Custom CPU limit and request:

         CodeReady Workspaces does not set CPU limits and requests by default. However, it is possible to configure CPU limits for the chePlugin and cheEditor types in the meta.yaml file or in the devfile in the same way as it done for memory limits.

         Example 2.2. The chePlugin che-incubator/typescript/latest

         meta.yaml spec section:

         spec:
          containers:
            - image: docker.io/eclipse/che-remote-plugin-node:next
              name: vscode-typescript
              cpuLimit: 2000m
              cpuRequest: 500m

         Copy to Clipboard Toggle word wrap

         It results in a container with the following CPU limit and request:

         Expand

         CPU limit	2 cores
         CPU request	0.5 cores

         Show more

1. Custom requirements for dockerimage components

   Define the memoryLimit and memoryRequest attributes of the devfile to configure the memory limit of a dockerimage container. CodeReady Workspaces automatically sets the memory request to match the memory limit if it is not specified explicitly.

     - alias: maven
       type: dockerimage
       image: eclipse/maven-jdk8:latest
       memoryLimit: 1536M

   Copy to Clipboard Toggle word wrap

2. Custom requirements for kubernetes or openshift components:

   The referenced manifest may define the memory requirements and limits.

   1. Add all previously calculated requirements.