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

abstract

string

abstract 是示例的一个简短介绍。

它是必需的，且长度不得超过 100 个字符。

抽象显示在标题和提供程序下面的卡标题上，仅限于三行内容。

description

string

description 是示例的长形式说明。

它是必需的，且最大长度为 4096 个字符。

它是一个与 README.md 类似的内容，用于其他信息、链接、前提条件和其他说明。它将呈现为 Markdown，以便它可以包含换行符、链接和其他简单格式。

icon

string

图标是一个可选的 base64 编码镜像，显示在示例标题旁边。

格式必须采用数据：URL 格式，并且最大大小为 10 KB。

data:[<mediatype>][;base64],<base64 encoded image>

例如：

data:image;base64 加上 base64 编码的镜像。

也可以使用向量镜像。SVG 图标必须以以下开头：

data:image/svg+xml;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"。

目前，该类型在右上角的示例卡标题上显示一个徽标。

containerImport

object

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

gitImport

object

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

type

string

示例类型，目前支持："GitImport";"ContainerImport"

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 资源的配置。

targetPort

整数

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

软件仓库

object

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

service

object

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

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> - https://gitlab.com/<org>/<repository> - https://bitbucket.org/<org>/<repository>

url 必须最大长度为 256 个字符。

targetPort

整数

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