第 7 章 ConsoleQuickStart [console.openshift.io/v1]
- 描述
- ConsoleQuickStart 是通过 OpenShift Web 控制台中的各种工作流调整用户的扩展。兼容性级别 2：在主发行版本中至少为 9 个月或 3 个次版本（以更长的时间为准）。
- 类型
-
object - 必填
-
spec
-
7.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 | |
|
|
| ConsoleQuickStartSpec 是所需的快速启动配置。 |
7.1.1. .spec
- 描述
- ConsoleQuickStartSpec 是所需的快速启动配置。
- 类型
-
object - 必填
-
description -
displayName -
durationMinutes -
简介 -
tasks
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| accessReviewResources 包含了一个资源列表，用户会对其进行检查，以便用户完成快速入门。如果任何访问检查失败，快速入门会被隐藏。 |
|
|
| ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性 |
|
|
| 总结总结快速入门并推荐后续步骤。（包括标记） |
|
|
| description 是快速入门的描述。（包括标记） |
|
|
| displayName 是 Quick Start 的显示名称。 |
|
|
| durationMinutes 描述了完成快速入门所需的时间大约需要多少分钟。 |
|
|
| 图标是一个 base64 编码镜像，它将在 Quick Start 显示名称旁边显示。该图标应该是用于轻松扩展的向量镜像。图标的大小应为 40x40。 |
|
|
| 简介描述了快速入门的目的。（包括标记） |
|
|
| nextQuickStart 是以下快速入门列表，建议用户尝试。 |
|
|
| 先决条件包含执行快速入门前需要满足的所有先决条件。（包括标记） |
|
|
| tags 是描述快速入门的字符串列表。 |
|
|
| Task (Task)是用户完成快速入门必须执行的步骤列表。 |
|
|
| ConsoleQuickStartTask 是快速入门中的一个步骤。 |
7.1.2. .spec.accessReviewResources
- 描述
- accessReviewResources 包含了一个资源列表，用户会对其进行检查，以便用户完成快速入门。如果任何访问检查失败，快速入门会被隐藏。
- 类型
-
array
7.1.3. .spec.accessReviewResources[]
- 描述
- ResourceAttributes 包含对 Authorizer 接口的资源请求的授权属性
- 类型
-
object
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Group 是 Resource 的 API 组。"*"代表所有。 |
|
|
| Name 是为"get"请求的资源的名称，或删除"delete"。"" （空）表示全部。 |
|
|
| namespace 是所请求操作的命名空间。目前，对于集群范围的资源 "" (empty)，没有命名空间和所有命名空间"" （空）之间的差别，对于集群范围的资源 "" （空）代表"all"表示来自 SubjectAccessReview 或 SelfSubjectAccessReview 的命名空间范围资源 |
|
|
| 资源是现有资源类型之一。"*"表示全部。 |
|
|
| 子资源是现有资源类型之一。""表示 none。 |
|
|
| verb 是一个 kubernetes 资源 API 动词，如： get, list, watch, create, update, delete, proxy. "*" 表示所有。 |
|
|
| version 是资源的 API 版本。"*"表示所有。 |
7.1.4. .spec.tasks
- 描述
- Task (Task)是用户完成快速入门必须执行的步骤列表。
- 类型
-
array
7.1.5. .spec.tasks[]
- 描述
- ConsoleQuickStartTask 是快速入门中的一个步骤。
- 类型
-
object - 必填
-
description -
title
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| Description 描述了完成任务所需的步骤。（包括标记） |
|
|
| 检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否"，这指示步骤是否已成功完成。 |
|
|
| Summary 包含有关传递步骤的信息。 |
|
|
| title 描述了任务，显示为步骤标题。 |
7.1.6. .spec.tasks[].review
- 描述
- 检查包含验证任务是否完成的说明。用户将使用单选按钮选择"是"或"否"，这指示步骤是否已成功完成。
- 类型
-
object - 必填
-
failedTaskHelp -
说明
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failedTaskHelp 包含失败任务检查的建议，并在任务末尾显示。（包括标记） |
|
|
| 指令包含用户在完成任务后需要采取的步骤（包括标记） |
7.1.7. .spec.tasks[].summary
- 描述
- Summary 包含有关传递步骤的信息。
- 类型
-
object - 必填
-
失败 -
success
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| failed 简要描述了未成功通过的任务。（包括标记） |
|
|
| 成功描述了 succesfully passed 的任务。 |
