红帽全球峰会30.5. BuildRequest [build.openshift.io/v1]
- 描述
- BuildRequest 是用于将参数传递给构建生成器的资源
- 类型
-
对象
30.5.1. 规格
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值，并可拒绝未识别的值。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
| BinaryBuildSource 描述了用于 Docker 和 Source 构建策略的二进制文件，其中将提取并用作构建源。 |
|
|
| DockerStrategyOptions 包含容器镜像构建的额外策略选项 |
|
| env 包含您要传递给构建器容器的其他环境变量。 | |
|
| from 是触发构建的 ImageStreamTag 的引用。 | |
|
|
| kind 是一个字符串值，代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息： https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
|
| lastVersion （可选）是 BuildConfig 的 LastVersion，用于生成构建。如果生成器中的 BuildConfig 不匹配，则不会生成构建。 |
|
| ||
|
|
| SourceRevision 是构建的源的修订或提交信息 |
|
|
| SourceStrategyOptions 包含 Source 构建的额外策略选项 |
|
|
| triggerBy 描述了哪些触发器启动对构建配置的最新更新，并包含有关这些触发器的信息。 |
|
|
| BuildTriggerCause 包含有关触发构建的信息。它可用于在 oc describe 中显示每个构建和构建配置的构建触发器数据。它还用于描述哪些触发器导致构建配置中最新更新。 |
|
| triggerByImage 是触发此构建的镜像。 |
30.5.1.1. .binary
- 描述
- BinaryBuildSource 描述了用于 Docker 和 Source 构建策略的二进制文件，其中将提取并用作构建源。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
|
asFile 表示提供的二进制输入应被视为构建输入中的单个文件。例如，指定 "webapp.war" 会将提供的二进制文件设置为构建器的 |
30.5.1.2. .dockerStrategyOptions
- 描述
- DockerStrategyOptions 包含容器镜像构建的额外策略选项
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
| args 包含要传递给 Docker 的任何构建参数。详情请查看 https://docs.docker.com/engine/reference/builder/#/arg | |
|
|
| noCache 覆盖构建配置中的 docker-strategy noCache 选项 |
30.5.1.3. .revision
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象 - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.5.1.4. .revision.git
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| commit 是识别特定提交的提交哈希 |
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| Message 是特定提交的描述 |
30.5.1.5. .revision.git.author
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.6. .revision.git.committer
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.7. .sourceStrategyOptions
- 描述
- SourceStrategyOptions 包含 Source 构建的额外策略选项
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 增量覆盖构建配置中的 source-strategy 增量选项 |
30.5.1.8. .triggeredBy
- 描述
- triggerBy 描述了哪些触发器启动对构建配置的最新更新，并包含有关这些触发器的信息。
- 类型
-
数组
30.5.1.9. .triggeredBy[]
- 描述
- BuildTriggerCause 包含有关触发构建的信息。它可用于在 oc describe 中显示每个构建和构建配置的构建触发器数据。它还用于描述哪些触发器导致构建配置中最新更新。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| BitbucketWebHookCause 包含有关触发构建的 Bitbucket Webhook 的信息。 |
|
|
| GenericWebHookCause 包含有关触发构建的通用 WebHook 的信息。 |
|
|
| GitHubWebHookCause 包含有关触发构建的 GitHub Webhook 的信息。 |
|
|
| GitLabWebHookCause 包含有关触发构建的 GitLab Webhook 的信息。 |
|
|
| ImageChangeCause 包含有关触发构建的镜像的信息 |
|
|
| 消息用于存储触发构建的原因的人类可读消息。例如："Manually trigger by user", "Configuration change",etc. |
30.5.1.10. .triggeredBy[].bitbucketWebHook
- 描述
- BitbucketWebHookCause 包含有关触发构建的 Bitbucket Webhook 的信息。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceRevision 是构建的源的修订或提交信息 |
|
|
| secret 是触发构建的模糊处理 Webhook secret。 |
30.5.1.11. .triggeredBy[].bitbucketWebHook.revision
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象 - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.5.1.12. .triggeredBy[].bitbucketWebHook.revision.git
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| commit 是识别特定提交的提交哈希 |
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| Message 是特定提交的描述 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.15. .triggeredBy[].genericWebHook
- 描述
- GenericWebHookCause 包含有关触发构建的通用 WebHook 的信息。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceRevision 是构建的源的修订或提交信息 |
|
|
| secret 是触发构建的模糊处理 Webhook secret。 |
30.5.1.16. .triggeredBy[].genericWebHook.revision
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象 - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.5.1.17. .triggeredBy[].genericWebHook.revision.git
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| commit 是识别特定提交的提交哈希 |
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| Message 是特定提交的描述 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.20. .triggeredBy[].githubWebHook
- 描述
- GitHubWebHookCause 包含有关触发构建的 GitHub Webhook 的信息。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceRevision 是构建的源的修订或提交信息 |
|
|
| secret 是触发构建的模糊处理 Webhook secret。 |
30.5.1.21. .triggeredBy[].githubWebHook.revision
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象 - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.5.1.22. .triggeredBy[].githubWebHook.revision.git
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| commit 是识别特定提交的提交哈希 |
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| Message 是特定提交的描述 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.25. .triggeredBy[].gitlabWebHook
- 描述
- GitLabWebHookCause 包含有关触发构建的 GitLab Webhook 的信息。
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceRevision 是构建的源的修订或提交信息 |
|
|
| secret 是触发构建的模糊处理 Webhook secret。 |
30.5.1.26. .triggeredBy[].gitlabWebHook.revision
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象 - 必填
-
type
-
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.5.1.27. .triggeredBy[].gitlabWebHook.revision.git
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| commit 是识别特定提交的提交哈希 |
|
|
| SourceControlUser 定义源控制用户的身份 |
|
|
| Message 是特定提交的描述 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
|
| 源控制用户的电子邮件 |
|
|
| 源控制用户的名称 |
30.5.1.30. .triggeredBy[].imageChangeBuild
- 描述
- ImageChangeCause 包含有关触发构建的镜像的信息
- 类型
-
对象
| 属性 | 类型 | 描述 |
|---|---|---|
|
| fromRef 包含有关触发构建的镜像的详细信息。 | |
|
|
| imageID 是触发新构建的镜像的 ID。 |
30.5.2. API 端点
可用的 API 端点如下：
/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/clone-
POST：创建构建克隆
-
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate-
POST：创建 BuildConfig 实例化
-
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| BuildRequest 的名称 |
|
|
| 对象名称和身份验证范围，如团队和项目 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| 如果 'true'，则输出被用户友善。 |
- HTTP 方法
-
POST - 描述
- 创建构建克隆
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
| HTTP 代码 | 响应正文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| BuildRequest 的名称 |
|
|
| 对象名称和身份验证范围，如团队和项目 |
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
| 出现时，表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应，且请求不会被进一步处理。有效值为： - All: 所有预演阶段都将被处理 |
|
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长，且仅包含可打印的字符，如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
|
|
| 如果 'true'，则输出被用户友善。 |
- HTTP 方法
-
POST - 描述
- 创建 BuildConfig 实例化
| 参数 | 类型 | 描述 |
|---|---|---|
|
|
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}