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

控制台示例 [console.openshift.io/v1]

描述

ConsoleSample 是通过添加示例来定制 OpenShift Web 控制台的扩展。兼容性级别 1：在主要版本中至少稳定 12 个月或 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

元数据

ObjectMeta

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

spec

对象

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

.spec

描述

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

类型

对象

必需

  • 摘要

  • 描述

  • 源

  • 标题

属性 类型 描述

摘要

字符串

摘要是对示例的简短介绍。这是必需的，长度不得超过 100 个字符。摘要显示在标题和提供者下方的示例卡片图块上，内容限制为三行。

描述

字符串

描述是对示例的详细解释。这是必需的，最大长度为**4096**个字符。它是类似于 README.md 的内容，用于提供附加信息、链接、先决条件和其他说明。它将被渲染为 Markdown，以便它可以包含换行符、链接和其他简单的格式。

图标

字符串

icon 是一个可选的 base64 编码图像，显示在示例标题旁边。格式必须遵循 data: URL 格式，最大大小为**10 KB**。data:[<mediatype>][;base64],<base64 编码图像> 例如：data:image;base64, 加上 base64 编码图像。也可以使用矢量图像。SVG 图标必须以以下开头：data:image/svg+xml;base64, 加上 base64 编码的 SVG 图像。所有示例目录图标都将在白色背景上显示（即使使用深色主题也是如此）。Web 控制台确保不同的纵横比能够正常工作。目前，图标的表面最多为 40x100px。有关 data URL 格式的更多信息，请访问https://mdn.org.cn/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs。

提供者

字符串

provider 是一个可选标签，用于表彰谁提供了该示例。它是可选的，长度不得超过 50 个字符。提供者可以是像“Red Hat”这样的公司，也可以是像“CNCF”或“Knative”这样的组织。目前，提供者只在标题下方的示例卡片图块上显示，前缀为“由…提供”。

源

对象

source 定义了从哪里部署示例服务。示例可以来自外部 git 仓库或容器镜像。

标签

数组（字符串）

tags 是可选的字符串值，可用于在示例目录中查找示例。常用标签的示例可能包括“Java”、“Quarkus”等。它们将显示在示例详细信息页面上。

标题

字符串

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

类型

字符串

type 是一个可选标签，用于对多个示例进行分组。它是可选的，长度不得超过 20 个字符。建议使用单数词语，例如“构建器镜像”、“Devfile”或“无服务器函数”。目前，类型显示在示例卡片图块右上角的徽章上。

.spec.source

描述

source 定义了从哪里部署示例服务。示例可以来自外部 git 仓库或容器镜像。

类型

对象

必需

  • 类型

属性 类型 描述

containerImport

对象

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

gitImport

对象

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

类型

字符串

示例的类型，当前支持：“GitImport”；“ContainerImport”

.spec.source.containerImport

描述

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

类型

对象

必需

  • 镜像

属性 类型 描述

镜像

字符串

引用提供 HTTP 服务的容器镜像。除非使用 port 字段进行其他配置，否则服务必须在默认端口 (8080) 上公开。支持的格式：- <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 包含为此示例创建的服务资源的配置。

.spec.source.containerImport.service

描述

service 包含为此示例创建的服务资源的配置。

类型

对象

属性 类型 描述

目标端口

整数

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

.spec.source.gitImport

描述

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

类型

对象

必需

  • 仓库

属性 类型 描述

仓库

对象

repository 包含对实际 Git 仓库的引用。

服务

对象

service 包含为此示例创建的服务资源的配置。

.spec.source.gitImport.repository

描述

repository 包含对实际 Git 仓库的引用。

类型

对象

必需

  • URL

属性 类型 描述

contextDir

字符串

contextDir 用于指定仓库中用于构建组件的目录。必须以/开头，长度最多为 256 个字符。省略时，默认值为从仓库的根目录构建。

版本

字符串

revision 是克隆 Git 仓库的 Git 版本。可用于克隆特定的分支、标签或提交 SHA。长度最多为 256 个字符。省略时，将使用仓库的默认分支。

URL

字符串

包含 HTTP 服务的 Git 仓库的 URL。除非使用 port 字段进行其他配置，否则 HTTP 服务必须在默认端口 (8080) 上公开。目前仅支持 GitHub、GitLab 和 Bitbucket 上的公共仓库：- https://github.com/<org>/<repository>; - https://gitlab.com/<org>/<repository>; - https://bitbucket.org/<org>/<repository>; URL 的最大长度为 256 个字符。

.spec.source.gitImport.service

描述

service 包含为此示例创建的服务资源的配置。

类型

对象

属性 类型 描述

目标端口

整数

targetPort 是服务侦听 HTTP 请求的端口。此端口将用于为此示例创建的服务。端口必须在 1 到 65535 的范围内。默认端口为 8080。

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

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

HTTP 方法

DELETE

描述

删除 ConsoleSample 集合

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

200 - OK

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

列出 ConsoleSample 对象

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

200 - OK

ConsoleSampleList 模式

401 - 未授权

空
HTTP 方法

POST

描述

创建一个 ConsoleSample

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

ConsoleSample 模式

201 - 已创建

ConsoleSample 模式

202 - 已接受

ConsoleSample 模式

401 - 未授权

空

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

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

name

字符串

ConsoleSample 的名称
HTTP 方法

DELETE

描述

删除一个 ConsoleSample

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

dryRun

字符串

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

200 - OK

Status 模式

202 - 已接受

Status 模式

401 - 未授权

空
HTTP 方法

GET

描述

读取指定的 ConsoleSample

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

200 - OK

ConsoleSample 模式

401 - 未授权

空
HTTP 方法

PATCH

描述

部分更新指定的 ConsoleSample

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

dryRun

字符串

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

fieldValidation

字符串

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

200 - OK

ConsoleSample 模式

401 - 未授权

空
HTTP 方法

PUT

描述

替换指定的 ConsoleSample

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

dryRun

字符串

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

fieldValidation

字符串

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

body

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

200 - OK

ConsoleSample 模式

201 - 已创建

ConsoleSample 模式

401 - 未授权

空