Chapter 5. Customizing developer environments

Procedure

1. Edit the che-theia-plugins.yaml file and create a new entry.

   - id: publisher/my-vscode-ext                                    1
     repository:                                                    2
       url: https://github.com/publisher/my-vscode-ext              3
       revision: 1.7.2                                              4
     aliases:                                                       5
       - publisher/my-vscode-ext-revised
     preferences:                                                   6
       asciidoc.use_asciidoctorpdf: true
       shellcheck.executablePath: /bin/shellcheck
       solargraph.bundlerPath: /usr/local/bin/bundle
       solargraph.commandPath: /usr/local/bundle/bin/solargraph
     sidecar:                                                       7
       image: quay.io/repository/eclipse/che-plugin-sidecar:sonarlint-2fcf341  8
       name: my-vscode-ext-sidecar                                  9
       memoryLimit: "1500Mi"                                        10
       memoryRequest: "1000Mi"                                      11
       cpuLimit: "500m"                                             12
       cpuRequest: "125m"                                           13
       command:                                                     14
           - /bin/sh
       args:                                                        15
           - "-c"
           - "./entrypoint.sh"
       volumeMounts:                                                16
         - name: vscode-ext-volume                                  17
           path: "/home/theia/my-vscode-ext"                        18
       endpoints:                                                   19
         - name: "configuration-endpoint"                           20
           public: true                                             21
           targetPort: 61436                                        22
           attributes:                                              23
             protocol: http
     extension: https://github.com/redhat-developer/vscode-yaml/releases/download/0.4.0/redhat.vscode-yaml-0.4.0.vsix    24
     skipDependencies:                                              25
       - id-of/extension1
       - id-of/extension2
     extraDependencies:                                             26
       - id-of/extension1
       - id-of/extension2
     metaYaml:
       skipIndex: <true|false>                                      27
       skipDependencies:                                            28
         - id-of/extension1
         - id-of/extension2
       extraDependencies:                                           29
         - id-of/extension1
         - id-of/extension2

Procedure

1. Create a meta.yaml file.

2. Edit the meta.yaml file and provide the necessary information. The file must have the following structure:

   apiVersion: v2                                                   1
   publisher: myorg                                                 2
   name: my-vscode-ext                                              3
   version: 1.7.2                                                   4
   type: value                                                      5
   displayName:                                                     6
   title:                                                           7
   description:                                                     8
   icon: https://www.eclipse.org/che/images/logo-eclipseche.svg     9
   repository:                                                     10
   category:                                                       11
   spec:
     containers:                                                   12
       - image:                                                    13
         memoryLimit:                                              14
         memoryRequest:                                            15
         cpuLimit:                                                 16
         cpuRequest:                                               17
     extensions:                                                   18
             - https://github.com/redhat-developer/vscode-yaml/releases/download/0.4.0/redhat.vscode-yaml-0.4.0.vsix
             - https://github.com/SonarSource/sonarlint-vscode/releases/download/1.16.0/sonarlint-vscode-1.16.0.vsix

   1

   Version of the file structure.

   2

   Name of the plug-in publisher. Must be the same as the publisher in the path.

   3

   Name of the plug-in. Must be the same as in path.

   4

   Version of the plug-in. Must be the same as in path.

   5

   Type of the plug-in. Possible values: Che Plugin, Che Editor, Theia plugin, VS Code extension.

   6

   A short name of the plug-in.

   7

   Title of the plug-in.

   8

   A brief explanation of the plug-in and what it does.

   9

   The link to the plug-in logo.

   10

   Optional. The link to the source-code repository of the plug-in.

   11

   Defines the category that this plug-in belongs to. Should be one of the following: Editor, Debugger, Formatter, Language, Linter, Snippet, Theme, or Other.

   12

   If this section is omitted, the VS Code extension is added into the Che-Theia IDE container.

   13

   The Docker image from which the sidecar container will be started. Example: theia-endpoint-image.

   14

   The maximum RAM which is available for the sidecar container. Example: "512Mi". This value might be overridden by the user in the component configuration.

   15

   The RAM which is given for the sidecar container by default. Example: "256Mi". This value might be overridden by the user in the component configuration.

   16

   The maximum CPU amount in cores or millicores (suffixed with "m") which is available for the sidecar container. Examples: "500m", "2". This value might be overridden by the user in the component configuration.

   17

   The CPU amount in cores or millicores (suffixed with "m") which is given for the sidecar container by default. Example: "125m". This value might be overridden by the user in the component configuration.

   18

   A list of VS Code extensions run in this sidecar container.

3. Publish the meta.yaml file as an HTTP resource by creating a gist on GitHub or GitLab with a file content published there.

Procedure

1. Describe the IDE with an editor descriptor - meta.yaml file:

   version: 1.0.0
   editors:
     - id: eclipse/che-theia/next
       title: Eclipse Theia development version.
       displayName: theia-ide
       description: Eclipse Theia, get the latest release each day.
       icon: https://raw.githubusercontent.com/theia-ide/theia/master/logo/theia-logo-no-text-black.svg?sanitize=true
       repository: https://github.com/eclipse-che/che-theia
       firstPublicationDate: "2021-01-01"
       endpoints:
         - name: "theia"
           public: true
           targetPort: 3100
           attributes:
             protocol: http
             type: ide
             secure: true
             cookiesAuthEnabled: true
             discoverable: false
       containers:
         - name: theia-ide
           image: "<your-ide-image>"
           mountSources: true
           ports:
             - exposedPort: 3100
           memoryLimit: "512M"

   targetPort and exposedPort must be the same as the Theia-based IDE running inside the container. Replace <your-ide-image> with the name of the IDE image. The meta.yaml file should be publicly accessible through an HTTP(S) link.

2. Add your editor to a Devfile:

   apiVersion: 1.0.0
   metadata:
     name: che-theia-based-ide
   components:
     - type: cheEditor
       reference: '<meta.yaml URL>'

   <meta.yaml URL> should point to the publicly hosted meta.yaml file described in the previous step.

Procedure

1. Navigate to the CodeReady Workspaces Dashboard. See Section 1.1, “Navigating CodeReady Workspaces using the Dashboard”.

2. Navigate to User Preferences.

   1. Click on your username in the top right corner.
   2. Click the User Preferences tab.

3. Click the Add Container Registry button in Container Registries tab and execute following actions:

   • Enter the container registry domain name in the Registry field.
   • Optionally, enter the username of your account at this registry in the Username field.
   • Enter the password in the Password field to authenticate in the container registry.
4. Click the Add button.

Verification

1. See that there is a new entry in the Container Registries tab.
2. Create a workspace that uses a container image from the specified container registry. See Section 4.2, “Authoring devfiles version 2”.