用户指南

验证

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

流程

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

   1. 在 Open VSX registry 网站 中找到扩展，并复制扩展列表页面的 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 文件中添加 < publisher > 和名称 <extension>，如下所示：

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

   Copy to Clipboard Toggle word wrap

验证

1. 使用远程 Git 存储库的 URL 来启动一个新的工作区，其中包括创建的 extensions.json 文件。
2. 在工作区的 IDE 中，按 Ctrl+Shift+X 或进入 Extensions 来查找文件中列出的每个扩展。
3. 扩展具有此扩展的标签 ，可在全局范围内启用。

流程

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

2. 将您的访问令牌编码为 Base64。

   提示

   如果安装了 base64 命令行工具，可以使用命令行：

   $ echo -n '<your_access_token_string>' | base64

   Copy to Clipboard Toggle word wrap
3. 进入 "https://devspaces- &lt;openshift_deployment_name& gt; . <domain_name> "/api/user/id，以获取您的 OpenShift Dev Spaces 用户 ID。

4. 准备新的 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-username: <git_provider_username>

   4

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

   5

   
   data:
     token: <Base64_encoded_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

   Git 供应商用户名。对于 azure-devops，用户的电子邮件地址。

   5

   这一行仅适用于 azure-devops ：您的 Git 供应商用户组织。

5. 访问 "https://devspaces-<openshift_deployment_name>.<domain_name>"/api/kubernetes/namespace 来获取您的 OpenShift Dev Spaces 用户命名空间作为 name。

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

   提示

   在 OpenShift 中：

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

     $ oc project

     Copy to Clipboard Toggle word wrap

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

     $ oc project <your_user_namespace>

     Copy to Clipboard Toggle word wrap

7. 应用 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. 在 & 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 init 脚本应用 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: /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 在 tools 容器中设置以下环境变量：

   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:
     NODE_EXTRA_CA_CERTS: /home/user/certs/tls.cer
     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 在 tools 容器中设置以下环境变量：

   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 在 tools 容器中设置以下环境变量：

   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: "https://devspaces-<openshift_deployment_name>.<domain_name>"/plugin-registry/v3/plugins/che-incubator/che-code/latest/devfile.yaml
     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

   用户命名空间，这是新工作区的目标项目。

   3

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

   4

   对 Microsoft Visual Studio Code 的 URL 引用 - 插件 registry 中的开源 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. 当工作区成功启动时，其 PHASE 状态会在 oc get devworkspaces 命令的输出中变为 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 仪表板中打开工作区。

流程

1. 打开 Topology 视图 以列出所有项目。
2. 在 Select a Application search 字段中，键入 workspace 来列出所有工作区。

3. 点要编辑的工作区。

   部署以图形圆圈按钮显示。这些按钮之一是 Edit Source Code。

   

   View larger image

   
4. 要使用 OpenShift Dev Spaces 编辑应用程序代码，请点击 Edit Source Code 按钮。这会重定向到带有应用程序组件的克隆源代码的工作区。

流程

1. 使用主屏幕右上角的三向列表图标打开 Red Hat Applications 菜单。

   下拉菜单显示可用的应用程序。

   

   View larger image

   
2. 点 OpenShift Dev Spaces 链接打开 Dev Spaces 仪表板。

流程

1. 在 OpenShift Dev Spaces 仪表板中，进入 Workspaces。
2. 单击工作区名称，以显示工作区概览页面。本页显示 OpenShift 项目名称 < project_name>。
3. 点右上角的 Applications 菜单，然后点 OpenShift 控制台链接。
4. 在 OpenShift 控制台中，在 Administrator 视角中运行后续步骤。
5. 点 Workloads & gt; Pods 查看所有活跃工作区列表。
6. 在 Project 下拉菜单中，选择 < project_name&gt; 项目来缩小搜索范围。
7. 点运行工作区的正在运行的 pod 的名称。Details 选项卡包含所有容器的列表，以及其他信息。
8. 转至 Logs 选项卡。

流程

1. 配置扩展：点 File > Preferences > Settings，展开 Extensions 部分，搜索您的扩展，并将 trace.server 或类似的配置设置为 verbose （如果存在）。如需进一步配置，请参阅扩展文档。
2. 点 View → Output，然后在 Output 视图中选择您的语言服务器，查看您的语言服务器日志。

流程

1. 使用仪表板，尝试启动工作区。
2. 当它无法启动时，点显示的 Open in Verbose mode 链接。
3. 检查 Logs 选项卡，以查找工作区失败的原因。

流程

1. 打开 Workspaces 选项卡。
2. 在专用于工作区的行的左侧，访问以三个水平点显示的下拉菜单，然后选择 Open in Verbose mode 选项。或者，此选项也可以在 Actions 下拉菜单的工作区详情中找到。
3. 检查 Logs 选项卡，以查找工作区失败的原因。