管理指南

流程

1. 可选：如果您之前在此 OpenShift 集群中部署了 OpenShift Dev Spaces，请确保删除了以前的 OpenShift Dev Spaces 实例：

   $ dsc server:delete

   Copy to Clipboard

2. 创建 OpenShift Dev Spaces 实例：

   $ dsc server:deploy --platform openshift

   Copy to Clipboard

验证步骤

1. 验证 OpenShift Dev Spaces 实例状态：

   $ dsc server:status

   Copy to Clipboard

2. 进入到 OpenShift Dev Spaces 集群实例：

   $ dsc dashboard:open

   Copy to Clipboard

流程

1. 在 OpenShift Web 控制台的 Administrator 视图中，进入 Operators → OperatorHub 并搜索 Red Hat OpenShift Dev Spaces。

2. 安装 Red Hat OpenShift Dev Spaces Operator。

   提示

   请参阅使用 Web 控制台从 OperatorHub 安装。

   小心

   Red Hat OpenShift Dev Spaces Operator 依赖于 Dev Workspace Operator。如果您手动将 Red Hat OpenShift Dev Spaces Operator 安装到非默认命名空间中，请确保同时安装了 Dev Workspace Operator。这是必需的，因为 Operator Lifecycle Manager 将尝试将 Dev Workspace Operator 作为 Red Hat OpenShift Dev Spaces Operator 命名空间中的依赖项安装，如果后者在不同的命名空间中安装，可能会导致 Dev Workspace Operator 的两个冲突安装。

1. 在 OpenShift 中创建 openshift-devspaces 项目，如下所示：

   oc create namespace openshift-devspaces

   Copy to Clipboard
2. 进入 Operators → Installed Operators → Red Hat OpenShift Dev Spaces 实例 Specification → Create CheCluster → YAML view。
3. 在 YAML 视图中，将 namespace: openshift-operators 替换为 namespace: openshift-devspaces。

4. 选择 Create。

   提示

   请参阅 从已安装的 Operator 创建应用程序。

1. 在 Red Hat OpenShift Dev Spaces 实例规格中，进入 devspaces，在 Details 标签页中登录。

1. 在 Message 下，检查是否有 None，这表示没有任何错误。
2. 在 Red Hat OpenShift Dev Spaces URL 下，等待 OpenShift Dev Spaces 实例的 URL 出现，然后打开 URL 以检查 OpenShift Dev Spaces 仪表板。
3. 在 Resources 选项卡中，查看 OpenShift Dev Spaces 部署的资源及其状态。

流程

1. 下载并执行镜像脚本，以安装自定义 Operator 目录并镜像相关镜像： prepare-restricted-environment.sh。

   $ bash prepare-restricted-environment.sh \
     --devworkspace_operator_index registry.redhat.io/redhat/redhat-operator-index:v4.18\
     --devworkspace_operator_version "v0.33.0" \
     --prod_operator_index "registry.redhat.io/redhat/redhat-operator-index:v4.18" \
     --prod_operator_package_name "devspaces" \
     --prod_operator_bundle_name "devspacesoperator" \
     --prod_operator_version "v3.20.0" \
     --my_registry "<my_registry>" 

   1

   Copy to Clipboard

   1

   镜像要镜像的专用 Docker registry

2. 使用上一步中 che-operator-cr-patch.yaml 中设置的配置安装 OpenShift Dev Spaces：

   $ dsc server:deploy \
     --platform=openshift \
     --olm-channel stable \
     --catalog-source-name=devspaces-disconnected-install \
     --catalog-source-namespace=openshift-marketplace \
     --skip-devworkspace-operator \
     --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml

   Copy to Clipboard
3. 允许来自 OpenShift Dev Spaces 命名空间中的传入流量到用户项目中的所有 Pod。请参阅：第 4.8.1 节 “配置网络策略”。

验证

1. 验证配置的属性的值：

   $ oc get configmap che -o jsonpath='{.data.<configured_property>}' \
   -n openshift-devspaces

   Copy to Clipboard

流程

1. 编辑集群中的 CheCluster 自定义资源：

   $ oc edit checluster/devspaces -n openshift-devspaces

   Copy to Clipboard
2. 保存并关闭该文件以应用更改。

验证

1. 验证配置的属性的值：

   $ oc get configmap che -o jsonpath='{.data.<configured_property>}' \
   -n openshift-devspaces

   Copy to Clipboard

流程

1. 在 CheCluster 级别禁用自动命名空间置备：

   devEnvironments:
     defaultNamespace:
       autoProvision: false

   Copy to Clipboard

2. 使用以下标签和注解为 <username> 用户创建 <project_name> 项目：

   kind: Namespace
   apiVersion: v1
   metadata:
     name: <project_name> 

   1

   
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-namespace
     annotations:
       che.eclipse.org/username: <username>

   Copy to Clipboard

   1

   使用您选择的项目名称。

流程

1. 创建以下 ConfigMap 以复制到每个用户项目中。为增强配置性，您可以通过添加额外的标签和注解来自定义 ConfigMap。默认情况下，ConfigMap 会自动挂载到用户工作区。如果您不希望 ConfigMap 挂载，请明确添加以下标签来覆盖行为：

   controller.devfile.io/watch-configmap: "false"
   controller.devfile.io/mount-to-devworkspace: "false"

   Copy to Clipboard

   有关其他可能的标签和注解，请参阅 自动挂载卷、configmap 和 secret。

   例 4.4. 将 ConfigMap 复制到每个用户项目中：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: devspaces-user-configmap
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/watch-configmap: "false"
       controller.devfile.io/mount-to-devworkspace: "false"
   data:
     ...

   Copy to Clipboard

   例 4.5. 将 ConfigMap 复制到每个用户项目中，并通过路径 /home/user/.m2 自动将 settings.xml 文件挂载到每个用户容器中：

   kind: ConfigMap
   apiVersion: v1
   metadata:
     name: devspaces-user-configmap
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /home/user/.m2
   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>/home/user/.m2/repository</localRepository>
         <interactiveMode>true</interactiveMode>
         <offline>false</offline>
       </settings>

   Copy to Clipboard

2. 创建以下 Secret 以复制到每个用户项目中。为增强配置性，您可以通过添加额外的标签和注解来自定义 Secret。默认情况下，Secret 会自动挂载到用户工作区。如果您不希望挂载 Secret，请明确添加以下标签来覆盖行为：

   controller.devfile.io/watch-secret: "false"
   controller.devfile.io/mount-to-devworkspace: "false"

   Copy to Clipboard

   有关其他可能的标签和注解，请参阅 自动挂载卷、configmap 和 secret。

   例 4.6. 将 Secret 复制到每个用户项目中：

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/watch-secret: "false"
       controller.devfile.io/mount-to-devworkspace: "false"
     annotations:
       controller.devfile.io/mount-as: env
   stringData:
     ...

   Copy to Clipboard

   例 4.7. 将 Secret 复制到每个用户项目中，并通过路径 /etc/pki/ca-trust/source/anchors 自动将 trusted-certificates.crt 文件挂载到每个用户容器中：

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: subpath
       controller.devfile.io/mount-path: /etc/pki/ca-trust/source/anchors
   stringData:
     trusted-certificates.crt: |
       ...

   Copy to Clipboard

   注意

   在工作区启动时运行 update-ca-trust 命令来导入证书。它可以手动实现，或者通过将此命令添加到 devfile 中的 postStart 事件中。请参阅 在 devfile 中添加事件绑定。

   例 4.8. 将 Secret 复制到每个用户项目中，并作为环境变量自动挂载到每个用户容器中：

   kind: Secret
   apiVersion: v1
   metadata:
     name: devspaces-user-secret
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
     annotations:
       controller.devfile.io/mount-as: env
   stringData:
     ENV_VAR_1: value_1
     ENV_VAR_2: value_2

   Copy to Clipboard

3. 在下面创建 PersistentVolumeClaim，将它复制到每个用户项目中。

   为增强配置，您可以通过添加额外的标签和注解来自定义 PersistentVolumeClaim。有关其他可能的标签和注解，请参阅 自动挂载卷、configmap 和 secret。

   要修改 PersistentVolumeClaim，请将其删除并在 openshift-devspaces 命名空间中创建新名称。

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: devspaces-user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
   spec:
     ...

   Copy to Clipboard

   例 4.9. 将 PersistentVolumeClaim 挂载到用户工作区：

   apiVersion: v1
   kind: PersistentVolumeClaim
   metadata:
     name: devspaces-user-pvc
     namespace: openshift-devspaces
     labels:
       app.kubernetes.io/part-of: che.eclipse.org
       app.kubernetes.io/component: workspaces-config
       controller.devfile.io/mount-to-devworkspace: 'true'
     annotations:
       controller.devfile.io/mount-path: /home/user/data
       controller.devfile.io/read-only: 'true'
   spec:
     accessModes:
       - ReadWriteOnce
     resources:
       requests:
         storage: 5Gi
     volumeMode: Filesystem

   Copy to Clipboard

4. 要使用 OpenShift Kubernetes Engine，您可以创建一个 Template 对象来复制模板中定义的所有资源。

   除了前面提到的 ConfigMap、Secret 和 PersistentVolumeClaim 外，Template 对象还可以包括：

   • LimitRange
   • NetworkPolicy
   • ResourceQuota
   • 角色

   • RoleBinding

     apiVersion: template.openshift.io/v1
     kind: Template
     metadata:
       name: devspaces-user-namespace-configurator
       namespace: openshift-devspaces
       labels:
         app.kubernetes.io/part-of: che.eclipse.org
         app.kubernetes.io/component: workspaces-config
     objects:
       ...
     parameters:
     - name: PROJECT_NAME
     - name: PROJECT_ADMIN_USER

     Copy to Clipboard

     参数是可选的，定义可以使用哪些参数。目前，只支持 PROJECT_NAME 和 PROJECT_ADMIN_USER。PROJECT_NAME 是 OpenShift Dev Spaces 命名空间的名称，而 PROJECT_ADMIN_USER 是命名空间的 OpenShift Dev Spaces 用户。

     对象中的 namespace 名称将在同步期间替换为用户的命名空间名称。

     例 4.10. 将 Kubernetes 资源复制到用户项目：

     apiVersion: template.openshift.io/v1
     kind: Template
     metadata:
       name: devspaces-user-namespace-configurator
       namespace: openshift-devspaces
       labels:
         app.kubernetes.io/part-of: che.eclipse.org
         app.kubernetes.io/component: workspaces-config
     objects:
     - apiVersion: v1
       kind: ResourceQuota
       metadata:
         name: devspaces-user-resource-quota
       spec:
         ...
     - apiVersion: v1
       kind: LimitRange
       metadata:
         name: devspaces-user-resource-constraint
       spec:
         ...
     - apiVersion: rbac.authorization.k8s.io/v1
       kind: Role
       metadata:
         name: devspaces-user-roles
       rules:
         ...
     - apiVersion: rbac.authorization.k8s.io/v1
       kind: RoleBinding
       metadata:
         name: devspaces-user-rolebinding
       roleRef:
         apiGroup: rbac.authorization.k8s.io
         kind: Role
         name: devspaces-user-roles
       subjects:
       - kind: User
         apiGroup: rbac.authorization.k8s.io
         name: ${PROJECT_ADMIN_USER}
     parameters:
     - name: PROJECT_ADMIN_USER

     Copy to Clipboard

     注意

     只有在 OpenShift 中才支持创建模板 Kubernetes 资源。

流程

1. 为部署创建 HPA 资源，指定目标指标和所需的副本数。

   apiVersion: autoscaling/v2
   kind: HorizontalPodAutoscaler
   metadata:
     name: scaler
     namespace: openshift-devspaces
   spec:
     scaleTargetRef:
       apiVersion: apps/v1
       kind: Deployment
       name: <deployment_name> 

   1

   
     ...

   Copy to Clipboard

   1

   & lt;deployment_name > 对应于以下部署：

   • devspaces
   • che-gateway
   • devspaces-dashboard
   • plugin-registry
   • devfile-registry

流程

1. 获取 OpenShift Dev Spaces 命名空间的名称。默认为 openshift-devspaces。

   $ oc get checluster --all-namespaces \
     -o=jsonpath="{.items[*].metadata.namespace}"

   Copy to Clipboard

2. 配置 maxNumberOfWorkspacesPerUser:

   $ oc patch checluster/devspaces -n openshift-devspaces \

   1

   
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfWorkspacesPerUser": <kept_workspaces_limit>}}}'

   2

   Copy to Clipboard

   1

   您在第 1 步中获取的 OpenShift Dev Spaces 命名空间。

   2

   您选择 < kept_workspaces_limit> 值。

流程

1. 配置 maxNumberOfRunningWorkspacesPerCluster:

   oc patch checluster/devspaces -n openshift-devspaces \
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerCluster": <running_workspaces_limit>}}}'

   1

   Copy to Clipboard

   1

   您选择的 < running_workspaces_limit> 值。

流程

1. 获取 OpenShift Dev Spaces 命名空间的名称。默认为 openshift-devspaces。

   $ oc get checluster --all-namespaces \
     -o=jsonpath="{.items[*].metadata.namespace}"

   Copy to Clipboard

2. 配置 maxNumberOfRunningWorkspacesPerUser:

   $ oc patch checluster/devspaces -n openshift-devspaces \

   1

   
   --type='merge' -p \
   '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerUser": <running_workspaces_limit>}}}'

   2

   Copy to Clipboard

   1

   您在第 1 步中获取的 OpenShift Dev Spaces 命名空间。

   2

   您选择的 < running_workspaces_limit> 值。

流程

1. 创建一个新的 ConfigMap，其中包含 Git 服务器的详情：

   $ oc create configmap che-git-self-signed-cert \
     --from-file=ca.crt=<path_to_certificate> \  

   1

   
     --from-literal=githost=<git_server_url> -n openshift-devspaces  

   2

   Copy to Clipboard

   1

   自签名证书的路径。

   2

   指定 Git 服务器 URL 的可选参数，如 https://git.example.com:8443。如果省略时，自签名证书用于通过 HTTPS 用于所有存储库。

   注意
   • 证书文件通常存储为 Base64 ASCII 文件，例如：.pem,.crt,.ca-bundle.保存证书文件的所有 ConfigMap 都应使用 Base64 ASCII 证书而不是二进制数据证书。
   • 需要信任证书链。如果 ca.crt 由证书颁发机构(CA)签名，则必须将 CA 证书包含在 ca.crt 文件中。

2. 在 ConfigMap 中添加所需的标签：

   $ oc label configmap che-git-self-signed-cert \
     app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspaces

   Copy to Clipboard

3. 配置 OpenShift Dev Spaces 操作对象，将自签名证书用于 Git 存储库。请参阅 第 4.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。

   spec:
     devEnvironments:
       trustedCerts:
         gitTrustedCertsConfigMapName: che-git-self-signed-cert

   Copy to Clipboard

流程

1. 使用 NodeSelector

   OpenShift Dev Spaces 使用 CheCluster 自定义资源来配置 nodeSelector ：

   spec:
     devEnvironments:
       nodeSelector:
         key: value

   Copy to Clipboard

   本节必须包含 每个节点标签 的一组 key=value 对，以组成 nodeSelector 规则。

2. 使用 Taints 和 Tolerations

   这的工作方式与 nodeSelector 相反。您可以指定 Pod 无法调度到哪些节点上，而不指定将 Pod 调度到哪些节点上。如需更多信息，请参阅 ：https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration。

   OpenShift Dev Spaces 使用 CheCluster 自定义资源来配置 容限 ：

   spec:
     devEnvironments:
       tolerations:
         - effect: NoSchedule
           key: key
           value: value
           operator: Equal

   Copy to Clipboard

1. 配置允许的源：

   oc patch checluster/devspaces \
       --namespace openshift-devspaces \
       --type='merge' \
       -p \
   '{
      "spec": {
        "devEnvironments": {
          "allowedSources": {
            "urls": ["url_1", "url_2"] 

   1

   
          }
        }
      }
    }'

   Copy to Clipboard

   1

   用于启动云环境(CDE)的批准 URL 数组。CDE 只能从这些 URL 启动。URL 中支持通配符 *。例如： https://example.com/* 允许从 example.com 中的任何路径启动 CDE。

流程

1. 查找部署 OpenShift Dev Spaces Operator 的命名空间：

   OPERATOR_NAMESPACE=$(oc get pods -l app.kubernetes.io/component=devspaces-operator -o jsonpath={".items[0].metadata.namespace"} --all-namespaces)

   Copy to Clipboard

2. 查找 Image Puller 预先拉取的镜像：

   oc exec -n $OPERATOR_NAMESPACE deploy/devspaces-operator -- cat /tmp/external_images.txt

   Copy to Clipboard