This documentation is for a release that is no longer maintained
See documentation for the latest supported version.管理指南
管理 Red Hat OpenShift Dev Spaces 3.6
摘要
第 1 章 准备安装 复制链接链接已复制到粘贴板!
要准备 OpenShift Dev Spaces 安装,了解 OpenShift Dev Spaces 生态系统和部署限制:
1.1. 支持的平台 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 在以下 CPU 架构的 OpenShift 4.10-4.13 上运行:
-
AMD64 和 Intel 64 (
x86_64) -
IBM Power (
ppc64le) 和 IBM Z (s390x)
其他资源
1.2. 安装 dsc 管理工具 复制链接链接已复制到粘贴板!
您可以在 Microsoft Windows、Mrca MacOS 和 Linux 上安装 dsc、Red Hat OpenShift Dev Spaces 命令行工具。使用 dsc,您可以对 OpenShift Dev Spaces 服务器执行操作,如启动、停止、更新和删除服务器。
先决条件
Linux 或 macOS。
注意有关在 Windows 上安装
dsc,请查看以下页面:
流程
-
将存档从 https://developers.redhat.com/products/openshift-dev-spaces/download 下载到
$HOME等目录中。 -
在存档上运行
tar xvzf,以提取/dsc目录。 -
将提取的
/dsc/bin子目录添加到$PATH。
验证
运行
dsc以查看它的信息。dsc
$ dscCopy to Clipboard Copied! Toggle word wrap Toggle overflow
其他资源
- "DS 参考文档"
1.3. 架构 复制链接链接已复制到粘贴板!
图 1.1. 使用 Dev Workspace operator 的 OpenShift Dev Spaces 架构
OpenShift Dev Spaces 在三个组件组上运行:
- OpenShift Dev Spaces 服务器组件
- 管理用户项目和工作区。主组件是 User dashboard,用户从中控制其工作区。
- dev Workspace operator
-
创建和控制运行用户工作区所需的 OpenShift 对象。包括
Pod、服务和PersistentVolume。 - 用户工作区
- 基于容器的开发环境,包括 IDE。
这些 OpenShift 功能的角色是中央:
- dev Workspace 自定义资源
- 代表用户工作区并由 OpenShift Dev Spaces 操作的有效 OpenShift 对象。它是三个组件组的通信频道。
- OpenShift 基于角色的访问控制(RBAC)
- 控制对所有资源的访问。
其他资源
1.3.1. 服务器组件 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 服务器组件确保多租户和工作区管理。
图 1.2. 与 Dev Workspace operator 交互的 OpenShift Dev Spaces 服务器组件
其他资源
1.3.1.1. dev Spaces operator 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces operator 确保 OpenShift Dev Spaces 服务器组件的完整生命周期管理。它引进了:
CheCluster自定义资源定义(CRD)-
定义
CheClusterOpenShift 对象。 - OpenShift Dev Spaces 控制器
- 创建和控制运行 OpenShift Dev Spaces 实例所需的 OpenShift 对象,如 pod、服务和持久性卷。
CheCluster自定义资源(CR)在带有 OpenShift Dev Spaces Operator 的集群中,可以创建
CheCluster自定义资源(CR)。OpenShift Dev Spaces operator 确保此 OpenShift Dev Spaces 实例上的 OpenShift Dev Spaces 服务器组件的完整生命周期管理:
1.3.1.2. dev Workspace operator 复制链接链接已复制到粘贴板!
Dev Workspace 操作器将 OpenShift 扩展为提供 Dev Workspace 支持。它引进了:
- dev Workspace 自定义资源定义
- 从 Devfile v2 规范定义 Dev Workspace OpenShift 对象。
- dev Workspace 控制器
- 创建和控制运行 Dev Workspace 所需的 OpenShift 对象,如 pod、服务和持久性卷。
- dev Workspace 自定义资源
- 在使用 Dev Workspace operator 的集群中,可以创建 Dev Workspace 自定义资源(CR)。Dev Workspace CR 是 Devfile 的 OpenShift 表示。它定义 OpenShift 集群中的用户工作区。
其他资源
1.3.1.3. gateway 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 网关具有以下角色:
- 路由请求。它使用 Traefik。
- 使用 OpenID Connect (OIDC)验证用户。它使用 OpenShift OAuth2 代理。
- 应用 OpenShift 基于角色的访问控制(RBAC)策略来控制对任何 OpenShift Dev Spaces 资源的访问。它使用 'kube-rbac-proxy'。
OpenShift Dev Spaces 操作器将其作为 che-gateway Deployment 进行管理。
它控制对以下的访问:
图 1.3. OpenShift Dev Spaces 网关与其他组件交互
其他资源
1.3.1.4. 用户仪表板 复制链接链接已复制到粘贴板!
用户仪表板是 Red Hat OpenShift Dev Spaces 的登录页面。OpenShift Dev Spaces 用户浏览用户仪表板以访问和管理其工作区。它是 React 应用程序。OpenShift Dev Spaces 部署会在 devspaces-dashboard 部署中启动它。
它需要访问:
图 1.4. 用户仪表板与其他组件交互
当用户请求用户仪表板启动工作区时,用户仪表板会执行这一操作序列:
- 当用户从代码示例创建工作区时,从 第 1.3.1.5 节 “devfile registry” 收集 devfile。
- 当用户从远程 devfile 创建工作区时,将存储库 URL 发送到 第 1.3.1.6 节 “dev Spaces 服务器” 并需要返回 devfile。
- 读取描述工作区的 devfile。
- 从 第 1.3.1.7 节 “插件 registry” 收集其他元数据。
- 将信息转换为 Dev Workspace 自定义资源。
- 使用 OpenShift API 在用户项目中创建 Dev Workspace 自定义资源。
- 监视 Dev Workspace 自定义资源状态。
- 将用户重定向到正在运行的工作区 IDE。
1.3.1.5. devfile registry 复制链接链接已复制到粘贴板!
其他资源
OpenShift Dev Spaces devfile registry 是提供示例 devfile 列表的服务,用于创建随时可用的工作区。第 1.3.1.4 节 “用户仪表板” 在 Dashboard → Create Workspace 页面中显示示例列表。每个示例都包含一个 Devfile v2。OpenShift Dev Spaces 部署在 devfile-registry 部署中启动一个 devfile registry 实例。
图 1.5. devfile registry 与其他组件交互
1.3.1.6. dev Spaces 服务器 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 服务器主要功能是:
- 创建用户命名空间。
- 使用所需的 secret 和配置映射置备用户命名空间。
- 与 Git 服务提供商集成,以获取和验证 devfile 和身份验证。
OpenShift Dev Spaces 服务器是公开 HTTP REST API 的 Java Web 服务,需要访问:
- Git 服务提供商
- OpenShift API
图 1.6. OpenShift Dev Spaces 服务器与其他组件交互
1.3.1.7. 插件 registry 复制链接链接已复制到粘贴板!
每个 OpenShift Dev Spaces 工作区都以特定的编辑器以及一组关联的扩展开始。OpenShift Dev Spaces 插件 registry 提供了可用的编辑器和编辑器扩展列表。Devfile v2 描述每个编辑器或扩展。
第 1.3.1.4 节 “用户仪表板” 正在读取 registry 的内容。
图 1.7. 插件 registry 与其他组件交互
1.3.2. 用户工作区 复制链接链接已复制到粘贴板!
图 1.8. 用户工作区与其他组件交互
用户工作区是在容器中运行的 Web IDE。
用户工作区是一个 Web 应用。它由容器中运行的微服务组成,提供浏览器中运行的现代 IDE 的所有服务:
- Editor
- 语言自动完成
- 语言服务器
- 调试工具
- 插件
- 应用程序运行时
工作区是一个 OpenShift Deployment,其中包含工作区容器和启用插件,以及相关的 OpenShift 组件:
- 容器
- ConfigMaps
- 服务
- Endpoints
- ingresses 或 Routes
- Secrets
- 持久性卷(PV)
OpenShift Dev Spaces 工作区包含项目的源代码,保留在 OpenShift 持久性卷(PV)中。微服务具有对此共享目录的读写访问权限。
使用 devfile v2 格式指定 OpenShift Dev Spaces 工作区的工具和运行时应用程序。
下图显示了一个正在运行的 OpenShift Dev Spaces 工作区及其组件。
图 1.9. OpenShift Dev Spaces 工作区组件
在图中,有一个正在运行的工作区。
1.4. 计算 Dev Spaces 资源要求 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces Operator、Dev Workspace Controller 和用户工作区由一组 pod 组成。pod 对 CPU 和内存限值和请求中的资源消耗贡献。
以下到 示例 devfile 的链接是上游社区的材料的指针。本材料代表了最新的可用内容,以及最新的最佳实践。这些提示尚未被红帽的 QE 部门利用,并且尚未由广泛的用户组证明。请小心使用此信息。它最适用于企业和"开发"目的,而不是"生产"目的。
流程
识别取决于用于定义开发环境的 devfile 的工作区资源要求。这包括识别 devfile 的
components部分中明确指定的工作区组件。以下是带有 以下组件的 devfile 示例 :
例 1.1.
工具devfile
的工具组件定义以下请求和限值:memoryLimit: 6G memoryRequest: 512M cpuRequest: 1000m cpuLimit: 4000mmemoryLimit: 6G memoryRequest: 512M cpuRequest: 1000m cpuLimit: 4000mCopy to Clipboard Copied! Toggle word wrap Toggle overflow 例 1.2.
postgresqlpostgresql组件没有定义任何请求和限值,因此会在专用容器的默认值上返回:memoryLimit: 128M memoryRequest: 64M cpuRequest: 10m cpuLimit: 1000mmemoryLimit: 128M memoryRequest: 64M cpuRequest: 10m cpuLimit: 1000mCopy to Clipboard Copied! Toggle word wrap Toggle overflow 在工作区启动过程中,内部
che-gateway容器使用以下请求和限制隐式置备:memoryLimit: 256M memoryRequest: 64M cpuRequest: 50m cpuLimit: 500mmemoryLimit: 256M memoryRequest: 64M cpuRequest: 50m cpuLimit: 500mCopy to Clipboard Copied! Toggle word wrap Toggle overflow
计算每个工作区所需的资源总和。如果要使用多个 devfile,请对每个预期的 devfile 重复这个计算。
例 1.3. 上一步中 示例 devfile 的工作区要求
Expand 用途 Pod 容器名称 内存限制 内存请求 CPU 限制 CPU 请求 开发人员工具
workspace工具6 GiB
512 MiB
4000 M
1000 M
数据库
workspacepostgresql128 MiB
64 MiB
1000 M
10 M
OpenShift Dev Spaces 网关
workspacechee-gateway256 MiB
64 MiB
500 M
50 M
总计
6.4 GiB
640 MiB
5500 M
1060 M
- 根据您期望所有用户同时运行的工作区数乘以每个工作区计算的资源。
计算 OpenShift Dev Spaces Operator、Operands 和 Dev Workspace Controller 的要求总和。
Expand 表 1.1. OpenShift Dev Spaces Operator、Operperpers 和 Dev Workspace Controller 的默认要求 用途 Pod 名称 容器名称 内存限制 内存请求 CPU 限制 CPU 请求 OpenShift Dev Spaces operator
devspaces-operatordevspaces-operator256 MiB
64 MiB
500 M
100 M
OpenShift Dev Spaces Server
devspacesdevspaces-server1 GiB
512 MiB
1000 M
100 M
OpenShift Dev Spaces Dashboard
devspaces-dashboarddevspaces-dashboard256 MiB
32 MiB
500 M
100 M
OpenShift Dev Spaces Gateway
devspaces-gatewaytraefik4 GiB
128 MiB
1000 M
100 M
OpenShift Dev Spaces Gateway
devspaces-gatewayconfigbump256 MiB
64 MiB
500 M
50 M
OpenShift Dev Spaces Gateway
devspaces-gatewayoauth-proxy512 MiB
64 MiB
500 M
100 M
OpenShift Dev Spaces Gateway
devspaces-gatewaykube-rbac-proxy512 MiB
64 MiB
500 M
100 M
devfile registry
devfile-registrydevfile-registry256 MiB
32 MiB
500 M
100 M
插件 registry
plugin-registryplugin-registry256 MiB
32 MiB
500 M
100 M
dev Workspace Controller Manager
devworkspace-controller-managerdevworkspace-controller1 GiB
100 MiB
1000 M
250 M
dev Workspace Controller Manager
devworkspace-controller-managerkube-rbac-proxy不适用
不适用
不适用
不适用
dev Workspace Webhook 服务器
devworkspace-webhook-serverwebhook-server300 MiB
20 MiB
200 M
100 M
dev Workspace Operator Catalog
devworkspace-operator-catalogregistry-server不适用
50 MiB
不适用
10 M
dev Workspace Webhook 服务器
devworkspace-webhook-serverwebhook-server300 MiB
20 MiB
200 M
100 M
dev Workspace Webhook 服务器
devworkspace-webhook-serverkube-rbac-proxy不适用
不适用
不适用
不适用
总计
9 GiB
1.2 GiB
6.9
1.3
第 2 章 安装 Dev Spaces 复制链接链接已复制到粘贴板!
本节包含安装 Red Hat OpenShift Dev Spaces 的说明。
每个集群只能部署一个 OpenShift Dev Spaces 实例。
2.1. 使用 CLI 在 OpenShift 上安装 Dev Spaces 复制链接链接已复制到粘贴板!
您可以在 OpenShift 上安装 OpenShift Dev Spaces。
先决条件
- OpenShift Container Platform
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 -
DSM.请参阅: 第 1.2 节 “安装 dsc 管理工具”。
流程
可选: 如果您之前在这个 OpenShift 集群中部署了 OpenShift Dev Spaces,请确保删除以前的 OpenShift Dev Spaces 实例:
dsc server:delete
$ dsc server:deleteCopy to Clipboard Copied! Toggle word wrap Toggle overflow 创建 OpenShift Dev Spaces 实例:
dsc server:deploy --platform openshift
$ dsc server:deploy --platform openshiftCopy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
验证 OpenShift Dev Spaces 实例状态:
dsc server:status
$ dsc server:statusCopy to Clipboard Copied! Toggle word wrap Toggle overflow 进入 OpenShift Dev Spaces 集群实例:
dsc dashboard:open
$ dsc dashboard:openCopy to Clipboard Copied! Toggle word wrap Toggle overflow
2.2. 使用 Web 控制台在 OpenShift 上安装 Dev Spaces 复制链接链接已复制到粘贴板!
如果您 在命令行上安装 OpenShift Dev Spaces 时遇到问题,您可以通过 OpenShift Web 控制台安装它。
先决条件
- 集群管理员的 OpenShift Web 控制台会话。请参阅 访问 Web 控制台。
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 - 在同一 OpenShift 集群上重复安装:根据 第 7 章 卸载 Dev Spaces 卸载以前的 OpenShift Dev Spaces 实例。
流程
-
在 OpenShift Web 控制台的 Administrator 视图中,进入 Operators → OperatorHub 并搜索
Red Hat OpenShift Dev Spaces。 安装 Red Hat OpenShift Dev Spaces Operator。
提示请参阅使用 Web 控制台从 OperatorHub 安装。
在 OpenShift 中创建
openshift-devspaces项目,如下所示:oc create namespace openshift-devspaces
oc create namespace openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 进入 Operators → Installed Operators → Red Hat OpenShift Dev Spaces instance Specification → Create CheCluster → YAML view。
-
在 YAML 视图中,将
namespace: openshift-operators替换为namespace: openshift-devspaces。 选择 Create。
提示
验证
- 在 Red Hat OpenShift Dev Spaces 实例规格 中,进入 devspaces,在 Details 标签页中登录。
- 在 Message 下,检查是否有 None,这意味着没有错误。
- 在 Red Hat OpenShift Dev Spaces URL 下,等待 OpenShift Dev Spaces 实例的 URL 出现,然后打开 URL 以检查 OpenShift Dev Spaces 仪表板。
- 在 Resources 选项卡中,查看 OpenShift Dev Spaces 部署的资源及其状态。
2.3. 在受限环境中安装 Dev Spaces 复制链接链接已复制到粘贴板!
在受限网络中运行的 OpenShift 集群上,公共资源不可用。
但是,部署 OpenShift Dev Spaces 和运行工作区需要以下公共资源:
- Operator 目录
- 容器镜像
- 项目示例
要使这些资源可用,您可以将这些资源替换为 OpenShift 集群可访问的 registry 中的副本。
先决条件
- OpenShift 集群至少有 64 GB 磁盘空间。
- OpenShift 集群已准备好在受限网络中运行,OpenShift control plane 可访问公共互联网。请参阅有关断开连接的安装镜像,并 在受限网络中使用 Operator Lifecycle Manager。
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 -
一个有效的
oc registry会话,指向registry.redhat.io红帽生态系统目录。请参阅: Red Hat Container Registry 身份验证。
-
opm.请参阅安装opmCLI。 -
jq.请参阅 下载jq。 -
Podman.请参阅 Podman 安装说明。 -
一个活跃的
skopeo会话,它具有对 < my_registry> registry 的管理访问权限。请参阅安装 Skopeo 、授权到 registry 和为断开连接的安装镜像镜像。 -
用于OpenShift Dev Spaces 版本 3.6 的DS。请参阅 第 1.2 节 “安装 dsc 管理工具”。
流程
下载并执行镜像脚本,以安装自定义 Operator 目录并镜像相关的镜像: prepare-restricted-environment.sh。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用上一步中
che-operator-cr-patch.yaml中设置的配置安装 OpenShift Dev Spaces:dsc server:deploy --platform=openshift \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml
$ dsc server:deploy --platform=openshift \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 允许从 OpenShift Dev Spaces 命名空间中的传入流量到用户项目中的所有 Pod。请参阅: 第 3.7.1 节 “配置网络策略”。
其他资源
第 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 生成
cheConfigMap。 -
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.yamlYAML 文件,其中包含要配置的CheCluster自定义资源的子集:spec: <component>: <property_to_configure>: <value>spec: <component>: <property_to_configure>: <value>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 部署 OpenShift Dev Spaces 并应用
che-operator-cr-patch.yaml文件中描述的更改:dsc server:deploy \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml \ --platform <chosen_platform>
$ dsc server:deploy \ --che-operator-cr-patch-yaml=che-operator-cr-patch.yaml \ --platform <chosen_platform>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
验证配置的属性的值:
oc get configmap che -o jsonpath='{.data.<configured_property>}' \ -n openshift-devspaces$ oc get configmap che -o jsonpath='{.data.<configured_property>}' \ -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow
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 edit checluster/devspaces -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 保存并关闭该文件以应用更改。
验证
验证配置的属性的值:
oc get configmap che -o jsonpath='{.data.<configured_property>}' \ -n openshift-devspaces$ oc get configmap che -o jsonpath='{.data.<configured_property>}' \ -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.1.3. CheCluster 自定义资源字段参考 复制链接链接已复制到粘贴板!
本节论述了可用于自定义 CheCluster 自定义资源的所有字段。
例 3.1. 一个最小的 CheCluster 自定义资源示例。
| 属性 | 描述 | Default(默认) |
|---|---|---|
| containerBuildConfiguration | 容器构建配置。 | |
| defaultComponents | 应用到 DevWorkspace 的默认组件。这些默认组件应该在 Devfile 不包含任何组件时使用。 | |
| defaultEditor |
要使用的工作区创建的默认编辑器。它可以是插件 ID 或 URI。插件 ID 必须具有 | |
| 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 | 可信证书设置。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| autoProvision | 指明是否允许自动创建用户命名空间。如果设置为 false,则集群管理员必须预先创建用户命名空间。 | true |
| 模板 |
如果您不预先创建用户命名空间,此字段定义了在启动第一个工作区时创建的 Kubernetes 命名空间。您可以使用 < | "<username>-che" |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| editor | 用于指定默认插件的编辑器 ID。 | |
| plugins | 指定编辑器的默认插件 URI。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| perUserStrategyPvcConfig |
使用每个用户 PVC 策略时 | |
| perWorkspaceStrategyPvcConfig |
使用 | |
| pvcStrategy |
OpenShift Dev Spaces 服务器的持久性卷声明策略。支持的策略有: | "per-user" |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| claimSize | 持久性卷声明大小。要更新声明大小,置备它的存储类必须支持调整大小。 | |
| storageClass | 持久性卷声明的存储类。当忽略或留空时,会使用默认存储类。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| claimSize | 持久性卷声明大小。要更新声明大小,置备它的存储类必须支持调整大小。 | |
| storageClass | 持久性卷声明的存储类。当忽略或留空时,会使用默认存储类。 |
| 属性 | 描述 | 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 必须具有 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| openShiftSecurityContextConstraint | 构建容器的 OpenShift 安全性上下文约束。 | "container-build" |
| 属性 | 描述 | 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 相关的配置设置。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| clusterRoles |
分配给 OpenShift Dev Spaces ServiceAccount 的 ClusterRole。默认角色为: - < | |
| debug | 为 OpenShift Dev Spaces 服务器启用调试模式。 | false |
| 部署 | 部署覆盖选项。 | |
| extraProperties |
除了从 | |
| logLevel |
OpenShift Dev Spaces 服务器的日志级别: | "INFO" |
| proxy | Kubernetes 集群的代理服务器设置。OpenShift 集群不需要额外的配置。通过为 OpenShift 集群指定这些设置,您可以覆盖 OpenShift 代理配置。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| credentialsSecretName |
包含代理服务器 | |
| nonProxyHosts |
可以直接访问的主机列表,绕过代理。指定通配符域,使用以下格式 .< | |
| 端口 | 代理服务器端口。 | |
| url |
代理服务器的 URL (protocol+hostname)。仅在需要代理配置时使用。Operator 会考虑 OpenShift 集群范围的代理配置,在自定义资源中定义 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 部署 | 部署覆盖选项。 | |
| disableInternalRegistry | 禁用内部插件 registry。 | |
| externalPluginRegistries | 外部插件 registry。 | |
| openVSXURL | 打开 VSX registry URL。如果省略了嵌入式实例。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| url | 插件 registry 的公共 URL。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 部署 | 部署覆盖选项。 | |
| disableInternalRegistry | 禁用内部 devfile registry。 | |
| externalDevfileRegistries | 外部 devfile registry 服务示例可直接使用 devfile。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| url | 提供示例 ready-to-use devfile 的 devfile registry 的公共 UR。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 部署 | 部署覆盖选项。 | |
| headerMessage | 仪表板标头消息。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 显示 | 指示仪表板显示消息。 | |
| text | 用户仪表板中显示警告消息。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| enable |
安装和配置社区支持的 Kubernetes Image Puller Operator。当您在不提供任何 specs 的情况下将值设为 | |
| spec | Kubernetes Image Puller spec,用于在 CheCluster 中配置镜像拉取程序。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| enable |
为 OpenShift Dev Spaces 服务器端点启用 | true |
| 属性 | 描述 | 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)。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| disableSubdomainIsolation |
禁用子域隔离。弃用使用 | |
| 端点 |
GitHub 服务器端点 URL。弃用使用 | |
| secretName | Kubernetes secret,其中包含 Base64 编码的 GitHub OAuth 客户端 ID 和 GitHub OAuth 客户端 secret。详情请查看以下页面 :https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-github/。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 端点 |
GitLab 服务器端点 URL。弃用使用 | |
| secretName | Kubernetes secret,其中包含 Base64 编码的 GitHub 应用程序 ID 和 GitLab Application Client secret。请参见以下页面 :https://www.eclipse.org/che/docs/stable/administration-guide/configuring-oauth-2-for-gitlab/。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| 端点 |
Bitbucket 服务器端点 URL。弃用使用 | |
| 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/。 |
| 属性 | 描述 | 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 |
| 属性 | 描述 | 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 必须具有 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| gateway | 网关设置。 | { "configLabels": { "app": "che", "component": "che-gateway-config" }} |
| identityProviderURL | 身份提供程序服务器的公共 URL。 | |
| identityToken |
要传递给上游的身份令牌。支持两种令牌: | |
| oAuthAccessTokenInactivityTimeoutSeconds |
在 OpenShift | |
| oAuthAccessTokenMaxAgeSeconds |
在 OpenShift | |
| oAuthClientName |
用于在 OpenShift 端设置身份联合的 OpenShift | |
| oAuthScope | 访问令牌范围。此字段只适用于只为 Kubernetes 进行的 OpenShift Dev Spaces 安装,并为 OpenShift 忽略。 | |
| oAuthSecret |
OpenShift |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| configLabels | 网关配置标签。 | { "app": "che", "component": "che-gateway-config"} |
| 部署 |
部署覆盖选项。由于网关部署由多个容器组成,因此必须以其名称区分它们: - |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| hostname | 从中拉取镜像的替代容器 registry 的可选主机名或 URL。这个值覆盖 OpenShift Dev Spaces 部署中涉及的所有默认容器镜像中定义的容器 registry 主机名。这对在受限环境中安装 OpenShift Dev Spaces 特别有用。 | |
| 机构 | 从中拉取镜像的替代 registry 的可选仓库名称。这个值覆盖 OpenShift Dev Spaces 部署中涉及的所有默认容器镜像中定义的容器 registry 组织。这对在受限环境中安装 OpenShift Dev Spaces 特别有用。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| containers | 属于 pod 的容器列表。 | |
| securityContext | pod 应该使用的安全选项运行。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| env | 要在容器中设置的环境变量列表。 | |
| image | 容器镜像。省略它或将其留空,以使用 Operator 提供的默认容器镜像。 | |
| imagePullPolicy |
镜像拉取策略。对于 | |
| name | 容器名称。 | |
| 资源 | 此容器所需的计算资源。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| limits | 描述允许的最大计算资源量。 | |
| Request | 描述所需的最少计算资源。 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| cpu |
以内核数为单位的 CPU。(500M = .5 个内核)如果没有指定值,则默认值会根据组件进行设置。如果值为 | |
| memory |
内存,以字节为单位。(500Gi = 500GiB = 500114 1024114 1024)如果未指定值,则会根据组件设置默认值。如果值为 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| cpu |
以内核数为单位的 CPU。(500M = .5 个内核)如果没有指定值,则默认值会根据组件进行设置。如果值为 | |
| memory |
内存,以字节为单位。(500Gi = 500GiB = 500114 1024114 1024)如果未指定值,则会根据组件设置默认值。如果值为 |
| 属性 | 描述 | Default(默认) |
|---|---|---|
| fsGroup |
适用于 pod 中所有容器的特殊补充组。默认值为 | |
| runAsUser |
运行容器进程的入口点的 UID。默认值为 |
| 属性 | 描述 | 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.2. 配置项目 复制链接链接已复制到粘贴板!
对于每个用户,OpenShift Dev Spaces 会隔离项目中的工作区。OpenShift Dev Spaces 通过存在标签和注解来识别用户项目。在启动工作区时,如果所需的项目不存在,OpenShift Dev Spaces 会使用模板名称创建项目。
您可以通过以下方法修改 OpenShift Dev Spaces 行为:
3.2.1. 配置项目名称 复制链接链接已复制到粘贴板!
您可以配置 OpenShift Dev Spaces 在启动工作区时用来创建所需项目的项目名称模板。
有效项目名称模板遵循以下约定:
-
<
;username> 或<userid> 占位符是必需的。 -
用户名和 ID 不能包含无效字符。如果用户名或 ID 的格式与 OpenShift 对象的命名约定不兼容,OpenShift Dev Spaces 通过将不兼容的字符替换为
-符号,将用户名或 ID 替换为有效的名称。 -
OpenShift Dev Spaces 将
<userid> 占位符评估为 14 个字符长字符串,并添加随机六个字符长后缀以防止 ID 共处。结果存储在用户首选项中以便重复使用。 - Kubernetes 将项目名称的长度限制为 63 个字符。
- OpenShift 限制的长度为 49 个字符。
流程
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: devEnvironments: defaultNamespace: template: <workspace_namespace_template_>spec: components: devEnvironments: defaultNamespace: template: <workspace_namespace_template_>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 例 3.2. 用户工作区项目名称模板示例
Expand 用户工作区项目名称模板 生成的项目示例 <username>-devspaces(default)user1-devspaces
<userid>-namespacecge1egvsb2nhba-namespace-ul1411<userid>-aka-<username>-namespacecgezegvsb2nhba-aka-user1-namespace-6m2w2b
3.2.2. 预先置备项目 复制链接链接已复制到粘贴板!
您可以提前置备工作区项目,而不是依赖自动置备。对每个用户重复这个过程。
流程
使用以下标签和注解为 <username> 用户创建 <project_name> 项目:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 使用您选择的项目名称。
3.3. 配置服务器组件 复制链接链接已复制到粘贴板!
secret 是存储敏感数据的 OpenShift 对象,例如:
- 用户名
- 密码
- 身份验证令牌
以加密的形式。
用户可以挂载包含敏感数据或 OpenShift Dev Spaces 管理容器中的配置 ConfigMap 的 OpenShift Secret,如下所示:
- 一个文件
- 环境变量
挂载过程使用标准 OpenShift 挂载机制,但它需要额外的注解和标记。
先决条件
- 正在运行的 Red Hat OpenShift Dev Spaces 实例。
流程
在部署了 OpenShift Dev Spaces 的 OpenShift 项目中创建一个新的 OpenShift Secret 或 ConfigMap。要创建的对象标签必须与一组标签匹配:
-
app.kubernetes.io/part-of: che.eclipse.org -
app.kubernetes.io/component: <DEPLOYMENT_NAME>-<OBJECT_KIND> &
lt;DEPLOYMENT_NAME> 对应于以下部署:-
keycloak -
devfile-registry -
plugin-registry devspaces和
-
<OBJECT_KIND> 是:secret或者
-
configmap
-
例 3.3. Example:
或者
注解必须表示,给定的对象挂载为一个文件。
配置注解值:
-
Che.eclipse.org/mount-as: file- 要表示对象作为文件挂载。 -
Che.eclipse.org/mount-path: <TARGET_PATH> - 提供所需的挂载路径。
-
例 3.4. Example:
或者
OpenShift 对象可以包含多个项目,其名称必须与挂载到容器中所需的文件名匹配。
例 3.5. Example:
或者
这会导致名为 ca.crt 的文件挂载到 OpenShift Dev Spaces 容器的 /data 路径上。
要在 OpenShift Dev Spaces 容器中进行更改,请完全重新创建对象。
先决条件
- 正在运行的 Red Hat OpenShift Dev Spaces 实例。
流程
在部署了 OpenShift Dev Spaces 的 OpenShift 项目中创建一个新的 OpenShift Secret 或 ConfigMap。要创建的对象标签必须与一组标签匹配:
-
app.kubernetes.io/part-of: che.eclipse.org -
app.kubernetes.io/component: <DEPLOYMENT_NAME>-<OBJECT_KIND> &
lt;DEPLOYMENT_NAME> 对应于以下部署:-
keycloak -
devfile-registry -
plugin-registry devspaces和
-
<OBJECT_KIND> 是:secret或者
-
configmap
-
例 3.6. Example:
或者
注解必须表示给定对象作为环境变量挂载。
配置注解值:
-
Che.eclipse.org/mount-as: env- 表示对象作为环境变量挂载 -
Che.eclipse.org/env-name : <FOO_ENV> - 提供环境变量名称,这是挂载对象键值所必需的
-
例 3.7. Example:
或者
这会导致两个环境变量:
-
FOO_ENV -
myvalue
被置备到 OpenShift Dev Spaces 容器中。
如果对象提供多个数据项,则必须为每个数据键提供环境变量名称,如下所示:
例 3.8. Example:
或者
这会导致两个环境变量:
-
FOO_ENV -
OTHER_ENV
被置备到 OpenShift Dev Spaces 容器中。
OpenShift 对象中注解名称的最大长度为 63 个字符,其中 9 个字符作为前缀被保留,以 / 结尾。这充当可用于对象的密钥最大长度的限制。
要在 OpenShift Dev Spaces 容器中进行更改,请完全重新创建对象。
3.3.2. Dev Spaces 服务器的高级配置选项 复制链接链接已复制到粘贴板!
以下小节描述了 OpenShift Dev Spaces 服务器组件的高级部署和配置方法。
3.3.2.1. 了解 OpenShift Dev Spaces 服务器高级配置 复制链接链接已复制到粘贴板!
以下小节描述了 OpenShift Dev Spaces 服务器组件高级配置方法。
高级配置需要:
-
添加不是由 Operator 从标准
CheCluster自定义资源字段自动生成环境变量。 -
覆盖 Operator 从标准
CheCluster自定义资源字段自动生成属性。
customCheProperties 字段是 CheCluster 自定义资源 服务器设置 的一部分,包含要应用到 OpenShift Dev Spaces 服务器组件的附加环境变量映射。
例 3.9. 覆盖工作区的默认内存限值
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
OpenShift Dev Spaces Operator 的早期版本有一个名为 custom 的 ConfigMap 来满足此角色。如果 OpenShift Dev Spaces Operator 找到名为 custom 的 configMap,它会将其包含的数据添加到 customCheProperties 字段中,重新部署 OpenShift Dev Spaces,并删除 自定义 configMap。
3.4. 全局配置工作区 复制链接链接已复制到粘贴板!
本节论述了如何全局配置工作区。
3.4.1. 限制用户可以保留的工作区数 复制链接链接已复制到粘贴板!
默认情况下,用户可以在仪表板中保留无限数量的工作区,但您可以限制这个数字来降低集群的需求。
此配置是 CheCluster 自定义资源的一部分:
spec:
devEnvironments:
maxNumberOfWorkspacesPerUser: <kept_workspaces_limit>
spec:
devEnvironments:
maxNumberOfWorkspacesPerUser: <kept_workspaces_limit>
- 1
- 设置每个用户的最大工作区数。默认值
-1允许用户保持无限数量的工作区。使用正整数来设置每个用户的最大工作区数。
流程
获取 OpenShift Dev Spaces 命名空间的名称。默认值为
openshift-devspaces。oc get checluster --all-namespaces \ -o=jsonpath="{.items[*].metadata.namespace}"$ oc get checluster --all-namespaces \ -o=jsonpath="{.items[*].metadata.namespace}"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 配置
maxNumberOfWorkspacesPerUser:oc patch checluster/devspaces -n openshift-devspaces \ --type='merge' -p \ '{"spec":{"devEnvironments":{"maxNumberOfWorkspacesPerUser": <kept_workspaces_limit>}}}'$ oc patch checluster/devspaces -n openshift-devspaces \1 --type='merge' -p \ '{"spec":{"devEnvironments":{"maxNumberOfWorkspacesPerUser": <kept_workspaces_limit>}}}'2 Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.4.2. 允许用户同时运行多个工作区 复制链接链接已复制到粘贴板!
默认情况下,用户一次只能运行一个工作区。您可以允许用户同时运行多个工作区。
如果使用默认存储方法,如果 pod 在多节点集群中的节点间分布,用户可能会在同时运行工作区时遇到问题。从每个用户的 通用 存储策略切换到 每个工作区 存储策略,或 使用临时存储 类型来避免或解决这些问题。
此配置是 CheCluster 自定义资源的一部分:
spec:
devEnvironments:
maxNumberOfRunningWorkspacesPerUser: <running_workspaces_limit>
spec:
devEnvironments:
maxNumberOfRunningWorkspacesPerUser: <running_workspaces_limit>
- 1
- 设置每个用户同时运行的最大工作区数。
-1值允许用户运行无限数量的工作区。默认值为1。
流程
获取 OpenShift Dev Spaces 命名空间的名称。默认值为
openshift-devspaces。oc get checluster --all-namespaces \ -o=jsonpath="{.items[*].metadata.namespace}"$ oc get checluster --all-namespaces \ -o=jsonpath="{.items[*].metadata.namespace}"Copy to Clipboard Copied! Toggle word wrap Toggle overflow 配置
maxNumberOfRunningWorkspacesPerUser:oc patch checluster/devspaces -n openshift-devspaces \ --type='merge' -p \ '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerUser": <running_workspaces_limit>}}}'$ oc patch checluster/devspaces -n openshift-devspaces \1 --type='merge' -p \ '{"spec":{"devEnvironments":{"maxNumberOfRunningWorkspacesPerUser": <running_workspaces_limit>}}}'2 Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.4.3. 带有自签名证书的 Git 复制链接链接已复制到粘贴板!
您可以配置 OpenShift Dev Spaces,以支持对使用自签名证书的 Git 供应商的操作。
先决条件
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 - Git 版本 2 或更高版本
流程
创建一个新的 ConfigMap,其中包含 Git 服务器的详情:
oc create configmap che-git-self-signed-cert \ --from-file=ca.crt=<path_to_certificate> \ --from-literal=githost=<host:port> -n openshift-devspaces
$ oc create configmap che-git-self-signed-cert \ --from-file=ca.crt=<path_to_certificate> \1 --from-literal=githost=<host:port> -n openshift-devspaces2 Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意-
证书文件通常存储为 Base64 ASCII 文件,例如:
.pem,.crt,.ca-bundle.保存证书文件的所有ConfigMap都应该使用 Base64 ASCII 证书,而不是二进制数据证书。 -
需要使用信任链。如果
ca.crt由证书颁发机构(CA)签名,则必须包含在ca.crt文件中。
-
证书文件通常存储为 Base64 ASCII 文件,例如:
在 ConfigMap 中添加所需的标签:
oc label configmap che-git-self-signed-cert \ app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspaces
$ oc label configmap che-git-self-signed-cert \ app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow 配置 OpenShift Dev Spaces 操作对象,以将自签名证书用于 Git 存储库。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。
spec: devEnvironments: trustedCerts: gitTrustedCertsConfigMapName: che-git-self-signed-certspec: devEnvironments: trustedCerts: gitTrustedCertsConfigMapName: che-git-self-signed-certCopy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
创建并启动一个新的工作区。工作区使用的每个容器挂载了一个特殊的卷,其中包含带有自签名证书的文件。容器的
/etc/gitconfig文件包含关于 Git 服务器主机(it URL)和http部分中的证书路径的信息(请参阅有关 git-config的 Git 文档)。例 3.10.
/etc/gitconfig文件的内容[http "https://10.33.177.118:3000"] sslCAInfo = /etc/config/che-git-tls-creds/certificate
[http "https://10.33.177.118:3000"] sslCAInfo = /etc/config/che-git-tls-creds/certificateCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.4.4. 配置工作区 nodeSelector 复制链接链接已复制到粘贴板!
本节论述了如何为 OpenShift Dev Spaces 工作区的 Pod 配置 nodeSelector。
流程
OpenShift Dev Spaces 使用 CHE_WORKSPACE_POD_NODE__SELECTOR 环境变量来配置 nodeSelector。此变量可以包含一组以逗号分隔的 key=value 对来组成 nodeSelector 规则,或 NULL 禁用它。
CHE_WORKSPACE_POD_NODE__SELECTOR=disktype=ssd,cpu=xlarge,[key=value]
CHE_WORKSPACE_POD_NODE__SELECTOR=disktype=ssd,cpu=xlarge,[key=value]
nodeSelector 必须在 OpenShift Dev Spaces 安装过程中配置。这可防止现有工作区因为现有工作区 PVC 和 Pod 调度到不同的区中造成卷关联性冲突而运行。
为了避免 Pod 和 PVC 调度到大型多区的不同区中,请创建额外的 StorageClass 对象(注意 allowedTopologies 字段),这会协调 PVC 创建过程。
通过 CHE_INFRA_KUBERNETES_PVC_STORAGE__CLASS__NAME 环境变量将这个新创建的 StorageClass 的名称传递给 OpenShift Dev Spaces。此变量的默认空值指示 OpenShift Dev Spaces 使用集群的默认 StorageClass。
3.4.5. 打开 VSX registry URL 复制链接链接已复制到粘贴板!
要搜索并安装扩展,Visual Studio Code 编辑器使用嵌入的 Open VSX registry 实例。您还可以将 OpenShift Dev Spaces 配置为使用另一个 Open VSX registry 实例,而不是嵌入的 registry 实例。
流程
在 CheCluster 自定义资源
spec.components.pluginRegistry.openVSXURL字段中设置 Open VSX registry 实例的 URL。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.5. 缓存镜像,以便更快地启动工作区 复制链接链接已复制到粘贴板!
要改进 OpenShift Dev Spaces 工作区的开始时间性能,请使用 Image Puller,它是一个 OpenShift Dev Spaces 无关的组件,可用于为 OpenShift 集群预拉取镜像。Image Puller 是一个额外的 OpenShift 部署,它会创建一个 DaemonSet,它可以在每个节点上预拉取相关的 OpenShift Dev Spaces 工作区镜像。当 OpenShift Dev Spaces 工作区启动时,这些镜像已经可用,从而改进了工作区启动时间。
Image Puller 为配置提供以下参数。
| 参数 | 使用方法 | 默认值 |
|---|---|---|
|
| daemonset 以小时为单位的健康检查间隔 |
|
|
| 运行 puller 时每个缓存的镜像的内存请求。请参阅 第 3.5.2 节 “定义内存设置”。 |
|
|
| 在 puller 运行时每个缓存的镜像的内存限值。请参阅 第 3.5.2 节 “定义内存设置”。 |
|
|
| 拉取程序运行时每个缓存的镜像的处理器请求 |
|
|
| 拉取程序运行时每个缓存的镜像的处理器限制 |
|
|
| 要创建的 DaemonSet 的名称 |
|
|
| 要创建的部署的名称 |
|
|
| 包含要创建的 DaemonSet 的 OpenShift 项目 |
|
|
|
以分号隔离的要拉取镜像的列表,格式为 | |
|
| 应用到 DaemonSet 创建的 pod 的节点选择器 |
|
|
| 应用到 DaemonSet 创建的 pod 的关联性 |
|
|
|
镜像 pull secret 列表,格式为 |
|
其他资源
3.5.1. 定义镜像列表 复制链接链接已复制到粘贴板!
Image Puller 可以预拉取大多数镜像,包括 che-machine-exec 等涂销空间。但是,在 OpenShift 3.11 中预拉取不支持在 Dockerfile 中挂载卷的镜像,如 traefik。
流程
-
进入
https:// <openshift_dev_spaces_fqdn> /plugin-registry/v3/external_images.txtURL 来收集要拉取的相关容器镜像列表。 -
从预拉取(pull)的列表中确定镜像。为了加快工作空间启动时间,请考虑拉取与工作区相关的镜像,如
Universal-developer-image、che-code' 和che-gateway。
3.5.2. 定义内存设置 复制链接链接已复制到粘贴板!
定义内存请求和限值参数,以确保拉取的容器和平台有足够的内存才能运行。
先决条件
流程
-
要定义
CACHING_MEMORY_REQUEST或CACHING_MEMORY_LIMIT的最小值,请考虑运行每个容器镜像所需的内存量。 要为
CACHING_MEMORY_REQUEST或CACHING_MEMORY_LIMIT定义最大值,请考虑分配给集群中 DaemonSet Pod 的总内存:(memory limit) * (number of images) * (number of nodes in the cluster)
(memory limit) * (number of images) * (number of nodes in the cluster)Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在 20 个节点上拉取 5 个镜像,容器内存限值
20Mi需要2000Mi内存。
3.5.3. 使用 Web 控制台在 OpenShift 上安装 Image Puller 复制链接链接已复制到粘贴板!
您可以使用 OpenShift Web 控制台在 OpenShift 上安装社区支持的 Kubernetes Image Puller Operator。
先决条件
- 第 3.5.1 节 “定义镜像列表”
- 第 3.5.2 节 “定义内存设置”.
- 集群管理员的 OpenShift Web 控制台会话。请参阅 访问 Web 控制台。
流程
- 安装社区支持的 Kubernetes Image Puller Operator。请参阅使用 Web 控制台从 OperatorHub 安装。
-
从社区支持的
Kubernetes Image PullerOperator 创建 kubernetes-image-puller KubernetesImagePuller 操作对象。请参阅 从已安装的 Operator 创建应用程序。
3.5.4. 使用 CLI 在 OpenShift 上安装 Image Puller 复制链接链接已复制到粘贴板!
您可以使用 OpenShift oc 管理工具在 OpenShift 上安装 Kubernetes Image Puller。
先决条件
- 第 3.5.1 节 “定义镜像列表”.
- 第 3.5.2 节 “定义内存设置”.
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。
流程
克隆 Image Puller 存储库,并位于包含 OpenShift 模板的目录中:
git clone https://github.com/che-incubator/kubernetes-image-puller cd kubernetes-image-puller/deploy/openshift
$ git clone https://github.com/che-incubator/kubernetes-image-puller $ cd kubernetes-image-puller/deploy/openshiftCopy to Clipboard Copied! Toggle word wrap Toggle overflow 使用以下参数配置
app.yaml、configmap.yaml和serviceaccount.yamlOpenShift 模板:Expand 表 3.37. app.yaml中的 Image Puller OpenShift 模板参数 值 使用方法 默认值 DEPLOYMENT_NAMEConfigMap 中的
DEPLOYMENT_NAME的值kubernetes-image-puller镜像用于
kubernetes-image-puller部署的镜像registry.redhat.io/devspaces/imagepuller-rhel8:3.6IMAGE_TAG要拉取的镜像标签
最新SERVICEACCOUNT_NAME部署创建和使用的 ServiceAccount 的名称
kubernetes-image-pullerExpand 表 3.38. configmap.yaml 中的 Image Puller OpenShift 模板参数 值 使用方法 默认值 CACHING_CPU_LIMITConfigMap 中的
CACHING_CPU_LIMIT的值.2CACHING_CPU_REQUESTConfigMap 中的
CACHING_CPU_REQUEST的值.05CACHING_INTERVAL_HOURSConfigMap 中的
CACHING_INTERVAL_HOURS的值"1"CACHING_MEMORY_LIMITConfigMap 中的
CACHING_MEMORY_LIMIT的值"20Mi"CACHING_MEMORY_REQUESTConfigMap 中的
CACHING_MEMORY_REQUEST的值"10Mi"DAEMONSET_NAMEConfigMap 中的
DAEMONSET_NAME的值kubernetes-image-pullerDEPLOYMENT_NAMEConfigMap 中的
DEPLOYMENT_NAME的值kubernetes-image-pullerIMAGESConfigMap 中的
IMAGES的值"undefined"NAMESPACEConfigMap 中的
NAMESPACE值k8s-image-pullerNODE_SELECTORConfigMap 中的
NODE_SELECTOR的值"{}"Expand 表 3.39. serviceaccount.yaml 中的 Image Puller OpenShift 模板参数 值 使用方法 默认值 SERVICEACCOUNT_NAME部署创建和使用的 ServiceAccount 的名称
kubernetes-image-puller创建一个 OpenShift 项目来托管 Image Puller:
oc new-project <k8s-image-puller>
$ oc new-project <k8s-image-puller>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 处理并应用模板来安装 puller:
oc process -f serviceaccount.yaml | oc apply -f - oc process -f configmap.yaml | oc apply -f - oc process -f app.yaml | oc apply -f -
$ oc process -f serviceaccount.yaml | oc apply -f - $ oc process -f configmap.yaml | oc apply -f - $ oc process -f app.yaml | oc apply -f -Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
验证 < kubernetes-image-puller> 部署和 < kubernetes-image-puller> DaemonSet 是否存在。DaemonSet 需要为集群中的每个节点有一个 Pod:
oc get deployment,daemonset,pod --namespace <k8s-image-puller>
$ oc get deployment,daemonset,pod --namespace <k8s-image-puller>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 验证 < kubernetes-image-puller >
ConfigMap的值。oc get configmap <kubernetes-image-puller> --output yaml
$ oc get configmap <kubernetes-image-puller> --output yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6. 配置可观察性 复制链接链接已复制到粘贴板!
要配置 OpenShift Dev Spaces 观察功能,请参阅:
3.6.1. Woopra 遥测插件 复制链接链接已复制到粘贴板!
Woopra Telemetry 插件是 一个插件,用于将遥测从 Red Hat OpenShift Dev Spaces 安装发送到 Segment 和 Woopra。此插件 由红帽托管的 Eclipse Che 使用,但任何 Red Hat OpenShift Dev Spaces 部署都可以利用这个插件。除了有效 Woopra 域和 Segment Write 密钥外,没有依赖项。插件的 devfile v2 ,plugin.yaml,有四个可传递给插件的环境变量:
-
WOOPRA_DOMAIN- 要发送事件的 Woopra 域。 -
SEGMENT_WRITE_KEY- 将事件发送到 Segment 和 Woopra 的写键。 -
WOOPRA_DOMAIN_ENDPOINT- 如果您想要直接传递 Woopra 域,则插件将从返回 Woopra 域的 HTTP 端点中获取。 -
SEGMENT_WRITE_KEY_ENDPOINT- 如果您想要直接传递 Segment 写密钥,则插件将从返回 Segment 写密钥的 HTTP 端点中获取它。
在 Red Hat OpenShift Dev Spaces 安装中启用 Woopra 插件:
流程
使用正确设置的环境变量,将
plugin.yamldevfile v2 文件部署到 HTTP 服务器中。配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2. 创建遥测插件 复制链接链接已复制到粘贴板!
本节介绍如何创建扩展 AbstractAnalyticsManager 并实现以下方法的 AnalyticsManager 类:
-
isEnabled ()- 确定遥测后端是否正常工作。这可能意味着,始终返回true,或者有更复杂的检查,例如当缺少连接属性时返回false。 -
destroy ()- 关闭遥测后端前运行的清理方法。此方法发送WORKSPACE_STOPPED事件。 -
onActivity ()- 通知给定用户仍然发生一些活动。这主要用于发送WORKSPACE_INACTIVE事件。 -
onEvent ()- 将遥测事件提交到遥测服务器,如WORKSPACE_USED或WORKSPACE_STARTED。 -
increaseDuration ()- 增加当前事件的持续时间,而不是在小时间内发送多个事件。
以下部分涵盖了:
- 创建遥测服务器,将事件回显到标准输出。
- 扩展 OpenShift Dev Spaces 遥测客户端并实施用户的自定义后端。
-
创建一个
plugin.yaml文件,代表自定义后端的 Dev Workspace 插件。 -
通过设置
CheCluster自定义资源中的workspacesDefaultPlugins属性,指定自定义插件到 OpenShift Dev Spaces 的位置。
3.6.2.1. 开始使用 复制链接链接已复制到粘贴板!
本文档描述了扩展 OpenShift Dev Spaces 遥测系统以与自定义后端通信所需的步骤:
- 创建接收事件的服务器进程
- 扩展 OpenShift Dev Spaces 库,以创建将事件发送到服务器的后端
- 在容器中打包遥测后端并将其部署到镜像 registry
- 为您的后端添加插件,并指示 OpenShift Dev Spaces 加载 Dev Workspaces 中的插件
此处 提供了遥测后端的完整示例。
创建接收事件的服务器
出于演示目的,本例演示了如何创建从遥测插件接收事件的服务器并将其写入标准输出。
对于生产环境用例,请考虑与第三方遥测系统(例如,Segment、Woopra)集成,而不是创建自己的遥测服务器。在这种情况下,使用供应商的 API 将事件从自定义后端发送到其系统。
以下 Go 代码在端口 8080 上启动一个服务器,并将事件写入标准输出:
例 3.11. main.go
基于此代码创建容器镜像,并将其公开为 openshift-devspaces 项目中的 OpenShift 中部署。示例遥测服务器的代码位于 telemetry-server-example 中。要部署遥测服务器,请克隆存储库并构建容器:
git clone https://github.com/che-incubator/telemetry-server-example cd telemetry-server-example podman build -t registry/organization/telemetry-server-example:latest . podman push registry/organization/telemetry-server-example:latest
$ git clone https://github.com/che-incubator/telemetry-server-example
$ cd telemetry-server-example
$ podman build -t registry/organization/telemetry-server-example:latest .
$ podman push registry/organization/telemetry-server-example:latest
manifest_with_ingress.yaml 和 manifest_with_route 都包含 Deployment 和 Service 的定义。前者还定义了 Kubernetes Ingress,后者则定义一个 OpenShift 路由。
在清单文件中,替换 image 和 host 字段以匹配您推送的镜像和 OpenShift 集群的公共主机名。然后运行:
kubectl apply -f manifest_with_[ingress|route].yaml -n openshift-devspaces
$ kubectl apply -f manifest_with_[ingress|route].yaml -n openshift-devspaces
3.6.2.2. 创建后端项目 复制链接链接已复制到粘贴板!
为了在开发时快速反馈,建议在 Dev Workspace 内进行开发。这样,您可以在集群中运行应用程序,并从前端 telemetry 插件接收事件。
Maven Quarkus 项目构建:
mvn io.quarkus:quarkus-maven-plugin:2.7.1.Final:create \ -DprojectGroupId=mygroup -DprojectArtifactId=devworkspace-telemetry-example-plugin \ -DprojectVersion=1.0.0-SNAPSHOTmvn io.quarkus:quarkus-maven-plugin:2.7.1.Final:create \ -DprojectGroupId=mygroup -DprojectArtifactId=devworkspace-telemetry-example-plugin \ -DprojectVersion=1.0.0-SNAPSHOTCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
删除
src/main/java/mygroup和src/test/java/mygroup下的文件。 -
有关
backend-base的最新版本,请参阅 GitHub 软件包。 在
pom.xml中添加以下依赖项:例 3.12.
pom.xmlCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
创建一个具有
read:packages权限的个人访问令牌,以便从 GitHub 软件包下载org.eclipse.che.incubator.workspace-telemetry:backend-base依赖项。 在
~/.m2/settings.xml文件中添加 GitHub 用户名、个人访问令牌和che-incubator存储库详情:例 3.13.
settings.xmlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.3. 创建 AnalyticsManager 的聚合实施并添加专用逻辑 复制链接链接已复制到粘贴板!
在 src/main/java/mygroup 下,在项目中创建两个文件:
-
MainConfiguration.java- 包含提供给AnalyticsManager的配置。 -
AnalyticsManager.java- 包含特定于遥测系统的逻辑。
例 3.14. MainConfiguration.java
- 1
- MicroProfile 配置注解用于注入
welcome.message配置。
有关如何设置特定于您的后端的配置属性的更多详细信息,请参阅 Quarkus 配置参考指南。
例 3.15. AnalyticsManager.java
由于 org.my.group.AnalyticsManager 和 org.my.group.MainConfiguration 是替代 Bean,因此使用 src/main/resources/application.properties 中的 quarkus.arc.selected-alternatives 属性来指定它们。
例 3.16. application.properties
quarkus.arc.selected-alternatives=MainConfiguration,AnalyticsManager
quarkus.arc.selected-alternatives=MainConfiguration,AnalyticsManager
3.6.2.4. 在 Dev Workspace 中运行应用程序 复制链接链接已复制到粘贴板!
在 Dev Workspace 中设置
DEVWORKSPACE_TELEMETRY_BACKEND_PORT环境变量。此处,值设为4167。Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 从 Red Hat OpenShift Dev Spaces 仪表板中重启 Dev Workspace。
在 Dev Workspace 的终端窗口中运行以下命令以启动应用程序。使用
--settings标志指定包含 GitHub 访问令牌的settings.xml文件的位置的路径。mvn --settings=settings.xml quarkus:dev -Dquarkus.http.port=${DEVWORKSPACE_TELEMETRY_BACKEND_PORT}$ mvn --settings=settings.xml quarkus:dev -Dquarkus.http.port=${DEVWORKSPACE_TELEMETRY_BACKEND_PORT}Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用程序现在通过前端插件的端口
4167接收遥测事件。
验证步骤
验证以下输出是否已记录:
INFO [org.ecl.che.inc.AnalyticsManager] (Quarkus Main Thread) No welcome message provided INFO [io.quarkus] (Quarkus Main Thread) devworkspace-telemetry-example-plugin 1.0.0-SNAPSHOT on JVM (powered by Quarkus 2.7.2.Final) started in 0.323s. Listening on: http://localhost:4167 INFO [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated. INFO [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, kubernetes-client, rest-client, rest-client-jackson, resteasy, resteasy-jsonb, smallrye-context-propagation, smallrye-openapi, swagger-ui, vertx]
INFO [org.ecl.che.inc.AnalyticsManager] (Quarkus Main Thread) No welcome message provided INFO [io.quarkus] (Quarkus Main Thread) devworkspace-telemetry-example-plugin 1.0.0-SNAPSHOT on JVM (powered by Quarkus 2.7.2.Final) started in 0.323s. Listening on: http://localhost:4167 INFO [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated. INFO [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, kubernetes-client, rest-client, rest-client-jackson, resteasy, resteasy-jsonb, smallrye-context-propagation, smallrye-openapi, swagger-ui, vertx]Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要验证
AnalyticsManager的onEvent ()方法是否从前端插件接收事件,请按 l 键来禁用 Quarkus 实时编码并编辑 IDE 中的任何文件。应记录以下输出:INFO [io.qua.dep.dev.RuntimeUpdatesProcessor] (Aesh InputStream Reader) Live reload disabled INFO [org.ecl.che.inc.AnalyticsManager] (executor-thread-2) The received event is: Edit Workspace File in Che
INFO [io.qua.dep.dev.RuntimeUpdatesProcessor] (Aesh InputStream Reader) Live reload disabled INFO [org.ecl.che.inc.AnalyticsManager] (executor-thread-2) The received event is: Edit Workspace File in CheCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.5. 实现 isEnabled () 复制链接链接已复制到粘贴板!
在本示例中,每当调用时,此方法始终返回 true。
例 3.17. AnalyticsManager.java
@Override
public boolean isEnabled() {
return true;
}
@Override
public boolean isEnabled() {
return true;
}
可以在 isEnabled () 中放入更复杂的逻辑。例如,托管的 OpenShift Dev Spaces Woopra 后端 会在确定是否启用了后端前检查配置属性是否存在。
3.6.2.6. 在Event ()的实现 复制链接链接已复制到粘贴板!
onEvent () 将后端收到的事件发送到遥测系统。对于示例应用,它会将 HTTP POST 有效负载发送到来自遥测服务器的 /event 端点。
3.6.2.6.1. 向示例 telemetry 服务器发送 POST 请求 复制链接链接已复制到粘贴板!
在以下示例中,遥测服务器应用通过以下 URL 部署到 OpenShift :http://little-telemetry-server-che.apps-crc.testing,其中 apps-crc.testing 是 OpenShift 集群的入口域名。
通过创建
TelemetryService.java来设置 RESTEasy REST 客户端例 3.18.
TelemetryService.javaCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 发出请求
的端点。
在
src/main/resources/application.properties文件中指定TelemetryService的基本 URL:例 3.19.
application.propertiesorg.my.group.TelemetryService/mp-rest/url=http://little-telemetry-server-che.apps-crc.testing
org.my.group.TelemetryService/mp-rest/url=http://little-telemetry-server-che.apps-crc.testingCopy to Clipboard Copied! Toggle word wrap Toggle overflow 将
TelemetryService注入AnalyticsManager,并在onEvent ()中发送POST请求例 3.20.
AnalyticsManager.javaCopy to Clipboard Copied! Toggle word wrap Toggle overflow 这会向遥测服务器发送 HTTP 请求,并在少量时间内自动延迟相同的事件。默认持续时间为 1500 毫秒。
3.6.2.7. 实现 增加Duration () 复制链接链接已复制到粘贴板!
许多遥测系统可识别事件持续时间。AbstractAnalyticsManager 合并同一时间间发生的类似事件。这种 increaseDuration () 实现是一个 no-op。此方法使用用户遥测供应商的 API 更改事件或事件属性,以反映事件的增加持续时间。
例 3.21. AnalyticsManager.java
@Override
public void increaseDuration(AnalyticsEvent event, Map<String, Object> properties) {}
@Override
public void increaseDuration(AnalyticsEvent event, Map<String, Object> properties) {}
3.6.2.8. 实现 onActivity () 复制链接链接已复制到粘贴板!
设置不活跃超时限制,并使用 onActivity () 来发送 WORKSPACE_INACTIVE 事件(如果最后一次事件时间超过超时)。
例 3.22. AnalyticsManager.java
3.6.2.9. 实现 destroy () 复制链接链接已复制到粘贴板!
调用 destroy () 时,发送 WORKSPACE_STOPPED 事件并关闭任何资源,如连接池。
例 3.23. AnalyticsManager.java
@Override
public void destroy() {
onEvent(WORKSPACE_STOPPED, lastOwnerId, lastIp, lastUserAgent, lastResolution, commonProperties);
}
@Override
public void destroy() {
onEvent(WORKSPACE_STOPPED, lastOwnerId, lastIp, lastUserAgent, lastResolution, commonProperties);
}
运行 mvn quarkus:dev,如 第 3.6.2.4 节 “在 Dev Workspace 中运行应用程序” 所述,并使用 Ctrl+C 终止应用程序,将 WORKSPACE_STOPPED 事件发送到服务器。
3.6.2.10. 打包 Quarkus 应用程序 复制链接链接已复制到粘贴板!
如需了解在容器中打包应用程序的最佳说明,请参阅 Quarkus 文档。构建容器并将其推送到您选择的容器 registry。
3.6.2.10.1. 用于构建使用 JVM 运行的 Quarkus 镜像的 Dockerfile 示例 复制链接链接已复制到粘贴板!
例 3.24. Dockerfile.jvm
要构建镜像,请运行:
mvn package && \ podman build -f src/main/docker/Dockerfile.jvm -t image:tag .
mvn package && \
podman build -f src/main/docker/Dockerfile.jvm -t image:tag .
3.6.2.10.2. 用于构建 Quarkus 原生镜像的 Dockerfile 示例 复制链接链接已复制到粘贴板!
例 3.25. Dockerfile.native
要构建镜像,请运行:
mvn package -Pnative -Dquarkus.native.container-build=true && \ podman build -f src/main/docker/Dockerfile.native -t image:tag .
mvn package -Pnative -Dquarkus.native.container-build=true && \
podman build -f src/main/docker/Dockerfile.native -t image:tag .
3.6.2.11. 为您的插件创建 plugin.yaml 复制链接链接已复制到粘贴板!
创建一个 plugin.yaml devfile v2 文件,该文件代表 Dev Workspace 插件,该插件在 Dev Workspace Pod 中运行自定义后端。有关 devfile v2 的更多信息,请参阅 Devfile v2 文档
例 3.26. plugin.yaml
- 1
- 指定从 第 3.6.2.10 节 “打包 Quarkus 应用程序” 构建的容器镜像。
- 2
- 为来自 Example 4 的
welcome.message可选配置属性设置值。
通常,用户会将此文件部署到公司 Web 服务器。本指南介绍了如何在 OpenShift 中创建 Apache Web 服务器,并在其中托管插件。
创建引用新 plugin.yaml 文件的 ConfigMap 对象。
oc create configmap --from-file=plugin.yaml -n openshift-devspaces telemetry-plugin-yaml
$ oc create configmap --from-file=plugin.yaml -n openshift-devspaces telemetry-plugin-yaml
创建部署、服务和路由来公开 Web 服务器。部署引用此 ConfigMap 对象并将其放置在 /var/www/html 目录中。
例 3.27. manifest.yaml
oc apply -f manifest.yaml
$ oc apply -f manifest.yaml
验证步骤
部署启动后,确认 web 服务器中的
plugin.yaml可用:curl apache-che.apps-crc.testing/plugin.yaml
$ curl apache-che.apps-crc.testing/plugin.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.12. 在 Dev Workspace 中指定 telemetry 插件 复制链接链接已复制到粘贴板!
在现有 Dev Workspace 的
components字段中添加以下内容:components: ... - name: telemetry-plugin plugin: uri: http://apache-che.apps-crc.testing/plugin.yamlcomponents: ... - name: telemetry-plugin plugin: uri: http://apache-che.apps-crc.testing/plugin.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 从 OpenShift Dev Spaces 仪表板启动 Dev Workspace。
验证步骤
验证遥测插件容器是否在 Dev Workspace pod 中运行。在这里,这可以通过检查编辑器中的 Workspace 视图进行验证。
- 编辑编辑器中的文件,并在示例遥测服务器日志中观察其事件。
3.6.2.13. 为所有 Dev Workspaces 应用 telemetry 插件 复制链接链接已复制到粘贴板!
将 telemetry 插件设置为默认插件。在 Dev Workspace 启动时,针对新的和现有的 Dev Workspaces 应用默认插件。
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
- 从 Red Hat OpenShift Dev Spaces 仪表板中启动一个新的或现有的 Dev Workspace。
- 按照 第 3.6.2.12 节 “在 Dev Workspace 中指定 telemetry 插件” 的验证步骤,验证遥测插件是否正常工作。
3.6.2.14. 配置服务器日志记录 复制链接链接已复制到粘贴板!
可以微调 OpenShift Dev Spaces 服务器中可用的单个日志记录器的日志级别。
整个 OpenShift Dev Spaces 服务器的日志级别使用 Operator 的 cheLogLevel 配置属性进行全局配置。请参阅 第 3.1.3 节 “CheCluster 自定义资源字段参考”。要在不是由 Operator 管理的安装中设置全局日志级别,请在 che ConfigMap 中指定 CHE_LOG_LEVEL 环境变量。
可以使用 CHE_LOGGER_CONFIG 环境变量在 OpenShift Dev Spaces 服务器中配置单个日志记录器的日志级别。
3.6.2.14.1. 配置日志级别 复制链接链接已复制到粘贴板!
流程
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "<key1=value1,key2=value2>"spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "<key1=value1,key2=value2>"1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 以逗号分隔的键值对列表,其中 key 是日志记录器的名称,如 OpenShift Dev Spaces 服务器日志输出中所示,值是所需的日志级别。
例 3.28. 为
WorkspaceManager配置调试模式spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "org.eclipse.che.api.workspace.server.WorkspaceManager=DEBUG"spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "org.eclipse.che.api.workspace.server.WorkspaceManager=DEBUG"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.14.2. 日志记录器命名 复制链接链接已复制到粘贴板!
日志记录器的名称遵循使用这些日志记录器的内部服务器类的类名称。
3.6.2.14.3. 日志记录 HTTP 流量 复制链接链接已复制到粘贴板!
流程
要记录 OpenShift Dev Spaces 服务器和 Kubernetes 或 OpenShift 集群的 API 服务器之间的 HTTP 流量,请配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "che.infra.request-logging=TRACE"spec: components: cheServer: extraProperties: CHE_LOGGER_CONFIG: "che.infra.request-logging=TRACE"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.2.15. 使用 dsc 收集日志 复制链接链接已复制到粘贴板!
Red Hat OpenShift Dev Spaces 的安装由 OpenShift 集群中运行的几个容器组成。虽然可以从每个正在运行的容器手动收集日志,但 dsc 提供了可自动化该进程的命令。
以下命令可使用 dsc 工具从 OpenShift 集群收集 Red Hat OpenShift Dev Spaces 日志:
dsc server:logs收集现有的 Red Hat OpenShift Dev Spaces 服务器日志,并将其存储在本地机器的目录中。默认情况下,日志下载到计算机上的临时目录中。但是,这可以通过指定
-d参数来覆盖。例如,要将 OpenShift Dev Spaces 日志下载到/home/user/che-logs/目录中,请使用 命令dsc server:logs -d /home/user/che-logs/
dsc server:logs -d /home/user/che-logs/Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在运行时,
dsc server:logs会在指定存储日志文件的目录在控制台中打印一条消息:Red Hat OpenShift Dev Spaces logs will be available in '/tmp/chectl-logs/1648575098344'
Red Hat OpenShift Dev Spaces logs will be available in '/tmp/chectl-logs/1648575098344'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 如果在非默认项目中安装了 Red Hat OpenShift Dev Spaces,
dsc server:logs需要-n <NAMESPACE> paremeter,其中 <NAMESPACE> 是安装 Red Hat OpenShift Dev Spaces 的 OpenShift 项目。例如,若要从my-namespace项目中的 OpenShift Dev Spaces 获取日志,请使用该命令dsc server:logs -n my-namespace
dsc server:logs -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow dsc server:deploy-
使用
dsc安装时,OpenShift Dev Spaces 安装过程中会自动收集日志。与dsc server:logs一样,可以使用-d参数指定目录日志。
其他资源
- "DS 参考文档"
3.6.3. 监控 Dev Workspace Operator 复制链接链接已复制到粘贴板!
您可以配置 OpenShift in-cluster 监控堆栈,以提取 Dev Workspace Operator 公开的指标。
3.6.3.1. 收集 Dev Workspace Operator 指标 复制链接链接已复制到粘贴板!
使用 in-cluster Prometheus 实例来收集、存储和查询 Dev Workspace Operator 的指标:
先决条件
- OpenShift Dev Spaces 的机构实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 -
devworkspace-controller-metrics服务在端口8443上公开指标。默认情况下,这是预先配置的。
流程
为检测 Dev Workspace Operator 指标服务创建 ServiceMonitor。
允许集群内 Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认 OpenShift Dev Spaces 命名空间为
openshift-devspaces。oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
$ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
- 对于 OpenShift Dev Spaces 的新安装,请通过从 Dashboard 创建 OpenShift Dev Spaces 工作区来生成指标。
- 在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe → Metrics。
运行 PromQL 查询以确认指标可用。例如,输入
devworkspace_started_total并点 Run query。如需了解更多指标,请参阅 第 3.6.3.2 节 “特定于 dev Workspace 的指标”。
要排除缺失的指标,请查看 Prometheus 容器日志以了解可能的与 RBAC 相关的错误:
获取 Prometheus pod 的名称:
oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'$ oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 从上一步中的 Prometheus pod 输出 Prometheus 容器日志的最后 20 行:
oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
$ oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoringCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.6.3.2. 特定于 dev Workspace 的指标 复制链接链接已复制到粘贴板!
下表描述了 devworkspace-controller-metrics 服务公开的 Dev Workspace 特定指标。
| Name | 类型 | 描述 | 标签 |
|---|---|---|---|
|
| 计数 | Dev Workspace 启动事件的数量。 |
|
|
| 计数 |
Dev Workspaces 数量成功进入 |
|
|
| 计数 | 失败的 Dev Workspaces 数量。 |
|
|
| Histogram | 启动 Dev Workspace 所需的时间(以秒为单位)。 |
|
| Name | 描述 | 值 |
|---|---|---|
|
|
Dev Workspace 的 |
|
|
|
Dev Workspace 的 |
|
|
| 工作区启动失败的原因。 |
|
| Name | 描述 |
|---|---|
|
| 启动失败,因为 devfile 用于创建 Dev Workspace。 |
|
|
因为以下错误,启动失败: |
|
| 未知故障原因。 |
配置 in-cluster Prometheus 实例以收集 Dev Workspace Operator 指标后,您可以在 OpenShift Web 控制台的 Administrator 视角中查看自定义仪表板的指标。
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 集群内 Prometheus 实例正在收集指标。请参阅 第 3.6.3.1 节 “收集 Dev Workspace Operator 指标”。
流程
在
openshift-config-managed项目中为仪表板定义创建 ConfigMap,并应用必要的标签。oc create configmap grafana-dashboard-dwo \ --from-literal=dwo-dashboard.json="$(curl https://raw.githubusercontent.com/devfile/devworkspace-operator/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
$ oc create configmap grafana-dashboard-dwo \ --from-literal=dwo-dashboard.json="$(curl https://raw.githubusercontent.com/devfile/devworkspace-operator/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意上一命令包含来自上游社区的材料的链接。本材料代表了最新的可用内容,以及最新的最佳实践。这些提示尚未被红帽的 QE 部门利用,并且尚未由广泛的用户组证明。请小心使用此信息。
oc label configmap grafana-dashboard-dwo console.openshift.io/dashboard=true -n openshift-config-managed
$ oc label configmap grafana-dashboard-dwo console.openshift.io/dashboard=true -n openshift-config-managedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意仪表板定义基于 Grafana 6.x 仪表板。并非所有 Grafana 6.x 仪表板功能在 OpenShift Web 控制台中都被支持。
验证步骤
- 在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe → Dashboards。
- 进入 Dashboard → Che Server JVM,并验证仪表板面板是否包含数据。
3.6.3.4. Dev Workspace Operator 的仪表板 复制链接链接已复制到粘贴板!
OpenShift Web 控制台自定义仪表板基于 Grafana 6.x,并显示 Dev Workspace Operator 中的以下指标。
不是 Grafana 6.x 仪表板的所有功能都作为 OpenShift Web 控制台仪表板被支持。
3.6.3.4.1. dev Workspace 指标 复制链接链接已复制到粘贴板!
Dev Workspace Metrics 面板中显示特定于 Dev Workspace 的指标。
图 3.1. Dev Workspace Metrics 面板
- 平均工作空间开始时间
- 平均工作区启动持续时间。
- 工作区启动
- 成功和失败的工作区启动数量。
- dev Workspace 成功和失败
- 成功和失败的 Dev Workspace 启动之间的比较。
- dev Workspace 失败率
- 失败的工作区启动数量和工作区启动总数之间的比率。
- dev Workspace 启动失败原因
显示工作空间启动失败的重复图表:
-
BadRequest -
InfrastructureFailure -
Unknown
-
3.6.3.4.2. Operator 指标 复制链接链接已复制到粘贴板!
Operator Metrics 面板中会显示特定于 Operator 的指标。
图 3.2. Operator Metrics 面板
- flight 中的 Webhook
- 不同 Webhook 请求数量之间的比较。
- 工作队列深度
- 工作队列中的协调请求数。
- memory
- Dev Workspace 控制器和 Dev Workspace Webhook 服务器的内存用量。
- 每秒平均协调计数(DWO)
- Dev Workspace 控制器的平均每秒协调计数数。
3.6.4. 监控 Dev Spaces 服务器 复制链接链接已复制到粘贴板!
您可以配置 OpenShift Dev Spaces 以公开 OpenShift Dev Spaces 服务器的 JVM 内存和类加载。
3.6.4.1. 启用和公开 OpenShift Dev Spaces 服务器指标 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 在 che-host 服务的端口 8087 上公开 JVM 指标。您可以配置此行为。
流程
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: components: metrics: enable: <boolean>spec: components: metrics: enable: <boolean>1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
true启用,false为 disable。
3.6.4.2. 使用 Prometheus 收集 OpenShift Dev Spaces 服务器指标 复制链接链接已复制到粘贴板!
使用 in-cluster Prometheus 实例为 OpenShift Dev Spaces Server 收集、存储和查询 JVM 指标:
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 -
OpenShift Dev Spaces 在端口
8087上公开指标。请参阅启用和公开 OpenShift Dev Spaces 服务器 JVM 指标。
流程
创建 ServiceMonitor 以检测 OpenShift Dev Spaces JVM 指标服务。
创建 Role 和 RoleBinding,以允许 Prometheus 查看指标。
例 3.31. 角色
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- OpenShift Dev Spaces 命名空间。默认值为
openshift-devspaces。
例 3.32. RoleBinding
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- OpenShift Dev Spaces 命名空间。默认值为
openshift-devspaces。
允许集群内 Prometheus 实例检测 OpenShift Dev Spaces 命名空间中的 ServiceMonitor。默认 OpenShift Dev Spaces 命名空间为
openshift-devspaces。oc label namespace openshift-devspaces openshift.io/cluster-monitoring=true
$ oc label namespace openshift-devspaces openshift.io/cluster-monitoring=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
- 在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe → Metrics。
-
运行 PromQL 查询以确认指标可用。例如,输入
process_uptime_seconds{job="che-host"}并点 Run query。
要排除缺失的指标,请查看 Prometheus 容器日志以了解可能的与 RBAC 相关的错误:
获取 Prometheus pod 的名称:
oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'$ oc get pods -l app.kubernetes.io/name=prometheus -n openshift-monitoring -o=jsonpath='{.items[*].metadata.name}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 从上一步中的 Prometheus pod 输出 Prometheus 容器日志的最后 20 行:
oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoring
$ oc logs --tail=20 <prometheus_pod_name> -c prometheus -n openshift-monitoringCopy to Clipboard Copied! Toggle word wrap Toggle overflow
配置 in-cluster Prometheus 实例以收集 OpenShift Dev Spaces Server JVM 指标后,您可以在 OpenShift Web 控制台的 Administrator 视角中查看自定义仪表板的指标。
先决条件
- 您的机构 OpenShift Dev Spaces 实例已安装并在 Red Hat OpenShift 中运行。
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 集群内 Prometheus 实例正在收集指标。请参阅 第 3.6.4.2 节 “使用 Prometheus 收集 OpenShift Dev Spaces 服务器指标”。
流程
在
openshift-config-managed项目中为仪表板定义创建 ConfigMap,并应用必要的标签。oc create configmap grafana-dashboard-devspaces-server \ --from-literal=devspaces-server-dashboard.json="$(curl https://raw.githubusercontent.com/eclipse-che/che-server/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managed
$ oc create configmap grafana-dashboard-devspaces-server \ --from-literal=devspaces-server-dashboard.json="$(curl https://raw.githubusercontent.com/eclipse-che/che-server/main/docs/grafana/openshift-console-dashboard.json)" \ -n openshift-config-managedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意上一命令包含来自上游社区的材料的链接。本材料代表了最新的可用内容,以及最新的最佳实践。这些提示尚未被红帽的 QE 部门利用,并且尚未由广泛的用户组证明。请小心使用此信息。
oc label configmap grafana-dashboard-devspaces-server console.openshift.io/dashboard=true -n openshift-config-managed
$ oc label configmap grafana-dashboard-devspaces-server console.openshift.io/dashboard=true -n openshift-config-managedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意仪表板定义基于 Grafana 6.x 仪表板。并非所有 Grafana 6.x 仪表板功能在 OpenShift Web 控制台中都被支持。
验证步骤
- 在 OpenShift Web 控制台的 Administrator 视图中,进入 Observe → Dashboards。
进入 Dashboard → Dev Workspace Operator,并验证仪表板面板是否包含数据。
图 3.3. 快速事实
图 3.4. JVM 内存
图 3.5. JVM Misc
图 3.6. JVM 内存池(堆)
图 3.7. JVM 内存池(Non-Heap)
图 3.8. 垃圾回收
图 3.9. 类加载
图 3.10. 缓冲池
3.7. 配置网络 复制链接链接已复制到粘贴板!
3.7.1. 配置网络策略 复制链接链接已复制到粘贴板!
默认情况下,OpenShift 集群中的所有 Pod 都可以相互通信,即使它们位于不同的命名空间中。在 OpenShift Dev Spaces 中,这使得一个用户项目中的工作区 Pod 能够将流量发送到其他用户项目中的另一个工作区 Pod。
为安全起见,可以使用 NetworkPolicy 对象配置多租户隔离,以限制用户项目中 Pod 的所有传入的通信。但是,OpenShift Dev Spaces 项目中的 Pod 必须能够与用户项目中的 Pod 通信。
先决条件
- OpenShift 集群具有网络限制,如多租户隔离。
流程
将
allow-from-openshift-devspacesNetworkPolicy 应用到每个用户项目。allow-from-openshift-devspacesNetworkPolicy 允许从 OpenShift Dev Spaces 命名空间中的传入流量到用户项目中的所有 Pod。例 3.33.
allow-from-openshift-devspaces.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.7.2. 配置 Dev Spaces 主机名 复制链接链接已复制到粘贴板!
这个步骤描述了如何将 OpenShift Dev Spaces 配置为使用自定义主机名。
先决条件
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 生成证书和私钥文件。
要生成私钥和证书的对,必须将相同的证书颁发机构(CA)用于其他 OpenShift Dev Spaces 主机。
请求 DNS 供应商将自定义主机名指向集群入口。
流程
为 OpenShift Dev Spaces 预先创建项目:
oc create project openshift-devspaces
$ oc create project openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow 创建 TLS secret:
oc create secret TLS <tls_secret_name> \ --key <key_file> \ --cert <cert_file> \ -n openshift-devspaces
$ oc create secret TLS <tls_secret_name> \1 --key <key_file> \2 --cert <cert_file> \3 -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow 将所需的标签添加到 secret 中:
oc label secret <tls_secret_name> \ app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspaces
$ oc label secret <tls_secret_name> \1 app.kubernetes.io/part-of=che.eclipse.org -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- TLS secret 名称
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: networking: hostname: <hostname> tlsSecretName: <secret>spec: networking: hostname: <hostname>1 tlsSecretName: <secret>2 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 如果已经部署了 OpenShift Dev Spaces,请等待所有 OpenShift Dev Spaces 组件的推出完成。
3.7.3. 将不受信任的 TLS 证书导入到 Dev Spaces 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 组件与外部服务通信使用 TLS 加密。它们需要由可信证书颁发机构(CA)签名的 TLS 证书。因此,您必须导入到 OpenShift Dev Spaces 所有不受信任的 CA 链,供外部服务使用,例如:
- 代理
- 身份提供程序(OIDC)
- 源代码存储库供应商(Git)
OpenShift Dev Spaces 在 OpenShift Dev Spaces 项目中使用标记的配置映射作为 TLS 证书的源。配置映射可以具有任意数量的密钥,每个密钥都有随机数量的证书。
当 OpenShift 集群包含通过 cluster- wide-proxy 配置 添加的集群范围可信 CA 证书时,OpenShift Dev Spaces Operator 会检测到它们,并使用 config.openshift.io/inject-trusted-cabundle="true" 标签自动将它们注入配置映射中。根据此注解,OpenShift 会自动注入配置映射的 ca-bundle.crt 键中的集群范围可信 CA 证书。
先决条件
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 -
openshift-devspaces项目存在。 -
对于要导入的每个 CA 链:root CA 和中间证书( PEM 格式),采用
ca-cert-for-devspaces- <count>.pem文件。
流程
将要导入的所有 CA 链 PEM 文件连接到
custom-ca-certificates.pem文件中,并删除与 Java 信任存储不兼容的返回字符。cat ca-cert-for-{prod-id-short}-*.pem | tr -d '\r' > custom-ca-certificates.pem$ cat ca-cert-for-{prod-id-short}-*.pem | tr -d '\r' > custom-ca-certificates.pemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 使用所需的 TLS 证书创建
custom-ca-certificates配置映射:oc create configmap custom-ca-certificates \ --from-file=custom-ca-certificates.pem \ --namespace=openshift-devspaces$ oc create configmap custom-ca-certificates \ --from-file=custom-ca-certificates.pem \ --namespace=openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow 标记
custom-ca-certificates配置映射:oc label configmap custom-ca-certificates \ app.kubernetes.io/component=ca-bundle \ app.kubernetes.io/part-of=che.eclipse.org \ --namespace=openshift-devspaces$ oc label configmap custom-ca-certificates \ app.kubernetes.io/component=ca-bundle \ app.kubernetes.io/part-of=che.eclipse.org \ --namespace=openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 如果 OpenShift Dev Spaces 之前尚未部署,则部署 OpenShift Dev Spaces。否则,请等待 OpenShift Dev Spaces 组件推出。
- 重启正在运行的工作区以使更改生效。
验证步骤
验证配置映射是否包含您的自定义 CA 证书。这个命令以 PEM 格式返回您的自定义 CA 证书:
oc get configmap \ --namespace=openshift-devspaces \ --output='jsonpath={.items[0:].data.custom-ca-certificates\.pem}' \ --selector=app.kubernetes.io/component=ca-bundle,app.kubernetes.io/part-of=che.eclipse.org$ oc get configmap \ --namespace=openshift-devspaces \ --output='jsonpath={.items[0:].data.custom-ca-certificates\.pem}' \ --selector=app.kubernetes.io/component=ca-bundle,app.kubernetes.io/part-of=che.eclipse.orgCopy to Clipboard Copied! Toggle word wrap Toggle overflow 验证 OpenShift Dev Spaces pod 包含挂载
ca-certs-merged配置映射的卷:oc get pod \ --selector=app.kubernetes.io/component=devspaces \ --output='jsonpath={.items[0].spec.volumes[0:].configMap.name}' \ --namespace=openshift-devspaces \ | grep ca-certs-merged$ oc get pod \ --selector=app.kubernetes.io/component=devspaces \ --output='jsonpath={.items[0].spec.volumes[0:].configMap.name}' \ --namespace=openshift-devspaces \ | grep ca-certs-mergedCopy to Clipboard Copied! Toggle word wrap Toggle overflow 验证 OpenShift Dev Spaces 服务器容器是否具有您的自定义 CA 证书。这个命令以 PEM 格式返回您的自定义 CA 证书:
oc exec -t deploy/devspaces \ --namespace=openshift-devspaces \ -- cat /public-certs/custom-ca-certificates.pem$ oc exec -t deploy/devspaces \ --namespace=openshift-devspaces \ -- cat /public-certs/custom-ca-certificates.pemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 在 OpenShift Dev Spaces 服务器日志中验证导入的证书计数是否不是 null :
oc logs deploy/devspaces --namespace=openshift-devspaces \ | grep custom-ca-certificates.pem$ oc logs deploy/devspaces --namespace=openshift-devspaces \ | grep custom-ca-certificates.pemCopy to Clipboard Copied! Toggle word wrap Toggle overflow 列出证书的 SHA256 指纹:
for certificate in ca-cert*.pem ; do openssl x509 -in $certificate -digest -sha256 -fingerprint -noout | cut -d= -f2; done
$ for certificate in ca-cert*.pem ; do openssl x509 -in $certificate -digest -sha256 -fingerprint -noout | cut -d= -f2; doneCopy to Clipboard Copied! Toggle word wrap Toggle overflow 验证 OpenShift Dev Spaces 服务器 Java 信任存储是否包含具有相同指纹的证书:
oc exec -t deploy/devspaces --namespace=openshift-devspaces -- \ keytool -list -keystore /home/user/cacerts \ | grep --after-context=1 custom-ca-certificates.pem$ oc exec -t deploy/devspaces --namespace=openshift-devspaces -- \ keytool -list -keystore /home/user/cacerts \ | grep --after-context=1 custom-ca-certificates.pemCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 启动工作区,获取在其中创建它的项目名称: < workspace_namespace& gt;,并等待工作区启动。
验证
che-trusted-ca-certs配置映射是否包含您的自定义 CA 证书。这个命令以 PEM 格式返回您的自定义 CA 证书:oc get configmap che-trusted-ca-certs \ --namespace=<workspace_namespace> \ --output='jsonpath={.data.custom-ca-certificates\.custom-ca-certificates\.pem}'$ oc get configmap che-trusted-ca-certs \ --namespace=<workspace_namespace> \ --output='jsonpath={.data.custom-ca-certificates\.custom-ca-certificates\.pem}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 验证工作区 pod 是否挂载
che-trusted-ca-certs配置映射:oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].spec.volumes[0:].configMap.name}' \ | grep che-trusted-ca-certs$ oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].spec.volumes[0:].configMap.name}' \ | grep che-trusted-ca-certsCopy to Clipboard Copied! Toggle word wrap Toggle overflow 验证 generic
-developer-image容器(或工作区 devfile 中定义的容器)是否挂载che-trusted-ca-certs卷:oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].spec.containers[0:]}' \ | jq 'select (.volumeMounts[].name == "che-trusted-ca-certs") | .name'$ oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].spec.containers[0:]}' \ | jq 'select (.volumeMounts[].name == "che-trusted-ca-certs") | .name'Copy to Clipboard Copied! Toggle word wrap Toggle overflow 获取工作区 pod 名称 < workspace_pod_name>:
oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].metadata.name}' \$ oc get pod \ --namespace=<workspace_namespace> \ --selector='controller.devfile.io/devworkspace_name=<workspace_name>' \ --output='jsonpath={.items[0:].metadata.name}' \Copy to Clipboard Copied! Toggle word wrap Toggle overflow 验证工作区容器是否具有自定义 CA 证书。这个命令以 PEM 格式返回您的自定义 CA 证书:
oc exec <workspace_pod_name> \ --namespace=<workspace_namespace> \ -- cat /public-certs/custom-ca-certificates.custom-ca-certificates.pem$ oc exec <workspace_pod_name> \ --namespace=<workspace_namespace> \ -- cat /public-certs/custom-ca-certificates.custom-ca-certificates.pemCopy to Clipboard Copied! Toggle word wrap Toggle overflow
其他资源
3.7.4. 配置 OpenShift 路由 复制链接链接已复制到粘贴板!
如果您的机构需要,您可以配置 OpenShift Route 标签和注解。
先决条件
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。 - 在 OpenShift 中运行的一个 OpenShift Dev Spaces 实例。
流程
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: networking: labels: <labels> annotations: <annotations>spec: networking: labels: <labels>1 annotations: <annotations>2 Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.7.5. 配置 OpenShift 路由 复制链接链接已复制到粘贴板!
您可以为 OpenShift 路由配置标签、注解和域,以用于 路由器分片。
先决条件
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 -
DSM.请参阅: 第 1.2 节 “安装 dsc 管理工具”。
流程
配置
CheCluster自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。spec: networking: labels: <labels> domain: <domain> annotations: <annotations>spec: networking: labels: <labels>1 domain: <domain>2 annotations: <annotations>3 Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.8. 配置存储 复制链接链接已复制到粘贴板!
OpenShift Dev Spaces 不支持网络文件系统(NFS)协议。
3.8.1. 使用存储类安装 Dev Spaces 复制链接链接已复制到粘贴板!
要将 OpenShift Dev Spaces 配置为使用配置的基础架构存储,请使用存储类安装 OpenShift Dev Spaces。当用户想要绑定非默认置备程序提供的持久性卷时,这特别有用。为此,用户可以为 OpenShift Dev Spaces 数据保存并设置该存储的参数。这些参数可决定以下内容:
- 特殊的主机路径
- 存储容量
- 卷 mod
- 挂载选项
- 文件系统
- 访问模式
- 存储类型
- 以及许多其他
OpenShift Dev Spaces 有一个组件,需要持久性卷来存储数据:OpenShift Dev Spaces 工作区。OpenShift Dev Spaces 工作区使用卷(如 /projects 卷)存储源代码。
只有工作区不是临时时,OpenShift Dev Spaces 工作区源代码存储在持久性卷中。
持久性卷声明事实:
- OpenShift Dev Spaces 不会在基础架构中创建持久性卷。
- OpenShift Dev Spaces 使用持久性卷声明(PVC)来挂载持久性卷。
OpenShift Dev Spaces 服务器创建持久性卷声明。
用户在 OpenShift Dev Spaces 配置中定义存储类名称,以使用 OpenShift Dev Spaces PVC 中的存储类功能。使用存储类时,用户使用额外的存储参数以灵活的方式配置基础架构存储。您还可以使用类名称将静态置备的持久性卷绑定到 OpenShift Dev Spaces PVC。
流程
使用 CheCluster 自定义资源定义来定义存储类:
定义存储类名称:配置
CheCluster自定义资源,并安装 OpenShift Dev Spaces。请参阅 第 3.1.1 节 “在安装过程中使用 dsc 配置CheCluster自定义资源”。Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在
che-workspace-pv.yaml文件中为 OpenShift Dev Spaces 工作区定义持久性卷:che-workspace-pv.yamlfileCopy to Clipboard Copied! Toggle word wrap Toggle overflow 绑定持久性卷:
kubectl apply -f che-workspace-pv.yaml
$ kubectl apply -f che-workspace-pv.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
您必须为卷提供有效的文件权限。您可以使用存储类配置或手动进行此操作。要手动定义权限,请定义 storageClass#mountOptions uid 和 gid。
3.9. 管理身份和授权 复制链接链接已复制到粘贴板!
本节论述了管理 Red Hat OpenShift Dev Spaces 的身份和授权的不同方面。
3.9.1. 为 Git 供应商配置 OAuth 复制链接链接已复制到粘贴板!
您可以在 OpenShift Dev Spaces 和 Git 供应商之间配置 OAuth,允许用户使用远程 Git 存储库:
3.9.1.1. 为 GitHub 配置 OAuth 2.0 复制链接链接已复制到粘贴板!
允许用户使用 GitHub 上托管的远程 Git 存储库:
- 设置 GitHub OAuth 应用程序(OAuth 2.0)。
- 应用 GitHub OAuth App Secret。
3.9.1.1.1. 设置 GitHub OAuth 应用程序 复制链接链接已复制到粘贴板!
使用 OAuth 2.0 设置 GitHub OAuth 应用程序。
先决条件
- 已登陆到 GitHub。
-
base64安装在您正在使用的操作系统中。
流程
- 进入 https://github.com/settings/applications/new。
输入以下值:
-
应用程序名称 :
OpenShift Dev Spaces -
Homepage URL:
https://<openshift_dev_spaces_fqdn>/ -
授权回调 URL :
https:// <openshift_dev_spaces_fqdn> /api/oauth/callback
-
应用程序名称 :
- 点击 Register application。
- 点 Generate new client secret。
复制 GitHub OAuth 客户端 ID,并将其编码到 Base64 中,以便在应用 GitHub OAuth App Secret 时要使用的:
echo -n '<github_oauth_client_id>' | base64
$ echo -n '<github_oauth_client_id>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 复制 GitHub OAuth 客户端 Secret,并将其编码到 Base64 中,以便在应用 GitHub OAuth App Secret 时要使用的:
echo -n '<github_oauth_client_secret>' | base64
$ echo -n '<github_oauth_client_secret>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.9.1.1.2. 应用 GitHub OAuth 应用程序 Secret 复制链接链接已复制到粘贴板!
准备并应用 GitHub OAuth App Secret。
先决条件
- 设置 GitHub OAuth 应用程序已完成。
准备好设置 GitHub OAuth App 时生成的 Base64 编码值:
- GitHub OAuth Client ID
- GitHub OAuth 客户端 Secret
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- OpenShift Dev Spaces 命名空间。默认值为
openshift-devspaces。 - 2
- 这取决于您的机构正在使用的 GitHub 产品: 在 GitHub.com 或 GitHub Enterprise Cloud 上托管存储库时,忽略这一行或输入默认的
https://github.com。在 GitHub Enterprise 服务器上托管存储库时,请输入 GitHub Enterprise Server URL。 - 3
- 这一行仅用于 GitHub Enterprise Server。要禁用子域隔离,请将其设置为
"true"。要启用子域隔离,请将其设置为"false"。 - 4
- Base64 编码的 GitHub OAuth 客户端 ID。
- 5
- Base64 编码的 GitHub OAuth 客户端机密。
应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.1.2. 为 GitLab 配置 OAuth 2.0 复制链接链接已复制到粘贴板!
允许用户使用 GitLab 实例托管的远程 Git 存储库:
- 设置 GitLab 授权应用(OAuth 2.0)。
- 应用 GitLab 授权应用程序 Secret。
3.9.1.2.1. 设置 GitLab 授权应用程序 复制链接链接已复制到粘贴板!
使用 OAuth 2.0 设置 GitLab 授权应用程序。
先决条件
- 已登陆到 GitLab。
-
base64安装在您正在使用的操作系统中。
流程
- 点您的 avatar,再进入 → 。
- 输入 OpenShift Dev Spaces 作为 Name。
-
输入
https://<openshift_dev_spaces_fqdn> /api/oauth/callback作为 Redirect URI。 - 选中 Confidential 和 Expire 访问令牌 复选框。
-
在 Scopes 下,选中
api、write_repository和openid复选框。 - 点 Save application。
复制 GitLab 应用程序 ID,并将其编码到 Base64 中,以便在应用 GitLab-authorized 应用程序 Secret 时要使用的:
echo -n '<gitlab_application_id>' | base64
$ echo -n '<gitlab_application_id>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 复制 GitLab 客户端 Secret,并将其编码到 Base64 中,以便在应用 GitLab-authorized 应用程序 Secret 时要使用的:
echo -n '<gitlab_client_secret>' | base64
$ echo -n '<gitlab_client_secret>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow
其他资源
3.9.1.2.2. 应用 GitLab-authorized 应用程序 Secret 复制链接链接已复制到粘贴板!
准备并应用 GitLab-authorized 应用程序 Secret。
先决条件
- 设置 GitLab 授权应用程序已完成。
准备好在设置 GitLab 授权应用程序时生成的 Base64 编码值:
- GitLab 应用程序 ID
- GitLab Client Secret
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.1.3. 为 Bitbucket 服务器配置 OAuth 2.0 复制链接链接已复制到粘贴板!
您可以使用 OAuth 2.0 来允许用户处理托管在 Bitbucket 服务器上的远程 Git 存储库:
- 在 Bitbucket 服务器上设置 OAuth 2.0 应用链接。
- 为 Bitbucket 服务器应用应用链接 Secret。
3.9.1.3.1. 在 Bitbucket 服务器上设置 OAuth 2.0 应用程序链接 复制链接链接已复制到粘贴板!
在 Bitbucket 服务器上设置 OAuth 2.0 应用链接。
先决条件
- 您已登录到 Bitbucket 服务器。
-
base64安装在您正在使用的操作系统中。
流程
- 进入 Administration > Applications > Application 链接。
- 选择 Create link。
- 选择 External application 和 Incoming。
-
在 Redirect URL 字段中输入
https:// <openshift_dev_spaces_fqdn> /api/oauth/callback。 - 在应用程序 权限 中选择 Admin - Write 复选框。
- 点击 Save。
复制 客户端 ID,并将其编码到 Base64 以在应用 Bitbucket 应用程序链接 Secret 时要使用的:
echo -n '<Bitbucket_Client_ID>' | base64
$ echo -n '<Bitbucket_Client_ID>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 复制 客户端 secret,并将其编码到 Base64 以在应用 Bitbucket 应用程序链接 Secret 时要使用的:
echo -n '<Bitbucket_Client_secret>' | base64
$ echo -n '<Bitbucket_Client_secret>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow
其他资源
3.9.1.3.2. 为 Bitbucket 服务器应用 OAuth 2.0 应用程序链接 Secret 复制链接链接已复制到粘贴板!
为 Bitbucket 服务器准备并应用 OAuth 2.0 应用链接 Secret。
先决条件
- 应用程序链接已在 Bitbucket 服务器上设置。
准备好在设置 Bitbucket 应用程序链接时生成以 Base64 编码的值:
- Bitbucket 客户端 ID
- Bitbucket 客户端 secret
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.1.4. 为 Bitbucket 云配置 OAuth 2.0 复制链接链接已复制到粘贴板!
您可以允许用户使用托管在 Bitbucket 云中的远程 Git 存储库:
- 在 Bitbucket 云中设置 OAuth 使用者(OAuth 2.0)。
- 为 Bitbucket 云应用 OAuth 使用者 Secret。
3.9.1.4.1. 在 Bitbucket 云中设置 OAuth 使用者 复制链接链接已复制到粘贴板!
在 Bitbucket 云中为 OAuth 2.0 设置 OAuth 使用者。
先决条件
- 您已登录到 Bitbucket 云。
-
base64安装在您正在使用的操作系统中。
流程
- 点您的 avatar,再进入 All workspaces 页面。
- 选择一个工作区并点它。
- 前往 → → 。
- 输入 OpenShift Dev Spaces 作为 Name。
-
输入
https://<openshift_dev_spaces_fqdn> /api/oauth/callback作为 Callback URL。 - 在 Permissions 下,选中所有 帐户 和存储库 复选框,然后单击 Save。
展开添加的消费者,然后复制 Key 值并将其编码为 Base64,以便在应用 Bitbucket OAuth 消费者 Secret 时使用:
echo -n '<bitbucket_oauth_consumer_key>' | base64
$ echo -n '<bitbucket_oauth_consumer_key>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 复制 Secret 值并将其以 Base64 进行编码,以便在应用 Bitbucket OAuth 消费者 Secret 时使用:
echo -n '<bitbucket_oauth_consumer_secret>' | base64
$ echo -n '<bitbucket_oauth_consumer_secret>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.9.1.4.2. 为 Bitbucket 云应用 OAuth 使用者 Secret 复制链接链接已复制到粘贴板!
为 Bitbucket 云准备并应用 OAuth 使用者机密。
先决条件
- OAuth 使用者在 Bitbucket 云中设置。
准备好在设置 Bitbucket OAuth 使用者时生成的 Base64 编码值:
- Bitbucket OAuth 使用者密钥
- Bitbucket OAuth 使用者 Secret
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.1.5. 为 Bitbucket 服务器配置 OAuth 1.0 复制链接链接已复制到粘贴板!
允许用户使用在 Bitbucket 服务器上托管的远程 Git 存储库:
- 在 Bitbucket 服务器上设置应用链接(OAuth 1.0)。
- 为 Bitbucket 服务器应用应用链接 Secret。
3.9.1.5.1. 在 Bitbucket 服务器上设置应用程序链接 复制链接链接已复制到粘贴板!
在 Bitbucket 服务器上为 OAuth 1.0 设置应用链接。
流程
在命令行中运行命令,为后续步骤创建必要的文件,并在应用应用程序链接 Secret 时使用:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 前往 → 。
-
在 URL 字段中输入
https:// <openshift_dev_spaces_fqdn> /,点 Create new link。 - 在提供的 Application URL 下, 选中 Use this URL 复选框,然后单击 Continue。
- 输入 OpenShift Dev Spaces 作为 Application Name。
- 选择 Generic Application 作为 Application Type。
- 输入 OpenShift Dev Spaces 作为 Service Provider Name。
-
将
bitbucket-consumer-key文件的内容粘贴为 Consumer 密钥。 -
将
bitbucket-shared-secret文件的内容粘贴为 Shared secret。 -
输入
<bitbucket_server_url> /plugins/servlet/oauth/request-token作为 Request Token URL。 -
输入
<bitbucket_server_url>/plugins/servlet/oauth/access-token作为 Access token URL。 -
输入
<bitbucket_server_url> /plugins/servlet/oauth/authorize作为 Authorize URL。 - 选中 Create incoming link 复选框,再点 Continue。
-
将
bitbucket-consumer-key文件的内容粘贴为 Consumer Key。 - 输入 OpenShift Dev Spaces 作为 Consumer 名称。
-
将
public-stripped.pub文件的内容粘贴为 公钥,然后单击 Continue。
3.9.1.5.2. 为 Bitbucket 服务器应用应用程序链接 Secret 复制链接链接已复制到粘贴板!
为 Bitbucket 服务器准备并应用应用链接 Secret。
先决条件
- 应用程序链接已在 Bitbucket 服务器上设置。
准备在设置应用程序链接时创建的以下文件:
-
privatepkcs8-stripped.pem -
bitbucket-consumer-key -
bitbucket-shared-secret
-
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
将
bitbucket-consumer-key文件的内容编码为 Base64 :echo -n '<bitbucket-consumer-key file content>' | base64
$ echo -n '<bitbucket-consumer-key file content>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
bitbucket-shared-secret文件的内容编码为 Base64 :echo -n '<bitbucket-shared-secret file content>' | base64
$ echo -n '<bitbucket-shared-secret file content>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow 准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.1.6. 为 Microsoft Azure DevOps 服务配置 OAuth 2.0 复制链接链接已复制到粘贴板!
用户可以使用托管在 Microsoft Azure Repo 上的远程 Git 存储库:
- 设置 Microsoft Azure DevOps 服务 OAuth 应用程序(OAuth 2.0)。
- 应用 Microsoft Azure DevOps Services OAuth App Secret。
3.9.1.6.1. 设置 Microsoft Azure DevOps 服务 OAuth 应用程序 复制链接链接已复制到粘贴板!
使用 OAuth 2.0 设置 Microsoft Azure DevOps 服务 OAuth 应用程序。
先决条件
- 您已登录到 Microsoft Azure DevOps Services。
- 第三方应用程序可以通过 OAuth 访问机构中的资源。请参阅管理安全和应用程序访问策略。
-
base64安装在您正在使用的操作系统中。
流程
- Visit https://app.vsaex.visualstudio.com/app/register/.
输入以下值:
-
公司名称 :
OpenShift Dev Spaces -
应用程序名称 :
OpenShift Dev Spaces -
应用程序网站 :
https:// <openshift_dev_spaces_fqdn>/ -
授权回调 URL :
https:// <openshift_dev_spaces_fqdn> /api/oauth/callback
-
公司名称 :
- 在 Select Authorized ranges 中,选择 Code (读取和写入)。
- 点 Create application。
复制 App ID,并将其编码到 Base64 中,以便在应用 Microsoft Azure DevOps Services OAuth App Secret 时使用:
echo -n '<microsoft_azure_devops_services_oauth_app_id>' | base64
$ echo -n '<microsoft_azure_devops_services_oauth_app_id>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 单击 Show 以显示 客户端 Secret。
复制 客户端 Secret,并将其编码到 Base64 中,以便在应用 Microsoft Azure DevOps Services OAuth App Secret 时使用:
echo -n '<microsoft_azure_devops_services_oauth_client_secret>' | base64
$ echo -n '<microsoft_azure_devops_services_oauth_client_secret>' | base64Copy to Clipboard Copied! Toggle word wrap Toggle overflow
准备并应用 Microsoft Azure DevOps Services Secret。
先决条件
- 设置 Microsoft Azure DevOps 服务 OAuth 应用程序已完成。
准备好在设置 Microsoft Azure DevOps Services OAuth App 时生成以 Base64 编码的值:
- 应用程序 ID
- Client Secret
-
一个活跃的
oc会话,它具有到目标 OpenShift 集群的管理权限。请参阅开始使用 CLI。
流程
准备 Secret:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 应用 Secret:
oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOF
$ oc apply -f - <<EOF <Secret_prepared_in_the_previous_step> EOFCopy to Clipboard Copied! Toggle word wrap Toggle overflow - 验证在 Secret 是否已创建的输出中。
3.9.2. 删除用户数据以遵守 GDPR 复制链接链接已复制到粘贴板!
您可以删除 OpenShift Container Platform 上用户的数据,以符合实施个人正确个人数据的通用 数据保护恢复(GDPR)。其他 Kubernetes 基础架构的过程可能会有所不同。按照用于 Red Hat OpenShift Dev Spaces 安装的供应商的用户管理最佳实践操作。
按如下所示删除用户数据是不可逆的!所有删除的数据都会被删除并无法恢复!
先决条件
-
具有 OpenShift Container Platform 集群的管理权限的活动
oc会话。请参阅开始使用 OpenShift CLI。
流程
使用以下命令列出 OpenShift 集群中的所有用户:
oc get users
$ oc get usersCopy to Clipboard Copied! Toggle word wrap Toggle overflow 删除用户条目:
重要如果用户有任何相关资源(如项目、角色或服务帐户),请在删除用户前首先删除这些资源。
oc delete user <username>
$ oc delete user <username>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
第 4 章 管理 IDE 扩展 复制链接链接已复制到粘贴板!
IDE 使用扩展或插件来扩展其功能,管理扩展的机制因 IDE 而异。
4.1. Microsoft Visual Studio Code 的扩展 - 开源 复制链接链接已复制到粘贴板!
要管理扩展,这个 IDE 使用以下 Open VSX registry 实例之一:
-
在 OpenShift Dev Spaces 的
plugin-registrypod 中运行 Open VSX registry 的嵌入式实例,以支持 air-gapped、off 和 proxy-restricted 环境。嵌入式 Open VSX registry 仅包含 open-vsx.org 上发布的扩展子集。此子集 可自定义。 - 通过互联网访问的公共 open-vsx.org 注册表。
- 单机 Open VSX registry 实例,部署到可从 OpenShift Dev Spaces 工作区 pod 访问的网络中。
默认为 Open VSX 注册表的嵌入式实例。
4.1.1. 选择 Open VSX registry 实例 复制链接链接已复制到粘贴板!
默认为 Open VSX 注册表的嵌入式实例。
如果默认的 Open VSX registry 实例不是您需要的,您可以选择以下实例之一:
-
https://open-vsx.org上的 Open VSX registry 实例需要访问互联网。 - 单机 Open VSX registry 实例,部署到可从 OpenShift Dev Spaces 工作区 pod 访问的网络中。
流程
编辑
CheCluster自定义资源中的openVSXURL值:spec: components: pluginRegistry: openVSXURL: "<url_of_an_open_vsx_registry_instance>"spec: components: pluginRegistry: openVSXURL: "<url_of_an_open_vsx_registry_instance>"1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 例如:
openVSXURL: "https://open-vsx.org"。
提示-
要在
plugin-registrypod 中选择嵌入的 Open VSX registry 实例,请使用openVSXURL: ''。您可以自定义包含的扩展列表。 -
如果可从您的机构集群中的 URL 访问其 URL,则您还可以将
openVSXURL指向独立 Open VSX registry 实例的 URL,而不是被代理阻止。
4.1.2. 在嵌入式 Open VSX registry 实例中添加或删除扩展 复制链接链接已复制到粘贴板!
您可以在嵌入式 Open VSX registry 实例中添加或删除扩展。这将生成可在您组织的工作区中使用的 Open VSX 注册表的自定义构建。
要在 OpenShift Dev Spaces 更新后获取最新的安全修复,请根据最新的标签或 SHA 重建容器。
流程
获取每个所选扩展名的发布者和扩展名称:
- 在 Open VSX registry 网站 中找到扩展,并复制扩展列表页面的 URL。
从复制的 URL 中提取 <publisher > 和名称 <extension> :
https://www.open-vsx.org/extension/<publisher>/<extension>
https://www.open-vsx.org/extension/<publisher>/<extension>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 提示如果扩展仅可用于 Microsoft Visual Studio Marketplace,但不适用于 Open VSX,您可以要求扩展发布发布者根据以下 说明在 open-vsx.org 上发布它,并可能使用此 GitHub 操作。
如果扩展发布者不可用或不希望将扩展发布到 open-vsx.org,且没有与扩展相对应的 Open VSX,考虑使用向 Open VSX 团队报告问题。
- 下载或分叉并克隆 插件 registry 存储库。
对于需要添加或删除的每个扩展,请编辑
openvsx-sync.json文件 :-
要添加扩展,请在
openvsx-sync.json文件中添加发布程序和扩展名称。 -
要删除扩展,请从
openvsx-sync.json文件中删除发布程序和扩展名称。 使用以下 JSON 语法:
{ "id": "<publisher>.<extension>" }{ "id": "<publisher>.<extension>" }Copy to Clipboard Copied! Toggle word wrap Toggle overflow 提示-
open-vsx.org 上的最新扩展版本是默认值。或者,您可以在新
行中添加 "<extension_version>version": " " 以指定版本。 如果您有一个 down-source 扩展或只为机构中内部使用开发的扩展,您可以使用自定义插件 registry 容器可访问的 URL 直接从
.vsix文件添加扩展:{ "id": "<publisher>.<extension>", "download": "<url_to_download_vsix_file>", "version": "<extension_version>" }{ "id": "<publisher>.<extension>", "download": "<url_to_download_vsix_file>", "version": "<extension_version>" }Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 在使用其资源前,请阅读 Microsoft Visual Studio Marketplace 的 使用条款。
-
open-vsx.org 上的最新扩展版本是默认值。或者,您可以在新
-
要添加扩展,请在
构建插件 registry 容器镜像并将其发布到类似 quay.io 的容器 registry:
./build.sh -o <username> -r quay.io -t custom
$ ./build.sh -o <username> -r quay.io -t customCopy to Clipboard Copied! Toggle word wrap Toggle overflow podman push quay.io/<username/plugin_registry:custom>
$ podman push quay.io/<username/plugin_registry:custom>Copy to Clipboard Copied! Toggle word wrap Toggle overflow
编辑您机构集群中的
CheCluster自定义资源以指向镜像(例如在 quay.io上),并保存更改:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证
-
检查
plugin-registrypod 是否已重启并正在运行。 - 重启工作区,并在工作区 IDE 的 Extensions 视图中检查可用的扩展。
第 5 章 使用 Dev Spaces 服务器 API 复制链接链接已复制到粘贴板!
要管理 OpenShift Dev Spaces 服务器工作负载,请使用 Swagger Web 用户界面浏览 OpenShift Dev Spaces 服务器 API。
流程
-
进入 Swagger API web 用户界面:
https:// <openshift_dev_spaces_fqdn> /swagger。
其他资源
第 6 章 升级 Dev Spaces 复制链接链接已复制到粘贴板!
本章论述了如何从 CodeReady Workspaces 3.1 升级到 OpenShift Dev Spaces 3.6。
6.1. 升级 chectl 管理工具 复制链接链接已复制到粘贴板!
这部分论述了如何升级 dsc 管理工具。
6.2. 指定更新批准策略 复制链接链接已复制到粘贴板!
Red Hat OpenShift Dev Spaces Operator 支持两个升级策略:
自动- Operator 会在有新更新可用时安装新的更新。
Manual(手动)- 在开始安装前,需要手动批准新的更新。
您可以使用 OpenShift Web 控制台为 Red Hat OpenShift Dev Spaces Operator 指定更新批准策略。
先决条件
- 集群管理员的 OpenShift Web 控制台会话。请参阅 访问 Web 控制台。
- 通过使用红帽生态系统目录安装的 OpenShift Dev Spaces 实例。
流程
- 在 OpenShift Web 控制台中,导航到 → 。
- 在安装的 Operator 列表中点 Red Hat OpenShift Dev Spaces。
- 进入 Subscription 选项卡。
-
将 更新批准策略配置为
Automatic或Manual。
其他资源
6.3. 使用 OpenShift Web 控制台升级 Dev Spaces 复制链接链接已复制到粘贴板!
您可以使用 OpenShift Web 控制台中的红帽生态系统目录中的 Red Hat OpenShift Dev Spaces Operator 从较早的次版本手动批准升级。
先决条件
- 集群管理员的 OpenShift Web 控制台会话。请参阅 访问 Web 控制台。
- 通过使用红帽生态系统目录安装的 OpenShift Dev Spaces 实例。
-
订阅的批准策略是
Manual。请参阅 第 6.2 节 “指定更新批准策略”。
流程
- 手动批准待处理的 Red Hat OpenShift Dev Spaces Operator 升级。请参阅 手动批准待处理的 Operator 升级。
验证步骤
- 进入 OpenShift Dev Spaces 实例。
- 3.6 版本号在页面的底部可见。
其他资源
6.4. 使用 CLI 管理工具升级 Dev Spaces 复制链接链接已复制到粘贴板!
本节描述了如何使用 CLI 管理工具从以前的次版本升级。
先决条件
- OpenShift 上的管理帐户。
-
一个以前的 CodeReady Workspaces 次要版本的实例,使用
openshift-devspacesOpenShift 项目的同一 OpenShift 实例上的 CLI 管理工具安装。 -
用于OpenShift Dev Spaces 版本 3.6 的DS。请参阅: 第 1.2 节 “安装 dsc 管理工具”。
流程
- 保存更改并将其推送到所有正在运行的 CodeReady Workspaces 3.1 工作区的 Git 存储库。
- 关闭 CodeReady Workspaces 3.1 实例中的所有工作区。
升级 OpenShift Dev Spaces:
dsc server:update -n openshift-devspaces
$ dsc server:update -n openshift-devspacesCopy to Clipboard Copied! Toggle word wrap Toggle overflow 注意对于较慢的系统或互联网连接,请添加
--k8spodwaittimeout=1800000标志选项,将 Pod 超时周期扩展到 1800000 ms 或更长时间。
验证步骤
- 进入 OpenShift Dev Spaces 实例。
- 3.6 版本号在页面的底部可见。
6.5. 在受限环境中升级 Dev Spaces 复制链接链接已复制到粘贴板!
本节论述了如何在受限环境中使用 CLI 管理工具升级 Red Hat OpenShift Dev Spaces 并执行次版本更新。
先决条件
-
OpenShift Dev Spaces 实例使用
openshift-devspaces项目中的dsc --installer operator方法在 OpenShift 上安装。请参阅 第 2.3 节 “在受限环境中安装 Dev Spaces”。
- OpenShift 集群至少有 64 GB 磁盘空间。
- OpenShift 集群已准备好在受限网络中运行,OpenShift control plane 可访问公共互联网。请参阅有关断开连接的安装镜像,并 在受限网络中使用 Operator Lifecycle Manager。
-
具有 OpenShift 集群的管理权限的活跃的
oc会话。请参阅开始使用 OpenShift CLI。 -
一个有效的
oc registry会话,指向registry.redhat.io红帽生态系统目录。请参阅: Red Hat Container Registry 身份验证。
-
opm.请参阅安装opmCLI。 -
jq.请参阅 下载jq。 -
Podman.请参阅 Podman 安装说明。 -
一个活跃的
skopeo会话,它具有对 < my_registry> registry 的管理访问权限。请参阅安装 Skopeo 、授权到 registry 和为断开连接的安装镜像镜像。 -
用于OpenShift Dev Spaces 版本 3.6 的DS。请参阅 第 1.2 节 “安装 dsc 管理工具”。
流程
下载并执行镜像脚本,以安装自定义 Operator 目录并镜像相关的镜像: prepare-restricted-environment.sh。
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 在 CodeReady Workspaces 3.1 实例中的所有运行工作区中,保存更改并推送回 Git 存储库。
- 停止 CodeReady Workspaces 3.1 实例中的所有工作区。
运行以下命令:
dsc server:update --che-operator-image="$TAG" -n openshift-devspaces --k8spodwaittimeout=1800000
$ dsc server:update --che-operator-image="$TAG" -n openshift-devspaces --k8spodwaittimeout=1800000Copy to Clipboard Copied! Toggle word wrap Toggle overflow
验证步骤
- 进入 OpenShift Dev Spaces 实例。
- 3.6 版本号在页面的底部可见。
其他资源
6.6. 修复 OpenShift 上的 Dev Workspace Operator 复制链接链接已复制到粘贴板!
在某些情况下,如 OLM 重启或集群升级,OpenShift Dev Spaces 的 Dev Spaces Operator 可能会自动安装 Dev Workspace Operator,即使集群中已存在它。在这种情况下,您可以按如下方式修复 OpenShift 上的 Dev Workspace Operator:
先决条件
-
活跃的
oc会话作为集群管理员到目标 OpenShift 集群。请参阅开始使用 CLI。 - 在 OpenShift Web 控制台的 Installed Operators 页面中,您会看到 Dev Workspace Operator 的多个条目,或看到一个处于 Replacing 和 Pending 循环中的一个条目。
流程
-
删除包含故障 pod 的
devworkspace-controller命名空间。 通过将转换策略设置为
None并删除整个webhook部分,更新DevWorkspace和DevWorkspaceTemplate自定义资源定义(CRD):Copy to Clipboard Copied! Toggle word wrap Toggle overflow 提示您可以通过在 →
中搜索DevWorkspace,在 OpenShift Web 控制台的 Administrator 视角中查找并编辑DevWorkspace和DevWorkspaceTemplateCRD。注意DevWorkspaceOperatorConfig和DevWorkspaceRoutingCRD 默认将转换策略设置为None。删除 Dev Workspace Operator 订阅:
oc delete sub devworkspace-operator \ -n openshift-operators
$ oc delete sub devworkspace-operator \ -n openshift-operators1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 安装了 Dev Workspace Operator 的 OpenShift
-operators或 OpenShift 项目。
获取 < devworkspace_operator.vX.Y.Z > 格式的 Dev Workspace Operator CSV:
oc get csv | grep devworkspace
$ oc get csv | grep devworkspaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow 删除每个 Dev Workspace Operator CSV:
oc delete csv <devworkspace_operator.vX.Y.Z> \ -n openshift-operators
$ oc delete csv <devworkspace_operator.vX.Y.Z> \ -n openshift-operators1 Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- 安装了 Dev Workspace Operator 的 OpenShift
-operators或 OpenShift 项目。
重新创建 Dev Workspace Operator 订阅:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
Automatic或Manual。
重要对于
installPlanApproval: Manual,在 OpenShift Web 控制台的 Administrator 视角中,进入 → ,为 Dev Workspace Operator 选择以下内容: → → 。- 在 OpenShift Web 控制台的 Administrator 视角中,进入 → ,并验证 Dev Workspace Operator 的 Succeeded 状态。
第 7 章 卸载 Dev Spaces 复制链接链接已复制到粘贴板!
卸载 OpenShift Dev Spaces 会删除所有与 OpenShift Dev Spaces 相关的用户数据!
使用 oc 卸载 OpenShift Dev Spaces 实例。
先决条件
-
DSM.请参阅: 第 1.2 节 “安装 dsc 管理工具”。
流程
删除 OpenShift Dev Spaces 实例:
dsc server:delete
$ dsc server:deleteCopy to Clipboard Copied! Toggle word wrap Toggle overflow
--delete-namespace 选项删除 OpenShift Dev Spaces 命名空间。
--delete-all 选项删除 Dev Workspace Operator 和相关资源。