控制台 API


OpenShift Container Platform 4.15

控制台 API 的参考指南

Red Hat OpenShift Documentation Team

摘要

本文档描述了 OpenShift Container Platform 控制台 API 对象及其详细规格。

第 1 章 控制台 API

1.1. ConsoleCLIDownload [console.openshift.io/v1]

描述
ConsoleCLIDownload 是配置 openshift web 控制台命令行界面(CLI)下载的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
对象

1.4. ConsoleNotification [console.openshift.io/v1]

描述
ConsoleNotification 是配置 openshift web 控制台通知的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object

1.5. ConsolePlugin [console.openshift.io/v1]

描述
consolePlugin 是一个扩展,可通过从集群中运行的另一个服务动态加载代码来自定义 OpenShift Web 控制台。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象

1.6. ConsoleQuickStart [console.openshift.io/v1]

描述
ConsoleQuickStart 是通过 OpenShift Web 控制台中的各种工作流调整用户的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object

1.7. ConsoleSample [console.openshift.io/v1]

描述
ConsoleSample 是一个通过添加示例来自定义 OpenShift Web 控制台的扩展。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象

1.8. ConsoleYAMLSample [console.openshift.io/v1]

描述
ConsoleYAMLSample 是自定义 OpenShift Web 控制台 YAML 样本的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
对象

第 2 章 ConsoleCLIDownload [console.openshift.io/v1]

描述
ConsoleCLIDownload 是配置 openshift web 控制台命令行界面(CLI)下载的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • spec

2.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsoleCLIDownloadSpec 是所需的 cli 下载配置。

2.1.1. .spec

描述
ConsoleCLIDownloadSpec 是所需的 cli 下载配置。
类型
object
必填
  • description
  • displayName
  • links
属性类型描述

description

字符串

description 是 CLI 下载的描述(can include markdown)。

displayName

字符串

displayName 是 CLI 下载的显示名称。

links

array

links 是提供 CLI 下载链接详细信息的对象列表。

links[]

对象

 

2.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consoleclidownloads

    • DELETE: 删除 ConsoleCLIDownload 集合
    • GET: 列出 ConsoleCLIDownload 类型的对象
    • POST :创建 ConsoleCLIDownload
  • /apis/console.openshift.io/v1/consoleclidownloads/{name}

    • DELETE :删除 ConsoleCLIDownload
    • GET :读取指定的 ConsoleCLIDownload
    • PATCH: 部分更新指定的 ConsoleCLIDownload
    • PUT :替换指定的 ConsoleCLIDownload
  • /apis/console.openshift.io/v1/consoleclidownloads/{name}/status

    • GET :指定 ConsoleCLIDownload 的读取状态
    • PATCH: 部分更新指定 ConsoleCLIDownload 的状态
    • PUT :替换指定 ConsoleCLIDownload 的状态

2.2.1. /apis/console.openshift.io/v1/consoleclidownloads

HTTP 方法
DELETE
描述
删除 ConsoleCLIDownload 集合
表 2.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 ConsoleCLIDownload 类型的对象
表 2.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownloadList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsoleCLIDownload
表 2.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 2.4. 主体参数
参数类型描述

正文(body)

ConsoleCLIDownload 模式

 
表 2.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

201 - Created

ConsoleCLIDownload 模式

202 - Accepted

ConsoleCLIDownload 模式

401 - Unauthorized

2.2.2. /apis/console.openshift.io/v1/consoleclidownloads/{name}

表 2.6. 全局路径参数
参数类型描述

name

字符串

ConsoleCLIDownload 的名称

HTTP 方法
DELETE
描述
删除 ConsoleCLIDownload
表 2.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 2.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ConsoleCLIDownload
表 2.9. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsoleCLIDownload
表 2.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 2.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsoleCLIDownload
表 2.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 2.13. 主体参数
参数类型描述

正文(body)

ConsoleCLIDownload 模式

 
表 2.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

201 - Created

ConsoleCLIDownload 模式

401 - Unauthorized

2.2.3. /apis/console.openshift.io/v1/consoleclidownloads/{name}/status

表 2.15. 全局路径参数
参数类型描述

name

字符串

ConsoleCLIDownload 的名称

HTTP 方法
GET
描述
指定 ConsoleCLIDownload 的读取状态
表 2.16. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 ConsoleCLIDownload 的状态
表 2.17. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 2.18. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ConsoleCLIDownload 的状态
表 2.19. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 2.20. 主体参数
参数类型描述

正文(body)

ConsoleCLIDownload 模式

 
表 2.21. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleCLIDownload 模式

201 - Created

ConsoleCLIDownload 模式

401 - Unauthorized

第 5 章 ConsoleNotification [console.openshift.io/v1]

描述
ConsoleNotification 是配置 openshift web 控制台通知的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • spec

5.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsoleNotificationSpec 是所需的控制台通知配置。

5.1.1. .spec

描述
ConsoleNotificationSpec 是所需的控制台通知配置。
类型
object
必填
  • text
属性类型描述

backgroundColor

字符串

backgroundColor 是通知的背景颜色,作为 CSS 数据类型颜色。

color

字符串

color 是通知的文本颜色,作为 CSS 数据类型颜色。

link

对象

link 是包含通知链接详细信息的对象。

位置

字符串

位置是控制台中通知的位置。有效值为:"BannerTop", "BannerBottom", "BannerTopBottom"。

text

字符串

text 是通知的可见文本。

5.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consolenotifications

    • DELETE :删除 ConsoleNotification 集合
    • GET: 列出 kind ConsoleNotification 的对象
    • POST :创建 ConsoleNotification
  • /apis/console.openshift.io/v1/consolenotifications/{name}

    • DELETE :删除 ConsoleNotification
    • GET :读取指定的 ConsoleNotification
    • PATCH: 部分更新指定的 ConsoleNotification
    • PUT :替换指定的 ConsoleNotification
  • /apis/console.openshift.io/v1/consolenotifications/{name}/status

    • GET :指定 ConsoleNotification 的读取状态
    • PATCH: 部分更新指定 ConsoleNotification 的状态
    • PUT :替换指定 ConsoleNotification 的状态

5.2.1. /apis/console.openshift.io/v1/consolenotifications

HTTP 方法
DELETE
描述
删除 ConsoleNotification 集合
表 5.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 kind ConsoleNotification 的对象
表 5.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotificationList schema

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsoleNotification
表 5.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.4. 主体参数
参数类型描述

正文(body)

ConsoleNotification 模式

 
表 5.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

201 - Created

ConsoleNotification 模式

202 - Accepted

ConsoleNotification 模式

401 - Unauthorized

5.2.2. /apis/console.openshift.io/v1/consolenotifications/{name}

表 5.6. 全局路径参数
参数类型描述

name

字符串

ConsoleNotification 的名称

HTTP 方法
DELETE
描述
删除 ConsoleNotification
表 5.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 5.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ConsoleNotification
表 5.9. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsoleNotification
表 5.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsoleNotification
表 5.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.13. 主体参数
参数类型描述

正文(body)

ConsoleNotification 模式

 
表 5.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

201 - Created

ConsoleNotification 模式

401 - Unauthorized

5.2.3. /apis/console.openshift.io/v1/consolenotifications/{name}/status

表 5.15. 全局路径参数
参数类型描述

name

字符串

ConsoleNotification 的名称

HTTP 方法
GET
描述
指定 ConsoleNotification 的读取状态
表 5.16. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定 ConsoleNotification 的状态
表 5.17. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.18. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定 ConsoleNotification 的状态
表 5.19. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 5.20. 主体参数
参数类型描述

正文(body)

ConsoleNotification 模式

 
表 5.21. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleNotification 模式

201 - Created

ConsoleNotification 模式

401 - Unauthorized

第 6 章 ConsolePlugin [console.openshift.io/v1]

描述
consolePlugin 是一个扩展,可通过从集群中运行的另一个服务动态加载代码来自定义 OpenShift Web 控制台。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • metadata
  • spec

6.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsolePluginSpec 是所需的插件配置。

6.1.1. .spec

描述
ConsolePluginSpec 是所需的插件配置。
类型
object
必填
  • 后端
  • displayName
属性类型描述

后端

object

backend 包含提供控制台插件的后端配置。

displayName

字符串

displayName 是插件的显示名称。dispalyName 应该介于 1 到 128 个字符之间。

i18n

object

i18n 是插件本地化资源的配置。

proxy

数组

proxy 是代理列表,用于描述插件需要连接到的各种服务类型。

proxy[]

object

ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。

6.1.2. .spec.backend

描述
backend 包含提供控制台插件的后端配置。
类型
object
必填
  • type
属性类型描述

service

对象

服务是一个 Kubernetes 服务,它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。

type

string

type 是服务器控制台插件的后端类型。目前只支持 "Service"。--

6.1.3. .spec.backend.service

描述
服务是一个 Kubernetes 服务,它使用带有 HTTP 服务器的部署来公开插件。服务必须使用 HTTPS 和服务服务证书。控制台后端将使用服务 CA 捆绑包代理来自服务的插件资产。
类型
object
必填
  • name
  • namespace
  • port
属性类型描述

basePath

字符串

basePath 是插件资产的路径。主要资产是名为 plugin-manifest.json 的清单文件,它是一个 JSON 文档,其中包含有关插件和扩展的元数据。

name

string

为插件资产提供服务的 Service 名称。

namespace

string

为插件资产提供服务的命名空间。

port

整数

为插件侦听的服务的端口。

6.1.4. .spec.i18n

描述
i18n 是插件本地化资源的配置。
类型
object
必填
  • loadType
属性类型描述

loadType

string

loadType 表示插件的本地化资源应如何加载。有效值为 Preload、Lazy 和空字符串。当设置为 Preload 时,加载插件时会获取所有本地化资源。当设置为 Lazy 时,本地化资源会因为控制台需要时被加载。当省略或设置为空字符串时,行为等同于 Lazy 类型。

6.1.5. .spec.proxy

描述
proxy 是代理列表,用于描述插件需要连接到的各种服务类型。
类型
数组

6.1.6. .spec.proxy[]

描述
ConsolePluginProxy 包含有关控制台后端将代理插件请求的各种服务类型的信息。
类型
object
必填
  • alias
  • 端点
属性类型描述

alias

string

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

授权

string

授权提供有关代理请求应包含授权类型的信息

caCertificate

string

caCertificate 提供证书颁发机构证书内容,以防代理服务使用自定义服务 CA。默认情况下使用 service-ca 操作器提供的服务 CA 捆绑包。

端点

object

端点提供有关请求代理的端点的信息。

6.1.7. .spec.proxy[].endpoint

描述
端点提供有关请求代理的端点的信息。
类型
object
必填
  • type
属性类型描述

service

object

Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点,以便代理插件和服务之间的通信。注意:现在需要 service 字段,因为目前只支持 "Service" 类型。

type

string

type 是控制台插件的代理的类型。目前只支持 "Service"。--

6.1.8. .spec.proxy[].endpoint.service

描述
Service 是一个插件将连接到的集群内服务。服务必须使用 HTTPS。控制台后端公开端点,以便代理插件和服务之间的通信。注意:现在需要 service 字段,因为目前只支持 "Service" 类型。
类型
object
必填
  • name
  • namespace
  • port
属性类型描述

name

string

插件需要连接的服务名称。

namespace

string

插件需要连接的 Service 的命名空间

port

整数

插件需要连接的服务的端口。

6.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consoleplugins

    • DELETE :删除 ConsolePlugin 集合
    • GET: 列出 kind ConsolePlugin 的对象
    • POST :创建 ConsolePlugin
  • /apis/console.openshift.io/v1/consoleplugins/{name}

    • DELETE :删除 ConsolePlugin
    • GET :读取指定的 ConsolePlugin
    • PATCH: 部分更新指定的 ConsolePlugin
    • PUT :替换指定的 ConsolePlugin

6.2.1. /apis/console.openshift.io/v1/consoleplugins

HTTP 方法
DELETE
描述
删除 ConsolePlugin 集合
表 6.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 ConsolePlugin 类型的对象
表 6.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsolePluginList schema

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsolePlugin
表 6.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 6.4. 主体参数
参数类型描述

正文(body)

consolePlugin 模式

 
表 6.5. HTTP 响应
HTTP 代码响应正文

200 - OK

consolePlugin 模式

201 - Created

consolePlugin 模式

202 - Accepted

consolePlugin 模式

401 - Unauthorized

6.2.2. /apis/console.openshift.io/v1/consoleplugins/{name}

表 6.6. 全局路径参数
参数类型描述

name

字符串

ConsolePlugin 的名称

HTTP 方法
DELETE
描述
删除 ConsolePlugin
表 6.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 6.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的 ConsolePlugin
表 6.9. HTTP 响应
HTTP 代码响应正文

200 - OK

consolePlugin 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsolePlugin
表 6.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 6.11. HTTP 响应
HTTP 代码响应正文

200 - OK

consolePlugin 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsolePlugin
表 6.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 6.13. 主体参数
参数类型描述

正文(body)

consolePlugin 模式

 
表 6.14. HTTP 响应
HTTP 代码响应正文

200 - OK

consolePlugin 模式

201 - Created

consolePlugin 模式

401 - Unauthorized

第 7 章 ConsoleQuickStart [console.openshift.io/v1]

描述
ConsoleQuickStart 是通过 OpenShift Web 控制台中的各种工作流调整用户的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • spec

7.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsoleQuickStartSpec 是所需的快速启动配置。

7.1.1. .spec

描述
ConsoleQuickStartSpec 是所需的快速启动配置。
类型
object
必填
  • description
  • displayName
  • durationMinutes
  • 简介
  • tasks
属性类型描述

accessReviewResources

array

accessReviewResources 包含了一个资源列表,用户会对其进行检查,以便用户完成快速入门。如果任何访问检查失败,快速入门会被隐藏。

accessReviewResources[]

对象

ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性

conclusion

字符串

总结总结快速入门并推荐后续步骤。(包括标记)

description

字符串

description 是快速入门的描述。(包括标记)

displayName

字符串

displayName 是 Quick Start 的显示名称。

durationMinutes

整数

durationMinutes 描述了完成快速入门所需的时间大约需要多少分钟。

icon

字符串

图标是一个 base64 编码镜像,它将在 Quick Start 显示名称旁边显示。该图标应该是用于轻松扩展的向量镜像。图标的大小应为 40x40。

简介

字符串

简介描述了快速入门的目的。(包括标记)

nextQuickStart

数组(字符串)

nextQuickStart 是以下快速入门列表,建议用户尝试。

先决条件

数组(字符串)

先决条件包含执行快速入门前需要满足的所有先决条件。(包括标记)

tags

数组(字符串)

tags 是描述快速入门的字符串列表。

tasks

array

Task (Task)是用户完成快速入门必须执行的步骤列表。

tasks[]

对象

ConsoleQuickStartTask 是快速入门中的一个步骤。

7.1.2. .spec.accessReviewResources

描述
accessReviewResources 包含了一个资源列表,用户会对其进行检查,以便用户完成快速入门。如果任何访问检查失败,快速入门会被隐藏。
类型
array

7.1.3. .spec.accessReviewResources[]

描述
ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
类型
object
属性类型描述

group

字符串

Group 是 Resource 的 API 组。"*"代表所有。

name

字符串

Name 是为"get"请求的资源的名称,或删除"delete"。"" (空)表示全部。

namespace

字符串

namespace 是所请求操作的命名空间。目前,对于集群范围的资源 "" (empty),没有命名空间和所有命名空间"" (空)之间的差别,对于集群范围的资源 "" (空)代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源

resource

字符串

资源是现有资源类型之一。"*"表示全部。

subresource

字符串

子资源是现有资源类型之一。""表示 none。

verb

字符串

verb 是一个 kubernetes 资源 API 动词,如: get, list, watch, create, update, delete, proxy. "*" 表示所有。

version

字符串

version 是资源的 API 版本。"*"表示所有。

7.1.4. .spec.tasks

描述
Task (Task)是用户完成快速入门必须执行的步骤列表。
类型
array

7.1.5. .spec.tasks[]

描述
ConsoleQuickStartTask 是快速入门中的一个步骤。
类型
object
必填
  • description
  • title
属性类型描述

description

字符串

Description 描述了完成任务所需的步骤。(包括标记)

review

对象

检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否",这指示步骤是否已成功完成。

summary

对象

Summary 包含有关传递步骤的信息。

title

字符串

title 描述了任务,显示为步骤标题。

7.1.6. .spec.tasks[].review

描述
检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否",这指示步骤是否已成功完成。
类型
object
必填
  • failedTaskHelp
  • 说明
属性类型描述

failedTaskHelp

字符串

failedTaskHelp 包含失败任务检查的建议,并在任务末尾显示。(包括标记)

说明

字符串

指令包含用户在完成任务后需要采取的步骤(包括标记)

7.1.7. .spec.tasks[].summary

描述
Summary 包含有关传递步骤的信息。
类型
object
必填
  • 失败
  • success
属性类型描述

失败

字符串

failed 简要描述了未成功通过的任务。(包括标记)

success

字符串

成功描述了 succesfully passed 的任务。

7.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consolequickstarts

    • DELETE: 删除 ConsoleQuickStart 集合
    • GET: 列出类型为 ConsoleQuickStart 的对象
    • POST :创建 ConsoleQuickStart
  • /apis/console.openshift.io/v1/consolequickstarts/{name}

    • DELETE: delete a ConsoleQuickStart
    • GET :读取指定的 ConsoleQuickStart
    • PATCH: 部分更新指定的 ConsoleQuickStart
    • PUT :替换指定的 ConsoleQuickStart

7.2.1. /apis/console.openshift.io/v1/consolequickstarts

HTTP 方法
DELETE
描述
删除 ConsoleQuickStart 集合
表 7.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 ConsoleQuickStart 类型的对象
表 7.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleQuickStartList schema

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsoleQuickStart
表 7.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.4. 主体参数
参数类型描述

正文(body)

ConsoleQuickStart schema

 
表 7.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

202 - Accepted

ConsoleQuickStart schema

401 - Unauthorized

7.2.2. /apis/console.openshift.io/v1/consolequickstarts/{name}

表 7.6. 全局路径参数
参数类型描述

name

字符串

ConsoleQuickStart 的名称

HTTP 方法
DELETE
描述
delete a ConsoleQuickStart
表 7.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 7.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ConsoleQuickStart
表 7.9. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsoleQuickStart
表 7.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsoleQuickStart
表 7.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 7.13. 主体参数
参数类型描述

正文(body)

ConsoleQuickStart schema

 
表 7.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

401 - Unauthorized

第 8 章 ConsoleSample [console.openshift.io/v1]

描述
ConsoleSample 是一个通过添加示例来自定义 OpenShift Web 控制台的扩展。兼容性级别 1:在主发行版本中至少提供 12 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • metadata
  • spec

8.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

spec 包含控制台示例的配置。

8.1.1. .spec

描述
spec 包含控制台示例的配置。
类型
object
必填
  • abstract
  • description
  • source
  • title
属性类型描述

abstract

string

abstract 是示例的一个简短介绍。它是必需的,且长度不得超过 100 个字符。抽象显示在标题和提供程序下面的卡标题上,仅限于三行内容。

description

string

description 是示例的长形式说明。它是必需的,且最大长度为 4096 个字符。它是一个与 README.md 类似的内容,用于其他信息、链接、前提条件和其他说明。它将呈现为 Markdown,以便它可以包含换行符、链接和其他简单格式。

icon

string

图标是一个可选的 base64 编码镜像,显示在示例标题旁边。格式必须采用 data: URL 格式,且最大大小为 10 KB. data:[<mediatype>][;base64],<base64 encoded image> 例如: data:image;base64 加上 base64 编码镜像。也可以使用向量镜像。SVG 图标必须以 data:image/svg+xml;base64 开头;base64 加上 base64 编码的 SVG 镜像。所有示例目录图标都会显示在白色背景上(也在使用黑色时)。Web 控制台确保不同的方面比率可以正常工作。目前,图标的面最多为 40x100px。有关数据 URL 格式的更多信息,请访问 https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs

provider

string

provider 是提供示例的可选标签。它是可选的,长度不得超过 50 个字符。供应商可以是像"Red Hat"这样的公司,也可以是像"CNCF"或"Knative"这样的组织。目前,该供应商仅显示标题下面的示例卡标题上,前缀 "Provided by "Provided

source

object

Source 定义从何处部署示例服务。示例的来源可以是来自外部 git 存储库或容器镜像。

tags

数组(字符串)

标签是可选字符串值,可用于在示例目录中查找示例。常见标签示例可能是"Java"、"Quarkus"等。它们将显示在示例详情页面中。

title

string

title 是示例的显示名称。它是必需的,且长度不得超过 50 个字符。

type

string

type 是对多个示例进行分组的可选标签。它是可选的,长度不得超过 20 个字符。建议是一个单词,如 "Builder Image"、"Devfile" 或 "Serverless Function"。目前,该类型在右上角的示例卡标题上显示一个徽标。

8.1.2. .spec.source

描述
Source 定义从何处部署示例服务。示例的来源可以是来自外部 git 存储库或容器镜像。
类型
object
必填
  • type
属性类型描述

containerImport

object

containerImport 允许用户导入容器镜像。

gitImport

object

gitImport 允许用户从 git 存储库导入代码。

type

string

示例类型,目前支持:"GitImport";"ContainerImport"

8.1.3. .spec.source.containerImport

描述
containerImport 允许用户导入容器镜像。
类型
object
必填
  • image
属性类型描述

image

string

对提供 HTTP 服务的容器镜像的引用。服务必须在默认端口(8080)上公开,除非使用 port 字段进行了配置。支持的格式: - <repository-name>/<image-name> - docker.io/<repository-name>/<image-name> - quay.io/<repository-name>/<image-name> - quay.io/<repository-name>/<image-name>@sha256:<image hash> - quay.io/<repository-name>/<image-name>:<tag>

service

object

服务包含为本例创建的 Service 资源的配置。

8.1.4. .spec.source.containerImport.service

描述
服务包含为本例创建的 Service 资源的配置。
类型
object
属性类型描述

targetPort

整数

targetPort 是服务侦听 HTTP 请求的端口。此端口将用于为本示例创建的服务和路由。port 必须在 1 到 65535 之间。默认端口为 8080。

8.1.5. .spec.source.gitImport

描述
gitImport 允许用户从 git 存储库导入代码。
类型
object
必填
  • 软件仓库
属性类型描述

软件仓库

object

存储库包含对实际 Git 存储库的引用。

service

object

服务包含为本例创建的 Service 资源的配置。

8.1.6. .spec.source.gitImport.repository

描述
存储库包含对实际 Git 存储库的引用。
类型
object
必填
  • url
属性类型描述

contextDir

string

contextDir 用于指定存储库中构建组件的目录。必须以 / 开头,并且最大长度为 256 个字符。如果省略,则默认值为从存储库的根目录进行构建。

revision

string

revision 是 git 修订版本,可在其中克隆 git 存储库,用于克隆特定的分支、标签或提交 SHA。必须长度最多为 256 个字符。在省略存储库的默认分支时。

url

string

包含 HTTP 服务的 Git 存储库的 URL。HTTP 服务必须在默认端口(8080)上公开,除非使用 port 字段进行了配置。目前只支持 GitHub、GitLab 和 Bitbucket 上的公共软件仓库:- https://github.com/<org>/<repository&gt;- https://gitlab.com/<org>/<repository& gt ;- https://bitbucket.org/<org>/<repository > url 必须的最大长度为 256 个字符。

8.1.7. .spec.source.gitImport.service

描述
服务包含为本例创建的 Service 资源的配置。
类型
object
属性类型描述

targetPort

整数

targetPort 是服务侦听 HTTP 请求的端口。此端口将用于为本例创建的服务。port 必须在 1 到 65535 之间。默认端口为 8080。

8.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consolesamples

    • DELETE: 删除 ConsoleSample 集合
    • GET: 列出类型为 ConsoleSample 的对象
    • POST :创建 ConsoleSample
  • /apis/console.openshift.io/v1/consolesamples/{name}

    • DELETE: 删除 ConsoleSample
    • GET :读取指定的 ConsoleSample
    • PATCH: 部分更新指定的 ConsoleSample
    • PUT :替换指定的 ConsoleSample

8.2.1. /apis/console.openshift.io/v1/consolesamples

HTTP 方法
DELETE
描述
删除 ConsoleSample 集合
表 8.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 kind ConsoleSample 的对象
表 8.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleSampleList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsoleSample
表 8.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.4. 主体参数
参数类型描述

正文(body)

ConsoleSample 模式

 
表 8.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleSample 模式

201 - Created

ConsoleSample 模式

202 - Accepted

ConsoleSample 模式

401 - Unauthorized

8.2.2. /apis/console.openshift.io/v1/consolesamples/{name}

表 8.6. 全局路径参数
参数类型描述

name

string

ConsoleSample 的名称

HTTP 方法
DELETE
描述
删除 ConsoleSample
表 8.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 8.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ConsoleSample
表 8.9. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleSample 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsoleSample
表 8.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleSample 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsoleSample
表 8.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 8.13. 主体参数
参数类型描述

正文(body)

ConsoleSample 模式

 
表 8.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleSample 模式

201 - Created

ConsoleSample 模式

401 - Unauthorized

第 9 章 ConsoleYAMLSample [console.openshift.io/v1]

描述
ConsoleYAMLSample 是自定义 OpenShift Web 控制台 YAML 样本的扩展。兼容性级别 2:在主发行版本中至少为 9 个月或 3 个次版本(以更长的时间为准)。
类型
object
必填
  • metadata
  • spec

9.1. 规格

属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta

标准对象元数据。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

对象

ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 web 控制台中创建资源时,示例会在示例栏中显示。

9.1.1. .spec

描述
ConsoleYAMLSampleSpec 是所需的 YAML 示例配置。在 web 控制台中创建资源时,示例会在示例栏中显示。
类型
object
必填
  • description
  • targetResource
  • title
  • yaml
属性类型描述

description

字符串

YAML 示例的描述。

snippet

布尔值

代码片段表示 YAML 示例不是完整的 YAML 资源定义,而是可插入到用户光标处的现有 YAML 文档中的片段。

targetResource

对象

targetResource 包含 apiVersion 和 kind of the resource YAML 示例代表。

title

字符串

YAML 样本的标题。

yaml

字符串

yaml 是要显示的 YAML 示例。

9.1.2. .spec.targetResource

描述
targetResource 包含 apiVersion 和 kind of the resource YAML 示例代表。
类型
object
属性类型描述

apiVersion

字符串

APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

9.2. API 端点

可用的 API 端点如下:

  • /apis/console.openshift.io/v1/consoleyamlsamples

    • DELETE: 删除 ConsoleYAMLSample 集合
    • GET: 列出 ConsoleYAMLSample 类型的对象
    • POST :创建 ConsoleYAMLSample
  • /apis/console.openshift.io/v1/consoleyamlsamples/{name}

    • DELETE :删除 ConsoleYAMLSample
    • GET :读取指定的 ConsoleYAMLSample
    • PATCH: 部分更新指定的 ConsoleYAMLSample
    • PUT :替换指定的 ConsoleYAMLSample

9.2.1. /apis/console.openshift.io/v1/consoleyamlsamples

HTTP 方法
DELETE
描述
删除 ConsoleYAMLSample 集合
表 9.1. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出 kind ConsoleYAMLSample 的对象
表 9.2. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleYAMLSampleList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建 ConsoleYAMLSample
表 9.3. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 9.4. 主体参数
参数类型描述

正文(body)

ConsoleYAMLSample 模式

 
表 9.5. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleYAMLSample 模式

201 - Created

ConsoleYAMLSample 模式

202 - Accepted

ConsoleYAMLSample 模式

401 - Unauthorized

9.2.2. /apis/console.openshift.io/v1/consoleyamlsamples/{name}

表 9.6. 全局路径参数
参数类型描述

name

字符串

ConsoleYAMLSample 的名称

HTTP 方法
DELETE
描述
删除 ConsoleYAMLSample
表 9.7. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

表 9.8. HTTP 响应
HTTP 代码响应正文

200 - OK

Status 模式

202 - Accepted

Status 模式

401 - Unauthorized

HTTP 方法
GET
描述
阅读指定的 ConsoleYAMLSample
表 9.9. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleYAMLSample 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的 ConsoleYAMLSample
表 9.10. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 9.11. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleYAMLSample 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的 ConsoleYAMLSample
表 9.12. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldValidation

string

fieldValidation 指示服务器如何处理包含了未知或重复字段的请求 (POST/PUT/PATCH) 中的对象。有效值为: - Ignore :忽略从对象中静默丢弃的未知字段,并将忽略所有除最后一个重复字段以外的所有字段。这是 v1.23 版本之前的默认行为- Warn: 这会通过标准的警告响应头为从对象丢弃的每个未知字段以及遇到的每个重复字段,发送警告。如果没有其他错误,请求仍会成功,且只保留重复字段的最后一个。这是 v1.23+ 的的默认行为 - Strict: 如果从对象中删除了任何未知字段,或者存在任何重复字段,请求将失败并带有 BadRequest 错误。从服务器返回的错误将包含遇到的,以及重复的字段。

表 9.13. 主体参数
参数类型描述

正文(body)

ConsoleYAMLSample 模式

 
表 9.14. HTTP 响应
HTTP 代码响应正文

200 - OK

ConsoleYAMLSample 模式

201 - Created

ConsoleYAMLSample 模式

401 - Unauthorized

Legal Notice

Copyright © 2024 Red Hat, Inc.

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.