[jb] extract backend plugin to own image

components/BUILD.yaml

@@ -42,6 +42,8 @@ packages:
       - components/ide/code-desktop:docker
       - components/ide/code-desktop:docker-insiders
       - components/ide/code:docker
+      - components/ide/jetbrains/backend-plugin:stable
+      - components/ide/jetbrains/backend-plugin:latest
       - components/ide/jetbrains/image:goland
       - components/ide/jetbrains/image:goland-latest
       - components/ide/jetbrains/image:intellij

components/gitpod-protocol/src/ide-protocol.ts

@@ -116,4 +116,14 @@ export interface IDEOption {
      * we resolve the tag regularly to the most recent image version.
      */
     resolveImageDigest?: boolean;
+
+    /**
+     * The plugin image ref for the IDE image, this image ref always resolve to digest.
+     */
+    pluginImage?: string;
+
+    /**
+     * The latest plugin image ref for the latest IDE image, this image ref always resolve to digest.
+     */
+    pluginLatestImage?: string;
 }

components/gitpod-protocol/src/workspace-instance.ts

@@ -246,6 +246,9 @@ export interface WorkspaceInstanceConfiguration {
     // desktopIdeImage is the ref of the desktop IDE image this instance uses.
     desktopIdeImage?: string;
 
+    // desktopIdePluginImage is the ref of the desktop IDE plugin image this instance uses.
+    desktopIdePluginImage?: string;
+
     // supervisorImage is the ref of the supervisor image this instance uses.
     supervisorImage?: string;
 

components/ide/jetbrains/backend-plugin/BUILD.yaml

@@ -1,4 +1,40 @@
 packages:
+  - name: docker
+    type: generic
+    argdeps:
+      - version
+    deps:
+      - :stable
+      - :latest
+  - name: stable
+    type: docker
+    deps:
+      - :plugin-stable
+    argdeps:
+      - imageRepoBase
+    config:
+      dockerfile: leeway.Dockerfile
+      metadata:
+        helm-component: workspace.desktopIdeImages.jbBackendPlugin
+      buildArgs:
+        JETBRAINS_BACKEND_QUALIFIER: stable
+      image:
+        - ${imageRepoBase}/ide/jb-backend-plugin:commit-${__git_commit}
+  - name: latest
+    type: docker
+    deps:
+      - :plugin-latest
+    argdeps:
+      - imageRepoBase
+    config:
+      dockerfile: leeway.Dockerfile
+      metadata:
+        helm-component: workspace.desktopIdeImages.jbBackendPluginLatest
+      buildArgs:
+        JETBRAINS_BACKEND_QUALIFIER: latest
+      image:
+        - ${imageRepoBase}/ide/jb-backend-plugin:${version}
+        - ${imageRepoBase}/ide/jb-backend-plugin:commit-${__git_commit}-latest
   - name: plugin-stable
     type: generic
     deps:

components/ide/jetbrains/backend-plugin/leeway.Dockerfile

@@ -0,0 +1,9 @@
+# Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+# Licensed under the GNU Affero General Public License (AGPL).
+# See License-AGPL.txt in the project root for license information.
+
+# for debugging
+# FROM alpine:3.16
+FROM scratch
+ARG JETBRAINS_BACKEND_QUALIFIER
+COPY --chown=33333:33333 components-ide-jetbrains-backend-plugin--plugin-${JETBRAINS_BACKEND_QUALIFIER}/build/gitpod-remote /ide-desktop/backend/plugins/gitpod-remote

components/ide/jetbrains/image/BUILD.yaml

@@ -18,7 +18,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_intellij.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-stable
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:intellij
       - components/ide/jetbrains/cli:app
@@ -40,7 +39,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_intellij.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-latest
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:intellij-latest
       - components/ide/jetbrains/cli:app
@@ -63,7 +61,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_goland.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-stable
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:goland
       - components/ide/jetbrains/cli:app
@@ -85,7 +82,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_goland.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-latest
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:goland-latest
       - components/ide/jetbrains/cli:app
@@ -108,7 +104,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_pycharm.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-stable
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:pycharm
       - components/ide/jetbrains/cli:app
@@ -130,7 +125,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_pycharm.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-latest
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:pycharm-latest
       - components/ide/jetbrains/cli:app
@@ -153,7 +147,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_phpstorm.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-stable
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:phpstorm
       - components/ide/jetbrains/cli:app
@@ -175,7 +168,6 @@ packages:
       - "startup.sh"
       - "supervisor-ide-config_phpstorm.json"
     deps:
-      - components/ide/jetbrains/backend-plugin:plugin-latest
       - components/ide/jetbrains/image/status:app
       - components/ide/jetbrains/image/download:phpstorm-latest
       - components/ide/jetbrains/cli:app

components/ide/jetbrains/image/leeway.Dockerfile

@@ -11,7 +11,6 @@ ARG SUPERVISOR_IDE_CONFIG
 COPY --chown=33333:33333 ${SUPERVISOR_IDE_CONFIG} /ide-desktop/supervisor-ide-config.json
 COPY --chown=33333:33333 startup.sh /ide-desktop/
 COPY --chown=33333:33333 components-ide-jetbrains-image-download--${JETBRAINS_DOWNLOAD_QUALIFIER}/backend /ide-desktop/backend
-COPY --chown=33333:33333 components-ide-jetbrains-backend-plugin--plugin-${JETBRAINS_BACKEND_QUALIFIER}/build/gitpod-remote /ide-desktop/backend/plugins/gitpod-remote
 COPY --chown=33333:33333 components-ide-jetbrains-image-status--app/status /ide-desktop
 
 ARG JETBRAINS_BACKEND_QUALIFIER

components/registry-facade-api/imagespec.proto

@@ -16,6 +16,8 @@ message ImageSpec {
     string desktop_ide_ref = 4;
     // supervisor_ref points to an image denotign the supervisor to use
     string supervisor_ref = 5;
+    // desktop_ide_plugin_ref points to an image denotign the desktop IDE plugin to use
+    string desktop_ide_plugin_ref = 6;
 }
 
 // ContentLayer is a layer that provides a workspace's content
@@ -51,4 +53,4 @@ message RemoteContentLayer {
 message DirectContentLayer {
     // the bytes of the uncompressed tar file which is served as layer
     bytes content = 1;
-}
+}

components/registry-facade/pkg/registry/registry.go

@@ -162,6 +162,16 @@ func NewRegistry(cfg config.Config, newResolver ResolverProvider, reg prometheus
 	}
 	layerSources = append(layerSources, desktopIdeLayerSource)
 
+	// desktop IDE plugin layer
+	desktopIdePluginRefSource := func(s *api.ImageSpec) (ref string, err error) {
+		return s.GetDesktopIdePluginRef(), nil
+	}
+	desktopIdePluginLayerSource, err := NewSpecMappedImageSource(newResolver, desktopIdePluginRefSource)
+	if err != nil {
+		return nil, err
+	}
+	layerSources = append(layerSources, desktopIdePluginLayerSource)
+
 	// supervisor layer
 	supervisorRefSource := func(s *api.ImageSpec) (ref string, err error) {
 		return s.SupervisorRef, nil

components/server/src/workspace/workspace-starter.ts

@@ -172,13 +172,16 @@ export const chooseIDE = (
 ) => {
     const defaultIDEOption = ideOptions.options[ideOptions.defaultIde];
     const defaultIdeImage = useLatest ? defaultIDEOption.latestImage ?? defaultIDEOption.image : defaultIDEOption.image;
-    const data: { desktopIdeImage?: string; ideImage: string } = {
+    const data: { desktopIdeImage?: string; desktopIdePluginImage?: string; ideImage: string } = {
         ideImage: defaultIdeImage,
     };
     const chooseOption = ideOptions.options[ideChoice] ?? defaultIDEOption;
     const isDesktopIde = chooseOption.type === "desktop";
     if (isDesktopIde) {
         data.desktopIdeImage = useLatest ? chooseOption?.latestImage ?? chooseOption?.image : chooseOption?.image;
+        data.desktopIdePluginImage = useLatest
+            ? chooseOption?.pluginLatestImage ?? chooseOption?.pluginImage
+            : chooseOption?.pluginImage;
         if (hasIdeSettingPerm) {
             data.desktopIdeImage = data.desktopIdeImage || ideChoice;
         }
@@ -783,13 +786,17 @@ export class WorkspaceStarter {
                 );
                 configuration.ideImage = choose.ideImage;
                 configuration.desktopIdeImage = choose.desktopIdeImage;
+                configuration.desktopIdePluginImage = choose.desktopIdePluginImage;
             }
 
             const referrerIde = this.resolveReferrerIDE(workspace, user, ideConfig);
             if (referrerIde) {
                 configuration.desktopIdeImage = useLatest
                     ? referrerIde.option.latestImage ?? referrerIde.option.image
                     : referrerIde.option.image;
+                configuration.desktopIdePluginImage = useLatest
+                    ? referrerIde.option.pluginLatestImage ?? referrerIde.option.pluginImage
+                    : referrerIde.option.pluginImage;
                 if (!user.additionalData?.ideSettings) {
                     // A user does not have IDE settings configured yet configure it with a referrer ide as default.
                     const additionalData = user?.additionalData || {};
@@ -1496,6 +1503,7 @@ export class WorkspaceStarter {
         const startWorkspaceSpecIDEImage = new IDEImage();
         startWorkspaceSpecIDEImage.setWebRef(ideImage);
         startWorkspaceSpecIDEImage.setDesktopRef(instance.configuration?.desktopIdeImage || "");
+        startWorkspaceSpecIDEImage.setDesktopPluginRef(instance.configuration?.desktopIdePluginImage || "");
         startWorkspaceSpecIDEImage.setSupervisorRef(instance.configuration?.supervisorImage || "");
         spec.setIdeImage(startWorkspaceSpecIDEImage);
         spec.setDeprecatedIdeImage(ideImage);

components/ws-manager-api/core.proto

@@ -318,6 +318,8 @@ message IDEImage {
     string desktop_ref = 2;
     // supervisor_ref is a reference to an OCI image used as supervisor
     string supervisor_ref = 3;
+    // desktop_plugin_ref is an optional reference to an OCI image used for serving desktop IDE plugin
+    string desktop_plugin_ref = 4;
 }
 
 // WorkspaceSpec is the specification of a workspace at runtime