3.3. 配置服务器组件
3.3.1. 将 Secret 或 ConfigMap 挂载为文件或环境变量到 Red Hat OpenShift Dev Spaces 容器中
机密是存储敏感数据的 OpenShift 对象,例如:
- 用户名
- 密码
- 身份验证令牌
的加密形式。
用户可以挂载包含敏感数据或 ConfigMap (在 OpenShift Dev Spaces 受管容器中包含配置)的 OpenShift Secret:
- 一个文件
- 环境变量
挂载过程使用标准的 OpenShift 挂载机制,但它需要额外的注释和标记。
3.3.1.1. 将 Secret 或 ConfigMap 作为一个文件挂载到 OpenShift Dev Spaces 容器中
先决条件
- 正在运行的红帽 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
> 对应于以下部署:-
postgres
-
Keycloak
-
devfile-registry
-
plugin-registry
devspaces
和
-
<OBJECT_KIND&
gt; 是:secret
或者
-
configmap
-
例 3.4. 例如:
apiVersion: v1 kind: Secret metadata: name: custom-settings labels: app.kubernetes.io/part-of: che.eclipse.org app.kubernetes.io/component: devspaces-secret ...
或者
apiVersion: v1 kind: ConfigMap metadata: name: custom-settings labels: app.kubernetes.io/part-of: che.eclipse.org app.kubernetes.io/component: devspaces-configmap ...
注解必须指示给定对象被挂载为一个文件。
配置注解值:
-
Che.eclipse.org/mount-as: file
- 要表示对象被挂载为一个文件。 -
Che.eclipse.org/mount-path: <TARGET_PATH
> - 要提供所需的挂载路径。
-
例 3.5. 例如:
apiVersion: v1 kind: Secret metadata: name: custom-data annotations: che.eclipse.org/mount-as: file che.eclipse.org/mount-path: /data labels: ...
或者
apiVersion: v1 kind: ConfigMap metadata: name: custom-data annotations: che.eclipse.org/mount-as: file che.eclipse.org/mount-path: /data labels: ...
OpenShift 对象可以包含多个项目,其名称必须与挂载到容器中所需的文件名匹配。
例 3.6. 例如:
apiVersion: v1
kind: Secret
metadata:
name: custom-data
labels:
app.kubernetes.io/part-of: che.eclipse.org
app.kubernetes.io/component: devspaces-secret
annotations:
che.eclipse.org/mount-as: file
che.eclipse.org/mount-path: /data
data:
ca.crt: <base64 encoded data content here>
或者
apiVersion: v1
kind: ConfigMap
metadata:
name: custom-data
labels:
app.kubernetes.io/part-of: che.eclipse.org
app.kubernetes.io/component: devspaces-configmap
annotations:
che.eclipse.org/mount-as: file
che.eclipse.org/mount-path: /data
data:
ca.crt: <data content here>
这会导致名为 ca.crt
的文件挂载到 OpenShift Dev Spaces 容器的 /data
路径上。
要在 OpenShift Dev Spaces 容器中进行更改,请完全重新创建对象。
3.3.1.2. 将 Secret 或 ConfigMap 作为环境变量挂载到 OpenShift Dev Spaces 容器中
先决条件
- 正在运行的红帽 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
> 对应于以下部署:-
postgres
-
Keycloak
-
devfile-registry
-
plugin-registry
devspaces
和
-
<OBJECT_KIND&
gt; 是:secret
或者
-
configmap
-
例 3.7. 例如:
apiVersion: v1 kind: Secret metadata: name: custom-settings labels: app.kubernetes.io/part-of: che.eclipse.org app.kubernetes.io/component: devspaces-secret ...
或者
apiVersion: v1 kind: ConfigMap metadata: name: custom-settings labels: app.kubernetes.io/part-of: che.eclipse.org app.kubernetes.io/component: devspaces-configmap ...
注解必须指示给定对象被挂载为环境变量。
配置注解值:
-
Che.eclipse.org/mount-as: env
- 表示对象被挂载为环境变量 -
Che.eclipse.org/env-name : <FOO_ENV
> - 以提供环境变量名称,这是挂载对象密钥值所必需的
-
例 3.8. 例如:
apiVersion: v1 kind: Secret metadata: name: custom-settings annotations: che.eclipse.org/env-name: FOO_ENV che.eclipse.org/mount-as: env labels: ... data: mykey: myvalue
或者
apiVersion: v1 kind: ConfigMap metadata: name: custom-settings annotations: che.eclipse.org/env-name: FOO_ENV che.eclipse.org/mount-as: env labels: ... data: mykey: myvalue
这会生成两个环境变量:
-
FOO_ENV
-
myvalue
集成到 OpenShift Dev Spaces 容器中。
如果对象提供多个数据项,则必须为每个数据键提供环境变量名称,如下所示:
例 3.9. 例如:
apiVersion: v1 kind: Secret metadata: name: custom-settings annotations: che.eclipse.org/mount-as: env che.eclipse.org/mykey_env-name: FOO_ENV che.eclipse.org/otherkey_env-name: OTHER_ENV labels: ... data: mykey: __<base64 encoded data content here>__ otherkey: __<base64 encoded data content here>__
或者
apiVersion: v1 kind: ConfigMap metadata: name: custom-settings annotations: che.eclipse.org/mount-as: env che.eclipse.org/mykey_env-name: FOO_ENV che.eclipse.org/otherkey_env-name: OTHER_ENV labels: ... data: mykey: __<data content here>__ otherkey: __<data content here>__
这会生成两个环境变量:
-
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.10. 覆盖工作区的默认内存限值
配置
CheCluster
自定义资源。请参阅 第 3.1.2 节 “使用 CLI 配置 CheCluster 自定义资源”。apiVersion: org.eclipse.che/v2 kind: CheCluster spec: components: cheServer: extraProperties: CHE_LOGS_APPENDERS_IMPL: json
早期版本的 OpenShift Dev Spaces Operator 具有名为 custom
的 ConfigMap 来履行此角色。如果 OpenShift Dev Spaces Operator 找到了名为 custom
的 configMap
,它会将其包含的数据添加到 customCheProperties
字段中,重新部署 OpenShift Dev Spaces,并删除 自定义
configMap
。