第 3 章配置 Dev Spaces

本节论述了 Red Hat OpenShift Dev Spaces 的配置选项。

3.1. 了解 `CheCluster` 自定义资源

OpenShift Dev Spaces 的默认部署由 Red Hat OpenShift Dev Spaces Operator 的 CheCluster 自定义资源参数组成。

CheCluster 自定义资源是一个 Kubernetes 对象。您可以通过编辑 CheCluster 自定义资源 YAML 文件来配置它。此文件包含用于配置每个组件的部分： devWorkspace、cheServer、pluginRegistry、devfileRegistry、仪表板和 imagePuller。

Red Hat OpenShift Dev Spaces Operator 将 CheCluster 自定义资源转换为 OpenShift Dev Spaces 安装的每个组件可用的配置映射。

OpenShift 平台将配置应用到每个组件并创建必要的 pod。当 OpenShift 检测到组件的配置中更改时，它会相应地重启 pod。

配置 OpenShift Dev Spaces 服务器组件的主要属性

在 cheServer 组件部分中应用 CheCluster 自定义资源 YAML 文件及适当的修改。
Operator 生成 che ConfigMap。
OpenShift 会检测 ConfigMap 中的更改，并触发 OpenShift Dev Spaces pod 重启。

其他资源

3.1.1. 在安装过程中使用 dsc 配置 `CheCluster` 自定义资源

要使用适当的配置部署 OpenShift Dev Spaces，请在安装 OpenShift Dev Spaces 的过程中编辑 CheCluster 自定义资源 YAML 文件。否则，OpenShift Dev Spaces 部署使用 Operator 默认配置参数。

先决条件

具有 OpenShift 集群的管理权限的活跃的 oc 会话。请参阅开始使用 CLI。
DSM.请参阅：第 1.2 节 “安装 dsc 管理工具”。

流程

创建一个 che-operator-cr-patch.yaml YAML 文件，其中包含要配置的 CheCluster 自定义资源的子集：
```
spec:
  <component>:
      <property_to_configure>: <value>
```

部署 OpenShift Dev Spaces 并应用 che-operator-cr-patch.yaml 文件中描述的更改：

$ dsc server:deploy \
--che-operator-cr-patch-yaml=che-operator-cr-patch.yaml \
--platform <chosen_platform>

验证

验证配置的属性的值：

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

其他资源

3.1.2. 使用 CLI 配置 CheCluster 自定义资源

要配置正在运行的 OpenShift Dev Spaces 实例，请编辑 CheCluster 自定义资源 YAML 文件。

先决条件

OpenShift 上的 OpenShift Dev Spaces 实例。
一个活跃的 oc 会话，它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。

流程

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

$ oc edit checluster/devspaces -n openshift-devspaces

保存并关闭该文件以应用更改。

验证

验证配置的属性的值：

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

其他资源

3.1.3. `CheCluster` 自定义资源字段参考

本节论述了可用于自定义 CheCluster 自定义资源的所有字段。

例 3.1. 一个最小的 CheCluster 自定义资源示例。

apiVersion: org.eclipse.che/v2
kind: CheCluster
metadata:
  name: devspaces
  namespace: openshift-devspaces
spec:
  components: {}
  devEnvironments: {}
  networking: {}

表 3.1. 开发环境配置选项。
属性	描述	Default（默认）
containerBuildConfiguration	容器构建配置。
defaultComponents	应用到 DevWorkspace 的默认组件。这些默认组件应该在 Devfile 不包含任何组件时使用。
defaultEditor	要使用的工作区创建的默认编辑器。它可以是插件 ID 或 URI。插件 ID 必须具有 `publisher/plugin/version` 格式。URI 必须从 `http://` 或 `https://` 启动。
defaultNamespace	用户的默认命名空间。	{ "autoProvision": true, "template": "<username>-che"}
defaultPlugins	应用到 DevWorkspace 的默认插件。
disableContainerBuildCapabilities	禁用容器构建功能。
maxNumberOfRunningWorkspacesPerUser	每个用户运行工作区的最大数量。值 -1 允许用户运行无限数量的工作区。
maxNumberOfWorkspacesPerUser	用户可以保留的工作空间总数，包括停止和运行。值 -1 允许用户保持无限数量的工作区。	-1
nodeSelector	节点选择器限制可运行工作区 pod 的节点。
podSchedulerName	工作区 pod 的 Pod 调度程序。如果没有指定，pod 调度程序将设置为集群中的默认调度程序。
secondsOfInactivityBeforeIdling	以秒为单位的工作区闲置超时。这个超时是工作区在没有活动时会被闲置的持续时间。要禁用因为不活跃而闲置工作区，请将此值设置为 -1。	1800
secondsOfRunBeforeIdling	以秒为单位为工作区运行超时。这个超时是工作区运行的最长持续时间。要禁用工作区运行超时，请将此值设置为 -1。	-1
serviceAccount	启动工作区时由 DevWorkspace operator 使用的 ServiceAccount。
serviceAccountTokens	将挂载到工作空间 pod 的 ServiceAccount 令牌列表作为投射卷。
startTimeoutSeconds	StartTimeoutSeconds 决定工作区在自动失败前可以启动的最长时间（以秒为单位）。如果没有指定，则使用默认值 300 秒(5 分钟)。	300
storage	工作区持久性存储。	{ "pvcStrategy": "per-user"}
容限（tolerations）	工作区 pod 的 pod 容限限制了工作区 pod 可以运行的情况。
trustedCerts	可信证书设置。

表 3.2. defaultNamespace 选项。
属性	描述	Default（默认）
autoProvision	指明是否允许自动创建用户命名空间。如果设置为 false，则集群管理员必须预先创建用户命名空间。	true
模板	如果您不预先创建用户命名空间，此字段定义了在启动第一个工作区时创建的 Kubernetes 命名空间。您可以使用 < `username>` 和 & `lt;userid&` gt; 占位符，如 che-workspace-<username>。	"<username>-che"

表 3.3. defaultPlugins 选项。
属性	描述	Default（默认）
editor	用于指定默认插件的编辑器 ID。
plugins	指定编辑器的默认插件 URI。

表 3.4. 存储选项。
属性	描述	Default（默认）
perUserStrategyPvcConfig	使用每个用户 PVC 策略时 `的` PVC 设置。
perWorkspaceStrategyPvcConfig	使用 `per-workspace` PVC 策略时的 PVC 设置。
pvcStrategy	OpenShift Dev Spaces 服务器的持久性卷声明策略。支持的策略有：`per-user`（一个卷中的所有工作区 PVC）、`per-workspace`（每个工作区都有自己的独立 PVC）和 `ephemeral`（非持久性存储，当工作区停止时本地的变化会丢失。）	"per-user"

表 3.5. 每个用户 PVC 策略选项。
属性	描述	Default（默认）
claimSize	持久性卷声明大小。要更新声明大小，置备它的存储类必须支持调整大小。
storageClass	持久性卷声明的存储类。当忽略或留空时，会使用默认存储类。

表 3.6. 每个工作区 PVC 策略选项。
属性	描述	Default（默认）
claimSize	持久性卷声明大小。要更新声明大小，置备它的存储类必须支持调整大小。
storageClass	持久性卷声明的存储类。当忽略或留空时，会使用默认存储类。

表 3.7. trustedCerts 选项。
属性	描述	Default（默认）
gitTrustedCertsConfigMapName	ConfigMap 包含要传播到 OpenShift Dev Spaces 组件的证书，并为 Git 提供特定的配置。请参见以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/deploying-che-with-support-for-git-repositories-with-self-signed-certificates/ ConfigMap 必须具有 `app.kubernetes.io/part-of=che.eclipse.org` 标签。

表 3.8. containerBuildConfiguration 选项。
属性	描述	Default（默认）
openShiftSecurityContextConstraint	构建容器的 OpenShift 安全性上下文约束。	"container-build"

表 3.9. OpenShift Dev Spaces 组件配置。
属性	描述	Default（默认）
cheServer	与 OpenShift Dev Spaces 服务器相关的常规配置设置。	{ "debug": false, "logLevel": "INFO"}
dashboard	与 OpenShift Dev Spaces 安装使用的仪表板相关的配置设置。
数据库	与 OpenShift Dev Spaces 安装使用的数据库相关的配置设置。数据库组件已弃用。所有属性将被忽略。
devWorkspace	DevWorkspace Operator 配置。
devfileRegistry	与 OpenShift Dev Spaces 安装使用的 devfile registry 相关的配置设置。
imagePuller	Kubernetes Image Puller 配置。
metrics	OpenShift Dev Spaces 服务器指标配置。	{ "enable": true}
pluginRegistry	与 OpenShift Dev Spaces 安装使用的插件 registry 相关的配置设置。

表 3.10. 与 OpenShift Dev Spaces 服务器组件相关的常规配置设置。
属性	描述	Default（默认）
clusterRoles	分配给 OpenShift Dev Spaces ServiceAccount 的 ClusterRole。默认角色为： - < `devspaces-namespace>-cheworkspaces-namespaces-clusterrole` - `<devspaces-namespace>-cheworkspaces-clusterrole` - & `lt;devspaces-namespace>-cheworkspaces-devworkspace-clusterrole`，其中 <devspaces-namespace> 是创建 CheCluster CRD 的命名空间。每个角色都必须有一个 `app.kubernetes.io/part-of=che.eclipse.org` 标签。OpenShift Dev Spaces Operator 必须已有这些 ClusterRole 中的所有权限才能授予它们。
debug	为 OpenShift Dev Spaces 服务器启用调试模式。	false
部署	部署覆盖选项。
extraProperties	除了从 `CheCluster` 自定义资源(CR)的其他字段生成的值外，OpenShift Dev Spaces 服务器使用生成的 `che` ConfigMap 中应用的额外环境变量映射。如果 `extraProperties` 字段包含通常从其他 CR 字段在 `che` ConfigMap 中生成的属性，则会使用 `extraProperties` 中定义的值。
logLevel	OpenShift Dev Spaces 服务器的日志级别： `INFO` 或 `DEBUG`。	"INFO"
proxy	Kubernetes 集群的代理服务器设置。OpenShift 集群不需要额外的配置。通过为 OpenShift 集群指定这些设置，您可以覆盖 OpenShift 代理配置。

表 3.11. 代理选项。
属性	描述	Default（默认）
credentialsSecretName	包含代理服务器 `的用户名和密码` 的 secret 名称。secret 必须具有 `app.kubernetes.io/part-of=che.eclipse.org` 标签。
nonProxyHosts	可以直接访问的主机列表，绕过代理。指定通配符域，使用以下格式 .&lt `;DOMAIN&` gt;，例如： - localhost - my.host.com - 123.42.12.32 仅在需要代理配置时使用。Operator 会考虑 OpenShift 集群范围的代理配置，在自定义资源中定义 `nonProxyHosts` 会导致集群代理配置中合并非代理主机列表，以及自定义资源中定义的主机。请参见以下页面：https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html。
端口	代理服务器端口。
url	代理服务器的 URL (protocol+hostname)。仅在需要代理配置时使用。Operator 会考虑 OpenShift 集群范围的代理配置，在自定义资源中定义 `url` 会导致覆盖集群代理配置。请参见以下页面：https://docs.openshift.com/container-platform/4.4/networking/enable-cluster-wide-proxy.html。

表 3.12. 与 OpenShift Dev Spaces 安装使用的插件 registry 组件相关的配置设置。
属性	描述	Default（默认）
部署	部署覆盖选项。
disableInternalRegistry	禁用内部插件 registry。
externalPluginRegistries	外部插件 registry。
openVSXURL	打开 VSX registry URL。如果省略了嵌入式实例。

表 3.13. ExternalPluginRegistries 选项。
属性	描述	Default（默认）
url	插件 registry 的公共 URL。

表 3.14. 与 OpenShift Dev Spaces 安装使用的 Devfile registry 组件相关的配置设置。
属性	描述	Default（默认）
部署	部署覆盖选项。
disableInternalRegistry	禁用内部 devfile registry。
externalDevfileRegistries	外部 devfile registry 服务示例可直接使用 devfile。

表 3.15. ExternalDevfileRegistries 选项。
属性	描述	Default（默认）
url	提供示例 ready-to-use devfile 的 devfile registry 的公共 UR。

表 3.16. 与 OpenShift Dev Spaces 安装使用的 Dashboard 组件相关的配置设置。
属性	描述	Default（默认）
部署	部署覆盖选项。
headerMessage	仪表板标头消息。

表 3.17. headerMessage 选项。
属性	描述	Default（默认）
显示	指示仪表板显示消息。
text	用户仪表板中显示警告消息。

表 3.18. Kubernetes Image Puller 组件配置。
属性	描述	Default（默认）
enable	安装和配置社区支持的 Kubernetes Image Puller Operator。当您在不提供任何 specs 的情况下将值设为 `true` 时，它会创建一个由 Operator 管理的默认 Kubernetes Image Puller 对象。当您将值设为 `false` 时，Kubernetes Image Puller 对象会被删除，无论是否提供了 spec，Operator 会卸载。如果将 `spec.images` 字段留空，则会自动检测到一组推荐的与工作区相关的镜像，并在安装后预先拉取。请注意，虽然此 Operator 及其行为是社区支持，但其有效负载可能会被商业支持，以拉取商业支持的镜像。
spec	Kubernetes Image Puller spec，用于在 CheCluster 中配置镜像拉取程序。

表 3.19. OpenShift Dev Spaces 服务器指标组件配置。
属性	描述	Default（默认）
enable	为 OpenShift Dev Spaces 服务器端点启用 `指标`。	true

表 3.20. 允许用户处理远程 Git 存储库的配置设置。
属性	描述	Default（默认）
azure	允许用户使用托管在 Azure DevOps Service (dev.azure.com)上的存储库。
bitbucket	允许用户使用托管在 Bitbucket 上的存储库(bitbucket.org 或 self-hosted)。
github	允许用户使用托管在 GitHub 上的存储库(github.com 或 GitHub Enterprise)。
gitlab	允许用户使用托管在 GitLab 上的存储库(gitlab.com 或 self-hosted)。

表 3.21. GitHub 选项。
属性	描述	Default（默认）
disableSubdomainIsolation	禁用子域隔离。弃用使用 `che.eclipse.org/scm-github-disable-subdomain-isolation` 注解。详情请查看以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/。
端点	GitHub 服务器端点 URL。弃用使用 `che.eclipse.org/scm-server-endpoint` 注解。详情请查看以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/。
secretName	Kubernetes secret，其中包含 Base64 编码的 GitHub OAuth 客户端 ID 和 GitHub OAuth 客户端 secret。详情请查看以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/。

表 3.22. GitLab 选项。
属性	描述	Default（默认）
端点	GitLab 服务器端点 URL。弃用使用 `che.eclipse.org/scm-server-endpoint` 注解。请参见以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/。
secretName	Kubernetes secret，其中包含 Base64 编码的 GitHub 应用程序 ID 和 GitLab Application Client secret。请参见以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/。

表 3.23. Bitbucket 选项。
属性	描述	Default（默认）
端点	Bitbucket 服务器端点 URL。弃用使用 `che.eclipse.org/scm-server-endpoint` 注解。请参见以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/。
secretName	Kubernetes secret，其中包含 Base64 编码的 Bitbucket OAuth 1.0 或 OAuth 2.0 数据。详情请查看以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-1-for-a-bitbucket-server/ 和 https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-the-bitbucket-cloud/。

表 3.24. Azure 选项。
属性	描述	Default（默认）
secretName	Kubernetes secret，包含 Base64 编码的 Azure DevOps Service Application ID 和客户端 Secret。请参见以下页面：https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-microsoft-azure-devops-services

表 3.25. 网络、OpenShift Dev Spaces 身份验证和 TLS 配置。
属性	描述	Default（默认）
annotations	定义将为 Ingress 设置的注解(OpenShift 平台的路由)。kubernetes 平台的默认值为：kubernetes.io/ingress.class: "nginx" nginx.ingress.kubernetes.io/proxy-read-timeout: "3600", nginx.ingress.kubernetes.io/proxy-connect-timeout: "3600", nginx.ingress.kubernetes.io/ssl-redirect: "true"
auth	身份验证设置。	{ "gateway": { "configLabels": { "app": "che", "component": "che-gateway-config" } }}
domain	对于 OpenShift 集群，Operator 使用域为路由生成主机名。生成的主机名遵循以下模式： che-<devspaces-namespace>.<domain>。<devspaces-namespace> 是创建 CheCluster CRD 的命名空间。与标签一同使用，它会创建一个非默认 Ingress 控制器提供的路由。对于 Kubernetes 集群，它包含一个全局入口域。没有默认值：您必须指定它们。
hostname	安装的 OpenShift Dev Spaces 服务器的公共主机名。
labels	定义将为 Ingress 设置的标签(OpenShift 平台的路由)。
tlsSecretName	用于设置 Ingress TLS 终止的 secret 名称。如果字段是空字符串，则使用默认集群证书。secret 必须具有 `app.kubernetes.io/part-of=che.eclipse.org` 标签。

表 3.26. 身份验证选项。
属性	描述	Default（默认）
gateway	网关设置。	{ "configLabels": { "app": "che", "component": "che-gateway-config" }}
identityProviderURL	身份提供程序服务器的公共 URL。
identityToken	要传递给上游的身份令牌。支持两种令牌： `id_token` 和 `access_token`。默认值为 `id_token`。此字段只适用于只为 Kubernetes 进行的 OpenShift Dev Spaces 安装，并为 OpenShift 忽略。
oAuthAccessTokenInactivityTimeoutSeconds	在 OpenShift `OAuthClient` 资源中设置的不活动超时，用于在 OpenShift 端设置身份联邦。0 表示此客户端的令牌永远不会超时。
oAuthAccessTokenMaxAgeSeconds	在 OpenShift `OAuthClient` 资源中设置的访问令牌最大期限，用于在 OpenShift 端设置身份联邦。0 表示没有过期。
oAuthClientName	用于在 OpenShift 端设置身份联合的 OpenShift `OAuthClient` 资源的名称。
oAuthScope	访问令牌范围。此字段只适用于只为 Kubernetes 进行的 OpenShift Dev Spaces 安装，并为 OpenShift 忽略。
oAuthSecret	OpenShift `OAuthClient` 资源中设置的 secret 名称，用于在 OpenShift 端设置身份联邦。

表 3.27. 网关选项。
属性	描述	Default（默认）
configLabels	网关配置标签。	{ "app": "che", "component": "che-gateway-config"}
部署	部署覆盖选项。由于网关部署由多个容器组成，因此必须以其名称区分它们： - `gateway` - `configbump` - `oauth-proxy` - `kube-rbac-proxy`

表 3.28. 配置存储 OpenShift Dev Spaces 镜像的替代 registry。
属性	描述	Default（默认）
hostname	从中拉取镜像的替代容器 registry 的可选主机名或 URL。这个值覆盖 OpenShift Dev Spaces 部署中涉及的所有默认容器镜像中定义的容器 registry 主机名。这对在受限环境中安装 OpenShift Dev Spaces 特别有用。
机构	从中拉取镜像的替代 registry 的可选仓库名称。这个值覆盖 OpenShift Dev Spaces 部署中涉及的所有默认容器镜像中定义的容器 registry 组织。这对在受限环境中安装 OpenShift Dev Spaces 特别有用。

表 3.29. 部署选项。
属性	描述	Default（默认）
containers	属于 pod 的容器列表。
securityContext	pod 应该使用的安全选项运行。

表 3.30. 容器选项。
属性	描述	Default（默认）
env	要在容器中设置的环境变量列表。
image	容器镜像。省略它或将其留空，以使用 Operator 提供的默认容器镜像。
imagePullPolicy	镜像拉取策略。对于 `每天`、`下一个` 或 `最新的镜像`，默认值为 `Always`，在其他情况下为 `IfNotPresent`。
name	容器名称。
资源	此容器所需的计算资源。

表 3.31. 容器选项。
属性	描述	Default（默认）
limits	描述允许的最大计算资源量。
Request	描述所需的最少计算资源。

表 3.32. 请求选项。
属性	描述	Default（默认）
cpu	以内核数为单位的 CPU。(500M = .5 个内核)如果没有指定值，则默认值会根据组件进行设置。如果值为 `0，` 则不会为组件设置值。
memory	内存，以字节为单位。(500Gi = 500GiB = 500114 1024114 1024)如果未指定值，则会根据组件设置默认值。如果值为 `0，` 则不会为组件设置值。

表 3.33. 限制选项。
属性	描述	Default（默认）
cpu	以内核数为单位的 CPU。(500M = .5 个内核)如果没有指定值，则默认值会根据组件进行设置。如果值为 `0，` 则不会为组件设置值。
memory	内存，以字节为单位。(500Gi = 500GiB = 500114 1024114 1024)如果未指定值，则会根据组件设置默认值。如果值为 `0，` 则不会为组件设置值。

表 3.34. securityContext 选项。
属性	描述	Default（默认）
fsGroup	适用于 pod 中所有容器的特殊补充组。默认值为 `1724`。
runAsUser	运行容器进程的入口点的 UID。默认值为 `1724`。

表 3.35. CheCluster 自定义资源状态定义 OpenShift Dev Spaces 安装的状态
属性	描述	Default（默认）
chePhase	指定 OpenShift Dev Spaces 部署的当前阶段。
cheURL	OpenShift Dev Spaces 服务器的公共 URL。
cheVersion	当前安装的 OpenShift Dev Spaces 版本。
devfileRegistryURL	内部 devfile registry 的公共 URL。
gatewayPhase	指定网关部署的当前阶段。
message	人类可读的消息，指示 OpenShift Dev Spaces 部署处于当前阶段的原因。
pluginRegistryURL	内部插件 registry 的公共 URL。
postgresVersion	使用的镜像的 PostgreSQL 版本。
reason	简短的 CamelCase 消息，指示 OpenShift Dev Spaces 部署处于当前阶段的原因。
workspaceBaseDomain	解析的工作区基域。这是 spec 中相同名称明确定义的属性的副本，或者在 spec 中未定义，且我们在 OpenShift 上运行，则自动解析了路由的 basedomain。

第 3 章配置 Dev Spaces

3.1. 了解 `CheCluster` 自定义资源

3.1.1. 在安装过程中使用 dsc 配置 `CheCluster` 自定义资源

3.1.2. 使用 CLI 配置 CheCluster 自定义资源

3.1.3. `CheCluster` 自定义资源字段参考

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links

第 3 章 配置 Dev Spaces

3.1. 了解 CheCluster 自定义资源

3.1.1. 在安装过程中使用 dsc 配置 CheCluster 自定义资源

3.1.2. 使用 CLI 配置 CheCluster 自定义资源

3.1.3. CheCluster 自定义资源字段参考

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Red Hat legal and privacy links

Red Hat legal and privacy links

第 3 章配置 Dev Spaces

3.1. 了解 `CheCluster` 自定义资源

3.1.1. 在安装过程中使用 dsc 配置 `CheCluster` 自定义资源

3.1.3. `CheCluster` 自定义资源字段参考