用户指南

流程

1. 使用 pod-overrides 属性将 https://access.redhat.com/documentation/zh-cn/red_hat_openshift_dev_spaces/3.22/html-single/administration_guide/index#administration-guide:configuring-fuse 中定义的所需注解添加到工作区。pod-overrides 属性允许合并工作区 pod 的 spec 中的某些字段。

   对于早于 4.15 的 OpenShift 版本：

   $ oc patch devworkspace <DevWorkspace_name> \
     --patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse","io.openshift.podman-fuse":""}}}}}}}' \
     --type=merge

   Copy to Clipboard Toggle word wrap

   对于 OpenShift 版本 4.15 及更新的版本：

   $ oc patch devworkspace <DevWorkspace_name> \
     --patch '{"spec":{"template":{"attributes":{"pod-overrides":{"metadata":{"annotations":{"io.kubernetes.cri-o.Devices":"/dev/fuse"}}}}}}}' \
     --type=merge

   Copy to Clipboard Toggle word wrap

验证步骤

1. 启动工作区，并验证 /dev/fuse 是否在工作区容器中可用。

   $ stat /dev/fuse

   Copy to Clipboard Toggle word wrap

流程

1. 应用在项目中挂载 /home/user/.config/containers/storage.conf 文件的 ConfigMap。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: fuse-overlay
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.config/containers
   data:
     storage.conf: |
       [storage]
       driver = "overlay"
   
       [storage.options.overlay]
       mount_program="/usr/bin/fuse-overlayfs"

   Copy to Clipboard Toggle word wrap
   警告

   创建此 ConfigMap 将导致所有正在运行的工作区重启。

验证步骤

1. 启动包含所需注解的工作区，并验证存储驱动程序是否已 覆盖。

   $ podman info | grep overlay

   Copy to Clipboard Toggle word wrap

   输出示例：

   graphDriverName: overlay
     overlay.mount_program:
       Executable: /usr/bin/fuse-overlayfs
       Package: fuse-overlayfs-1.12-1.module+el8.9.0+20326+387084d0.x86_64
         fuse-overlayfs: version 1.12
     Backing Filesystem: overlayfs

   Copy to Clipboard Toggle word wrap
   注意

   现有工作区可能会出现以下错误：

   ERRO[0000] User-selected graph driver "overlay" overwritten by graph driver "vfs" from database - delete libpod local files ("/home/user/.local/share/containers/storage") to resolve.  May prevent use of images created by other tools

   Copy to Clipboard Toggle word wrap

   在这种情况下，删除错误信息中所述的 libpod 本地文件。

流程

1. 在 GitHub 仓库中，创建一个 .github/workflows 目录（如果还没有存在）。

2. 在 .github/workflows 目录中创建 example.yml 文件，其内容如下：

   例 2.1. example.yml

   name: Try in Web IDE example
   
   on:
     pull_request_target:
       types: [opened]
   
   jobs:
     add-link:
       runs-on: ubuntu-20.04
       steps:
         - name: Web IDE Pull Request Check
           id: try-in-web-ide
           uses: redhat-actions/try-in-web-ide@v1
           with:
             # GitHub action inputs
   
             # required
             github_token: ${{ secrets.GITHUB_TOKEN }}
   
             # optional - defaults to true
             add_comment: true
   
             # optional - defaults to true
             add_status: true

   Copy to Clipboard Toggle word wrap

   此代码片段在 Web IDE 示例 中创建一个名为 Try 的工作流，其中有一个运行 redhat-actions/try-in-web-ide 社区操作的 v1 版本的作业。工作流在打开的活动类型上的 pull_request_target 事件 上触发。

3. （可选）配置 on.pull_request_target.types 字段中的活动类型，以便在工作流触发器时进行自定义。重新打开 和同步 等 活动类型非常有用。

   例 2.2. 在 打开 和同步 活动类型上触发工作流

   on:
     pull_request_target:
       types: [opened, synchronize]

   Copy to Clipboard Toggle word wrap
4. （可选）在 example.yml 中配置 add_comment 和 add_status GitHub 操作输入。这些输入会发送到 Web IDE GitHub 操作中的 Try，以自定义是否进行注释和状态检查。

流程

1. 获取每个所选扩展的发布程序和扩展名称：

   1. 在 Open VSX 注册表网站中查找 扩展，再复制扩展列表页面的 URL。

   2. 从复制的 URL 中提取 <publisher > 和名称 <extension> ：

      https://www.open-vsx.org/extension/<publisher>/<extension>

      Copy to Clipboard Toggle word wrap
2. 在远程 Git 仓库中创建 .vscode/extensions.json 文件。

3. 在 extensions.json 文件中添加 & <extension> lt; publisher > 和 name，如下所示：

     {
       "recommendations": [
         "<publisher_A>.<extension_B>",
         "<publisher_C>.<extension_D>",
         "<publisher_E>.<extension_F>"
       ]
     }

   Copy to Clipboard Toggle word wrap

验证

1. 使用包含创建的 extensions.json 文件的远程 Git 存储库的 URL 来启动新的工作区。
2. 在工作区的 IDE 中，按 Ctrl+Shift+X 或转至 Extensions 以查找文件中列出的每个扩展。
3. 扩展具有标签 This extension is globally 启用。

验证

1. 使用 Git 存储库 克隆来启动新的工作区。
2. 验证指定的 IDE 是否在启动工作区的浏览器选项卡中加载。

流程

1. 在 Git 提供程序的网站上生成您的访问令牌。

   重要

   个人访问令牌是敏感信息，应保留机密。将它们视为密码。如果您在身份验证时遇到问题，请确保使用正确的令牌并具有适当的克隆存储库权限：

   1. 在您的计算机上本地打开终端
   2. 使用 git 命令，使用您的个人访问令牌克隆存储库。git 命令的格式因 Git 提供程序而异。例如，可以使用以下命令进行 GitHub 个人访问令牌验证：

   git clone https://<PAT>@github.com/username/repo.git

   Copy to Clipboard Toggle word wrap

   将 <PAT > 替换为您的个人访问令牌，并将 username/repo 替换为适当的存储库路径。如果令牌有效并且具有必要的权限，克隆过程应该可以成功。否则，这代表了不正确的个人访问令牌、权限不足或其他问题。

   重要

   对于 GitHub Enterprise Cloud，请验证 令牌是否在机构 中使用。

2. 进入 web 浏览器中的 https:// <openshift_dev_spaces_fqdn> /api/user/id 来获取您的 OpenShift Dev Spaces 用户 ID。

3. 准备新的 OpenShift Secret。

   kind: Secret
   apiVersion: v1
   metadata:
     name: personal-access-token-<your_choice_of_name_for_this_token>
     labels:
       app.kubernetes.io/component: scm-personal-access-token
       app.kubernetes.io/part-of: che.eclipse.org
     annotations:
       che.eclipse.org/che-userid: <devspaces_user_id>

   1

   
       che.eclipse.org/scm-personal-access-token-name: <git_provider_name>

   2

   
       che.eclipse.org/scm-url: <git_provider_endpoint>

   3

   
       che.eclipse.org/scm-organization: <git_provider_organization>

   4

   
   stringData:
     token: <Content_of_access_token>
   type: Opaque

   Copy to Clipboard Toggle word wrap

   1

   您的 OpenShift Dev Spaces 用户 ID。

   2

   Git 提供程序名称： github 或 gitlab 或 bitbucket-server 或 azure-devops。

   3

   Git 提供程序 URL。

   4

   这一行仅适用于 azure-devops ：您的 Git 供应商用户机构，或者在使用 Azure DevOps Server 时收集。

4. 访问 https://<openshift_dev_spaces_fqdn&gt; /api/kubernetes/namespace 来获取您的 OpenShift Dev Spaces 用户命名空间，名为。

5. 切换到集群中的 OpenShift Dev Spaces 用户命名空间。

   提示

   在 OpenShift 中：

   • oc 命令行工具可返回您当前位于集群中的命名空间，您可以使用该命名空间检查当前的命名空间：

     $ oc project

   • 如果需要，您可以在命令行中切换到 OpenShift Dev Spaces 用户命名空间：

     $ oc project & lt;your_user_namespace>

6. 应用 Secret。

   提示

   在 OpenShift 中，您可以使用 oc 命令行工具：

   $ oc apply -f - <<EOF
   <Secret_prepared_in_step_5>
   EOF

   Copy to Clipboard Toggle word wrap

验证

1. 使用 Git 提供程序主机的远程 Git 存储库的 URL，启动新的工作区。
2. 进行一些更改，并从工作区推送到远程 Git 存储库。

流程

1. 准备新的 OpenShift ConfigMap。

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: workspace-userdata-gitconfig-configmap
     namespace: <user_namespace> 

   1

   
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /etc/
   data:
     gitconfig: <gitconfig content> 

   2

   Copy to Clipboard Toggle word wrap

   1

   用户命名空间。访问 https://<openshift_dev_spaces_fqdn&gt; /api/kubernetes/namespace 来获取您的 OpenShift Dev Spaces 用户命名空间，名为。

   2

   gitconfig 文件内容的内容。

2. 应用 ConfigMap。

   $ oc apply -f - <<EOF
   <ConfigMap_prepared_in_step_1>
   EOF

   Copy to Clipboard Toggle word wrap

验证

1. 使用 Git 提供程序主机的远程 Git 存储库的 URL，启动新的工作区。
2. 启动工作区后，在 tools 容器中运行一个新的终端，并运行 git config --get-regexp user ""。您的 Git 用户名和电子邮件应当会显示在输出中。

流程

1. 在 & lt;username>-devspaces 命名空间中，为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 在 & lt;username>-devspaces 命名空间中，应用 ConfigMap 来创建 settings.xml 文件：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: settings-xml
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.m2
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     settings.xml: |
       <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd">
         <localRepository/>
         <interactiveMode/>
         <offline/>
         <pluginGroups/>
         <servers/>
         <mirrors>
           <mirror>
             <id>redhat-ga-mirror</id>
             <name>Red Hat GA</name>
             <url>https://<maven_artifact_repository_route>/repository/redhat-ga/</url>
             <mirrorOf>redhat-ga</mirrorOf>
           </mirror>
           <mirror>
             <id>maven-central-mirror</id>
             <name>Maven Central</name>
             <url>https://<maven_artifact_repository_route>/repository/maven-central/</url>
             <mirrorOf>maven-central</mirrorOf>
           </mirror>
           <mirror>
             <id>jboss-public-repository-mirror</id>
             <name>JBoss Public Maven Repository</name>
             <url>https://<maven_artifact_repository_route>/repository/jboss-public/</url>
             <mirrorOf>jboss-public-repository</mirrorOf>
           </mirror>
         </mirrors>
         <proxies/>
         <profiles/>
         <activeProfiles/>
       </settings>

   Copy to Clipboard Toggle word wrap
3. 可选：在使用基于 JBoss EAP 的 devfile 时，在 < username>-devspaces 命名空间中应用第二个 settings-xml ConfigMap，并使用相同的内容、不同的名称和 /home/jboss/.m2 挂载路径。

4. 在 & lt;username>-devspaces 命名空间中，为 TrustStore 初始化脚本应用 ConfigMap：

   Java 8

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-java8-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -trustcacerts -keystore ~/.java/current/jre/lib/security/cacerts -storepass changeit

   Copy to Clipboard Toggle word wrap

   Java 11

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-java11-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -cacerts -storepass changeit

   Copy to Clipboard Toggle word wrap

5. 启动 Maven 工作区。
6. 在 tools 容器中打开一个新的终端。
7. 运行 ~/init-truststore.sh。

流程

1. 为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 为 TrustStore 初始化脚本应用 ConfigMap：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-truststore
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init-truststore.sh: |
       #!/usr/bin/env bash
   
       keytool -importcert -noprompt -file /home/user/certs/tls.cer -cacerts -storepass changeit

   Copy to Clipboard Toggle word wrap

3. 为 Gradle 初始化脚本应用 ConfigMap：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-gradle
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.gradle
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     init.gradle: |
       allprojects {
         repositories {
           mavenLocal ()
           maven {
             url "https://<gradle_artifact_repository_route>/repository/maven-public/"
             credentials {
               username "admin"
               password "passwd"
             }
           }
         }
       }

   Copy to Clipboard Toggle word wrap
4. 启动一个 Gradle 工作区。
5. 在 tools 容器中打开一个新的终端。
6. 运行 ~/init-truststore.sh。

流程

1. 为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /public-certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     nexus.cer: >-
       <Base64_encoded_content_of_public_cert>__ 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 应用 ConfigMap 在 工具容器中设置以下环境变量 ：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     NPM_CONFIG_REGISTRY: >-
       https://<npm_artifact_repository_route>/repository/npm-all/

   Copy to Clipboard Toggle word wrap

流程

1. 为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 应用 ConfigMap 在 工具容器中设置以下环境变量 ：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     PIP_INDEX_URL: >-
       https://<python_artifact_repository_route>/repository/pypi-all/
     PIP_CERT: /home/user/certs/tls.cer

   Copy to Clipboard Toggle word wrap

流程

1. 为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 应用 ConfigMap 在 工具容器中设置以下环境变量 ：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     GOPROXY: >-
       http://<athens_proxy_route>
     SSL_CERT_FILE: /home/user/certs/tls.cer

   Copy to Clipboard Toggle word wrap

流程

1. 为 TLS 证书应用 Secret：

   kind: Secret
   apiVersion: v1
   metadata:
     name: tls-cer
     annotations:
       controller.devfile.io/mount-path: /home/user/certs
       controller.devfile.io/mount-as: file
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-secret: 'true'
   data:
     tls.cer: >-
       <Base64_encoded_content_of_public_cert> 

   1

   Copy to Clipboard Toggle word wrap

   1

   带有禁用行嵌套的 Base64 编码。

2. 应用 ConfigMap 为 工具 容器中的 TLS 证书文件的路径设置环境变量：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: disconnected-env
     annotations:
       controller.devfile.io/mount-as: env
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     SSL_CERT_FILE: /home/user/certs/tls.cer

   Copy to Clipboard Toggle word wrap

3. 应用 ConfigMap 以创建 nuget.config 文件：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: init-nuget
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /projects
     labels:
       controller.devfile.io/mount-to-devworkspace: 'true'
       controller.devfile.io/watch-configmap: 'true'
   data:
     nuget.config: |
       <?xml version="1.0" encoding="UTF-8"?>
       <configuration>
         <packageSources>
           <add key="nexus2" value="https://<nuget_artifact_repository_route>/repository/nuget-group/"/>
         </packageSources>
         <packageSourceCredentials>
           <nexus2>
               <add key="Username" value="admin" />
               <add key="Password" value="passwd" />
           </nexus2>
         </packageSourceCredentials>
       </configuration>

   Copy to Clipboard Toggle word wrap

流程

1. 要准备 DevWorkspace 自定义资源，请复制目标 Git 存储库的 devfile 的内容。

   例 8.2. 使用 schemaVersion: 2.2.0复制 devfile 内容

   components:
     - name: tooling-container
       container:
         image: quay.io/devfile/universal-developer-image:ubi8-latest

   Copy to Clipboard Toggle word wrap
   提示

   如需了解更多详细信息，请参阅 devfile v2 文档。

2. 创建 DevWorkspace 自定义资源，粘贴 spec.template 字段下上一步中的 devfile 内容。

   例 8.3. DevWorkspace 自定义资源

   kind: DevWorkspace
   apiVersion: workspace.devfile.io/v1alpha2
   metadata:
     name: my-devworkspace

   1

   
     namespace: user1-dev

   2

   
   spec:
     routingClass: che
     started: true

   3

   
     contributions:

   4

   
       - name: ide
         uri: http://devspaces-dashboard.openshift-devspaces.svc.cluster.local:8080/dashboard/api/editors/devfile?che-editor=che-incubator/che-code/latest
     template:
       projects:

   5

   
         - name: my-project-name
           git:
             remotes:
               origin: https://github.com/eclipse-che/che-docs
       components:

   6

   
         - name: tooling-container
           container:
             image: quay.io/devfile/universal-developer-image:ubi8-latest

   Copy to Clipboard Toggle word wrap

   1

   DevWorkspace 自定义资源的名称。这将是新工作区的名称。

   2

   User namespace，这是新工作区的目标项目。

   3

   决定在创建 DevWorkspace 自定义资源时是否必须启动工作区。

   4

   Microsoft Visual Studio Code 的 URL 引用 - 开源 IDE devfile。

   5

   有关要在启动时克隆到工作区的 Git 存储库的详细信息。

   6

   工作区容器和卷组件等组件列表。

3. 将 DevWorkspace 自定义资源应用到集群。

验证

1. 通过检查 DevWorkspace 的 PHASE 状态来验证工作区是否已启动。

   $ oc get devworkspaces -n <user_project> --watch

   Copy to Clipboard Toggle word wrap

   例 8.4. 输出

   NAMESPACE        NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev        my-devworkspace       workspacedf64e4a492cd4701   Starting   Waiting for workspace deployment

   Copy to Clipboard Toggle word wrap

2. 当工作区成功启动时，在 oc get devworkspaces 命令的输出中，其 PHASE 状态将变为 Running。

   例 8.5. 输出

   NAMESPACE            NAME                  DEVWORKSPACE ID             PHASE      INFO
   user1-dev            my-devworkspace       workspacedf64e4a492cd4701   Running    https://url-to-workspace.com

   Copy to Clipboard Toggle word wrap

   然后，您可以使用以下选项之一打开工作区：

   • 访问 oc get devworkspaces 命令的输出的 INFO 部分中提供的 URL。
   • 从 OpenShift Dev Spaces 仪表板打开工作区。