6.3. 配置默认扩展

• 将扩展二进制文件放在源存储库中。
• 使用 devfile postStart 事件从网络获取扩展二进制文件。
• 在 che-code 镜像中包括扩展的 .vsix 二进制文件。

流程

• 在 .devfile.yaml 中指定 DEFAULT_EXTENSIONS，如下例所示：

  schemaVersion: 2.3.0
  metadata:
    generateName: example-project
  components:
    - name: tools
      container:
        image: quay.io/devfile/universal-developer-image:ubi8-latest
        env:
          - name: 'DEFAULT_EXTENSIONS'
            value: '/projects/example-project/extension.vsix'

• 指定 devfile 命令，将扩展下载到您的工作中
• 添加 postStart 事件，以在工作空间启动时运行命令
• 在 devfile 中定义 DEFAULT_EXTENSIONS 环境变量

流程

• 将以下示例中显示的值添加到 devfile 中：

  schemaVersion: 2.3.0
  metadata:
    generateName: example-project
  components:
    - name: tools
      container:
        image: quay.io/devfile/universal-developer-image:ubi8-latest
        env:
          - name: DEFAULT_EXTENSIONS
            value: '/tmp/extension-1.vsix;/tmp/extension-2.vsix'
  
  commands:
    - id: add-default-extensions
      exec:
        # name of the tooling container
        component: tools
        # download several extensions using curl
        commandLine: |
          curl https://.../extension-1.vsix --location -o /tmp/extension-1.vsix
          curl https://.../extension-2.vsix --location -o /tmp/extension-2.vsix
  
  events:
    postStart:
      - add-default-extensions

  警告

  在某些情况下，curl 可能会下载 .gzip 压缩文件。这可能会使安装扩展不可能。要修复尝试将文件保存为 .vsix.gz 文件，然后使用 gunzip 解压缩该文件。这会将 .vsix.gz 文件替换为解压缩的 .vsix 文件。

  curl https://some-extension-url --location -o /tmp/extension.vsix.gz
  gunzip /tmp/extension.vsix.gz

流程

• 创建一个目录，并将您选择的 .vsix 扩展放在这个目录中。

• 使用以下内容创建 Dockerfile：

  # inherit che-incubator/che-code:latest
  FROM quay.io/che-incubator/che-code:latest
  USER 0
  
  # copy all .vsix files to /default-extensions directory
  RUN mkdir --mode=775 /default-extensions
  COPY --chmod=755 *.vsix /default-extensions/
  
  # add instruction to the script to copy default extensions to the working container
  RUN echo "cp -r /default-extensions /checode/" >> /entrypoint-init-container.sh

• 构建镜像并将其推送到 registry：

  $ docker build -t yourname/che-code:next .
  $ docker push yourname/che-code:next

• 将新 ConfigMap 添加到用户的项目中，定义 DEFAULT_EXTENSIONS 环境变量，并指定扩展的绝对路径。此 ConfigMap 将环境变量设置为用户项目中的所有工作区。

  kind: ConfigMap
  apiVersion: v1
  metadata:
    name: vscode-default-extensions
    labels:
      controller.devfile.io/mount-to-devworkspace: 'true'
      controller.devfile.io/watch-configmap: 'true'
    annotations:
      controller.devfile.io/mount-as: env
  data:
    DEFAULT_EXTENSIONS: '/checode/default-extensions/extension1.vsix;/checode/default-extensions/extension2.vsix'

• 使用 yourname/che-code:next 镜像创建工作区。首先，打开仪表板并导航到左侧的 Create Workspace 选项卡。

  1. 在 Editor Selector 部分中，展开 使用 Editor Definition 下拉菜单，并将编辑器 URI 设置为 Editor Image。
  2. 点任何示例或使用 Git 存储库 URL 创建工作区。