第 6 章 ConsolePlugin [console.openshift.io/v1]
- 描述
- consolePlugin 是一个扩展，可通过从集群中运行的另一个服务动态加载代码来自定义 OpenShift Web 控制台。兼容性级别 1：在主发行版本中至少提供 12 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
metadata -
spec
-
6.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
| 标准对象元数据。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata | |
|
|
| ConsolePluginSpec 是所需的插件配置。 |
6.1.1. .spec
- 描述
- ConsolePluginSpec 是所需的插件配置。
- 类型
-
object - 必填
-
后端 -
displayName
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| backend 包含提供控制台插件的后端配置。 |
|
|
| displayName 是插件的显示名称。dispalyName 应该介于 1 到 128 个字符之间。 |
|
|
| i18n 是插件本地化资源的配置。 |
|
|
| proxy 是代理列表，用于描述插件需要连接到的各种服务类型。 |
|
|
| ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。 |
6.1.2. .spec.backend
- 描述
- backend 包含提供控制台插件的后端配置。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 服务是一个 Kubernetes 服务，它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。 |
|
|
| type 是服务器控制台插件的后端类型。目前只支持 "Service"。-- |
6.1.3. .spec.backend.service
- 描述
- 服务是一个 Kubernetes 服务，它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。
- 类型
-
object - 必填
-
name -
namespace -
port
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
basePath 是插件资产的路径。主要资产是名为 |
|
|
| 为插件资产提供服务的 Service 名称。 |
|
|
| 为插件资产提供服务的命名空间。 |
|
|
| 为插件侦听的服务的端口。 |
6.1.4. .spec.i18n
- 描述
- i18n 是插件本地化资源的配置。
- 类型
-
object - 必填
-
loadType
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| loadType 表示插件的本地化资源应如何加载。有效值为 Preload、Lazy 和空字符串。当设置为 Preload 时，加载插件时会获取所有本地化资源。当设置为 Lazy 时，本地化资源会因为控制台需要时被加载。当省略或设置为空字符串时，行为等同于 Lazy 类型。 |
6.1.5. .spec.proxy
- 描述
- proxy 是代理列表，用于描述插件需要连接到的各种服务类型。
- 类型
-
数组
6.1.6. .spec.proxy[]
- 描述
- ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。
- 类型
-
object - 必填
-
alias -
端点
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| alias 是用于标识插件代理的代理名称。每个插件应具有唯一的别名名称。控制台后端会公开以下代理端点： /api/proxy/plugin/<plugin-name>/<proxy-alias>/<request-path>?<optional-query-parameters> Request example path: /api/proxy/plugin/acm/search/pods?namespace=openshift-apiserver |
|
|
| 授权提供有关代理请求应包含授权类型的信息 |
|
|
| caCertificate 提供证书颁发机构证书内容，以防代理服务使用自定义服务 CA。默认情况下使用 service-ca 操作器提供的服务 CA 捆绑包。 |
|
|
| 端点提供有关请求代理的端点的信息。 |
6.1.7. .spec.proxy[].endpoint
- 描述
- 端点提供有关请求代理的端点的信息。
- 类型
-
object - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点，以便代理插件和服务之间的通信。注意：现在需要 service 字段，因为目前只支持 "Service" 类型。 |
|
|
| type 是控制台插件的代理的类型。目前只支持 "Service"。-- |
6.1.8. .spec.proxy[].endpoint.service
- 描述
- Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点，以便代理插件和服务之间的通信。注意：现在需要 service 字段，因为目前只支持 "Service" 类型。
- 类型
-
object - 必填
-
name -
namespace -
port
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 插件需要连接的服务名称。 |
|
|
| 插件需要连接的 Service 的命名空间 |
|
|
| 插件需要连接的服务的端口。 |
