OpenShift 文档正在迁移，很快将仅在 docs.redhat.com（所有 Red Hat 产品文档的中心）提供。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

ConsoleQuickStart [console.openshift.io/v1]

描述

ConsoleQuickStart 是一个扩展，用于指导用户完成 OpenShift Web 控制台中的各种工作流程。兼容性级别 2：在主要版本中稳定至少 9 个月或 3 个次要版本（以较长者为准）。

类型

对象

必需

  • spec

规格

属性 类型 描述

apiVersion

字符串

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

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。采用驼峰命名法。更多信息：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 是所需的快速入门配置。

.spec

描述

ConsoleQuickStartSpec 是所需的快速入门配置。

类型

对象

必需

  • description

  • displayName

  • durationMinutes

  • introduction

  • tasks

属性 类型 描述

accessReviewResources

数组

accessReviewResources 包含用户访问权限将针对其进行审查的资源列表，以便用户完成快速入门。如果任何访问审查失败，则快速入门将被隐藏。

accessReviewResources[]

对象

ResourceAttributes 包括可用于向授权程序接口发出资源请求的授权属性

conclusion

字符串

conclusion 总结了快速入门并建议可能的下一步。(包含 markdown)

description

字符串

description 是快速入门的描述。(包含 markdown)

displayName

字符串

displayName 是快速入门的显示名称。

durationMinutes

整数

durationMinutes 描述完成快速入门大约需要多少分钟。

icon

字符串

icon 是一个 base64 编码的图像，它将显示在快速入门显示名称旁边。图标应为矢量图像，以便轻松缩放。图标大小应为 40x40。

introduction

字符串

introduction 描述了快速入门的目的。(包含 markdown)

nextQuickStart

数组 (字符串)

nextQuickStart 是一个快速入门列表，建议用户尝试。

前提条件

数组 (字符串)

prerequisites 包含开始快速入门之前需要满足的所有前提条件。（包含 Markdown）

标签

数组 (字符串)

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

tasks

数组

tasks 是用户必须执行的步骤列表，以完成快速入门。

tasks[]

对象

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

.spec.accessReviewResources

描述

accessReviewResources 包含用户访问权限将针对其进行审查的资源列表，以便用户完成快速入门。如果任何访问审查失败，则快速入门将被隐藏。

类型

数组

.spec.accessReviewResources[]

描述

ResourceAttributes 包括可用于向授权程序接口发出资源请求的授权属性

类型

对象

属性 类型 描述

组

字符串

Group 是资源的 API 组。“*”表示所有。

名称

字符串

Name 是对“get”请求的资源名称，或对“delete”请求要删除的资源名称。“”（空）表示所有。

命名空间

字符串

Namespace 是请求操作的命名空间。目前，没有命名空间和所有命名空间之间的区别。“”（空）对于 LocalSubjectAccessReviews 默认为空；对于集群范围的资源，“”（空）为空；对于来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围的资源，“”（空）表示“所有”。

资源

字符串

Resource 是现有资源类型之一。“*”表示所有。

子资源

字符串

Subresource 是现有资源类型之一。“”表示无。

动词

字符串

Verb 是 Kubernetes 资源 API 动词，例如：get、list、watch、create、update、delete、proxy。“*”表示所有。

版本

字符串

Version 是资源的 API 版本。“*”表示所有。

.spec.tasks

描述

tasks 是用户必须执行的步骤列表，以完成快速入门。

类型

数组

.spec.tasks[]

描述

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

类型

对象

必需

  • description

  • 标题

属性 类型 描述

description

字符串

description 描述完成任务所需的步骤。（包含 Markdown）

复查

对象

review 包含验证任务是否完成的说明。用户将选择“是”或“否”。使用单选按钮，指示步骤是否成功完成。

摘要

对象

summary 包含有关已通过步骤的信息。

标题

字符串

title 描述任务，并显示为步骤标题。

.spec.tasks[].review

描述

review 包含验证任务是否完成的说明。用户将选择“是”或“否”。使用单选按钮，指示步骤是否成功完成。

类型

对象

必需

  • 失败任务帮助

  • 说明

属性 类型 描述

失败任务帮助

字符串

failedTaskHelp 包含针对失败的任务复查的建议，并在任务结束时显示。（包含 Markdown）

说明

字符串

instructions 包含用户在完成任务后需要采取的步骤，以验证其工作。（包含 Markdown）

.spec.tasks[].summary

描述

summary 包含有关已通过步骤的信息。

类型

对象

必需

  • 失败

  • 成功

属性 类型 描述

失败

字符串

failed 简要描述未成功完成的任务。（包含 Markdown）

成功

字符串

success 描述成功完成的任务。

API 端点

提供以下 API 端点

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

    • DELETE：删除 ConsoleQuickStart 集合

    • GET：列出 ConsoleQuickStart 类型的对象

    • POST：创建一个 ConsoleQuickStart

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

    • DELETE：删除一个 ConsoleQuickStart

    • GET：读取指定的 ConsoleQuickStart

    • PATCH：部分更新指定的 ConsoleQuickStart

    • PUT：替换指定的 ConsoleQuickStart

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

HTTP 方法

DELETE

描述

删除 ConsoleQuickStart 集合

表 1. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 ConsoleQuickStart 类型的对象

表 2. HTTP 响应
HTTP 代码 响应体

200 - OK

ConsoleQuickStartList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 ConsoleQuickStart

表 3. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

body

ConsoleQuickStart 模式
表 5. HTTP 响应
HTTP 代码 响应体

200 - OK

ConsoleQuickStart 模式

201 - 已创建

ConsoleQuickStart 模式

202 - 已接受

ConsoleQuickStart 模式

401 - 未授权

空

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

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

名称

字符串

ConsoleQuickStart 的名称
HTTP 方法

DELETE

描述

删除一个 ConsoleQuickStart

表 7. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ConsoleQuickStart

表 9. HTTP 响应
HTTP 代码 响应体

200 - OK

ConsoleQuickStart 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConsoleQuickStart

表 10. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

200 - OK

ConsoleQuickStart 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConsoleQuickStart

表 12. 查询参数
参数 类型 描述

dryRun

字符串

如果存在，则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应，并且不会进一步处理请求。有效值为：- All：将处理所有 dry run 阶段

fieldValidation

字符串

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

body

ConsoleQuickStart 模式
表 14. HTTP 响应
HTTP 代码 响应体

200 - OK

ConsoleQuickStart 模式

201 - 已创建

ConsoleQuickStart 模式

401 - 未授权

空