OpenShift 文档正在迁移，很快将只能在 docs.redhat.com（所有 Red Hat 产品文档的首页）访问。立即体验 新的文档体验。
  1. 文档
    2. history bug_report picture_as_pdf
×

构建请求 [build.openshift.io/v1]

规格

属性 类型 描述

apiVersion

字符串

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

binary

对象

BinaryBuildSource 描述了要用于 Docker 和 Source 构建策略的二进制文件，其中该文件将被提取并用作构建源。

dockerStrategyOptions

对象

DockerStrategyOptions 包含容器镜像构建的额外策略选项。

env

数组 (EnvVar)

env 包含您想要传递到构建器容器中的其他环境变量。

from

ObjectReference

from 是触发构建的 ImageStreamTag 的引用。

kind

字符串

Kind 是一个字符串值，表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰命名法。更多信息：https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

lastVersion

整数

lastVersion（可选）是用于生成构建的 BuildConfig 的 LastVersion。如果生成器中的 BuildConfig 不匹配，则不会生成构建。

metadata

ObjectMeta_v2

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

revision

对象

SourceRevision 是构建源的修订或提交信息。

sourceStrategyOptions

对象

SourceStrategyOptions 包含 Source 构建的额外策略选项。

triggeredBy

数组

triggeredBy 描述了哪些触发器启动了对构建配置的最新更新，并包含有关这些触发器的信息。

triggeredBy[]

对象

BuildTriggerCause 包含有关已触发构建的信息。它用于显示每个构建和构建配置中 oc describe 的构建触发器数据。它还用于描述哪些触发器导致了构建配置中的最新更新。

triggeredByImage

ObjectReference

triggeredByImage 是触发此构建的镜像。

.binary

描述

BinaryBuildSource 描述了要用于 Docker 和 Source 构建策略的二进制文件，其中该文件将被提取并用作构建源。

类型

对象

属性 类型 描述

asFile

字符串

asFile 指示提供的二进制输入应被视为构建输入中的单个文件。例如，指定“webapp.war”会将提供的二进制文件放置为构建器的/webapp.war。如果留空，Docker 和 Source 构建策略假定此文件是 zip、tar 或 tar.gz 文件，并将其解压缩为源代码。自定义策略接收此二进制文件作为标准输入。此文件名不能包含斜杠或为“..”或“.”。

.dockerStrategyOptions

描述

DockerStrategyOptions 包含容器镜像构建的额外策略选项。

类型

对象

属性 类型 描述

buildArgs

数组 (EnvVar)

Args 包含要传递给 Docker 的任何构建参数。有关更多详细信息，请参阅https://docs.docker.net.cn/engine/reference/builder/#/arg

noCache

布尔值

noCache 覆盖构建配置中的 docker-strategy noCache 选项。

.revision

描述

SourceRevision 是构建源的修订或提交信息。

类型

对象

必需

  • 类型

属性 类型 描述

git

对象

GitSourceRevision 是构建的 git 源的提交信息。

类型

字符串

构建源的类型，可以是“Source”、“Dockerfile”、“Binary”或“Images”。

.revision.git

描述

GitSourceRevision 是构建的 git 源的提交信息。

类型

对象

属性 类型 描述

author

对象

SourceControlUser 定义源代码控制用户的身份。

commit

字符串

commit 是标识特定提交的提交哈希。

committer

对象

SourceControlUser 定义源代码控制用户的身份。

message

字符串

message 是特定提交的描述。

.revision.git.author

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.revision.git.committer

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.sourceStrategyOptions

描述

SourceStrategyOptions 包含 Source 构建的额外策略选项。

类型

对象

属性 类型 描述

incremental

布尔值

incremental 覆盖构建配置中的 source-strategy incremental 选项。

.triggeredBy

描述

triggeredBy 描述了哪些触发器启动了对构建配置的最新更新，并包含有关这些触发器的信息。

类型

数组

.triggeredBy[]

描述

BuildTriggerCause 包含有关已触发构建的信息。它用于显示每个构建和构建配置中 oc describe 的构建触发器数据。它还用于描述哪些触发器导致了构建配置中的最新更新。

类型

对象

属性 类型 描述

bitbucketWebHook

对象

BitbucketWebHookCause 包含触发构建的 Bitbucket Webhook 信息。

genericWebHook

对象

GenericWebHookCause 包含触发构建的通用 WebHook 信息。

githubWebHook

对象

GitHubWebHookCause 包含触发构建的 GitHub Webhook 信息。

gitlabWebHook

对象

GitLabWebHookCause 包含触发构建的 GitLab Webhook 信息。

imageChangeBuild

对象

ImageChangeCause 包含触发构建的镜像信息。

message

字符串

message 用于存储关于构建触发原因的人类可读消息。例如：“用户手动触发”、“配置更改”等。

.triggeredBy[].bitbucketWebHook

描述

BitbucketWebHookCause 包含触发构建的 Bitbucket Webhook 信息。

类型

对象

属性 类型 描述

revision

对象

SourceRevision 是构建源的修订或提交信息。

secret

字符串

Secret 是触发构建的已混淆的 Webhook 密钥。

.triggeredBy[].bitbucketWebHook.revision

描述

SourceRevision 是构建源的修订或提交信息。

类型

对象

必需

  • 类型

属性 类型 描述

git

对象

GitSourceRevision 是构建的 git 源的提交信息。

类型

字符串

构建源的类型，可以是“Source”、“Dockerfile”、“Binary”或“Images”。

.triggeredBy[].bitbucketWebHook.revision.git

描述

GitSourceRevision 是构建的 git 源的提交信息。

类型

对象

属性 类型 描述

author

对象

SourceControlUser 定义源代码控制用户的身份。

commit

字符串

commit 是标识特定提交的提交哈希。

committer

对象

SourceControlUser 定义源代码控制用户的身份。

message

字符串

message 是特定提交的描述。

.triggeredBy[].bitbucketWebHook.revision.git.author

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].bitbucketWebHook.revision.git.committer

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].genericWebHook

描述

GenericWebHookCause 包含触发构建的通用 WebHook 信息。

类型

对象

属性 类型 描述

revision

对象

SourceRevision 是构建源的修订或提交信息。

secret

字符串

secret 是触发构建的已混淆的 Webhook 密钥。

.triggeredBy[].genericWebHook.revision

描述

SourceRevision 是构建源的修订或提交信息。

类型

对象

必需

  • 类型

属性 类型 描述

git

对象

GitSourceRevision 是构建的 git 源的提交信息。

类型

字符串

构建源的类型，可以是“Source”、“Dockerfile”、“Binary”或“Images”。

.triggeredBy[].genericWebHook.revision.git

描述

GitSourceRevision 是构建的 git 源的提交信息。

类型

对象

属性 类型 描述

author

对象

SourceControlUser 定义源代码控制用户的身份。

commit

字符串

commit 是标识特定提交的提交哈希。

committer

对象

SourceControlUser 定义源代码控制用户的身份。

message

字符串

message 是特定提交的描述。

.triggeredBy[].genericWebHook.revision.git.author

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].genericWebHook.revision.git.committer

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].githubWebHook

描述

GitHubWebHookCause 包含触发构建的 GitHub Webhook 信息。

类型

对象

属性 类型 描述

revision

对象

SourceRevision 是构建源的修订或提交信息。

secret

字符串

secret 是触发构建的已混淆的 Webhook 密钥。

.triggeredBy[].githubWebHook.revision

描述

SourceRevision 是构建源的修订或提交信息。

类型

对象

必需

  • 类型

属性 类型 描述

git

对象

GitSourceRevision 是构建的 git 源的提交信息。

类型

字符串

构建源的类型，可以是“Source”、“Dockerfile”、“Binary”或“Images”。

.triggeredBy[].githubWebHook.revision.git

描述

GitSourceRevision 是构建的 git 源的提交信息。

类型

对象

属性 类型 描述

author

对象

SourceControlUser 定义源代码控制用户的身份。

commit

字符串

commit 是标识特定提交的提交哈希。

committer

对象

SourceControlUser 定义源代码控制用户的身份。

message

字符串

message 是特定提交的描述。

.triggeredBy[].githubWebHook.revision.git.author

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].githubWebHook.revision.git.committer

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].gitlabWebHook

描述

GitLabWebHookCause 包含触发构建的 GitLab Webhook 信息。

类型

对象

属性 类型 描述

revision

对象

SourceRevision 是构建源的修订或提交信息。

secret

字符串

Secret 是触发构建的已混淆的 Webhook 密钥。

.triggeredBy[].gitlabWebHook.revision

描述

SourceRevision 是构建源的修订或提交信息。

类型

对象

必需

  • 类型

属性 类型 描述

git

对象

GitSourceRevision 是构建的 git 源的提交信息。

类型

字符串

构建源的类型，可以是“Source”、“Dockerfile”、“Binary”或“Images”。

.triggeredBy[].gitlabWebHook.revision.git

描述

GitSourceRevision 是构建的 git 源的提交信息。

类型

对象

属性 类型 描述

author

对象

SourceControlUser 定义源代码控制用户的身份。

commit

字符串

commit 是标识特定提交的提交哈希。

committer

对象

SourceControlUser 定义源代码控制用户的身份。

message

字符串

message 是特定提交的描述。

.triggeredBy[].gitlabWebHook.revision.git.author

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].gitlabWebHook.revision.git.committer

描述

SourceControlUser 定义源代码控制用户的身份。

类型

对象

属性 类型 描述

email

字符串

源代码控制用户的电子邮件。

name

字符串

源代码控制用户的名称。

.triggeredBy[].imageChangeBuild

描述

ImageChangeCause 包含触发构建的镜像信息。

类型

对象

属性 类型 描述

fromRef

ObjectReference

fromRef 包含触发构建的镜像的详细信息。

imageID

字符串

imageID 是触发新构建的镜像的 ID。

API 接口

以下 API 接口可用

  • /apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone

    • POST: 创建构建的克隆

  • /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

    • POST: 创建构建配置的实例

/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone

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

name

字符串

构建请求的名称
表 2. 全局查询参数
参数 类型 描述

dryRun

字符串

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

fieldValidation

字符串

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

POST

描述

创建构建的克隆

表 3. 请求体参数
参数 类型 描述

body

BuildRequest schema
表 4. HTTP 响应
HTTP 代码 响应体

200 - OK

BuildRequest schema

201 - Created

BuildRequest schema

202 - Accepted

BuildRequest schema

401 - Unauthorized

空

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

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

name

字符串

构建请求的名称
表 6. 全局查询参数
参数 类型 描述

dryRun

字符串

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

fieldValidation

字符串

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

POST

描述

创建构建配置的实例

表 7. 请求体参数
参数 类型 描述

body

BuildRequest schema
表 8. HTTP 响应
HTTP 代码 响应体

200 - OK

Build schema

201 - Created

Build schema

202 - Accepted

Build schema

401 - Unauthorized

空