8.4. Build [config.openshift.io/v1]


描述
Build 为整个集群配置 OpenShift 构建的行为。这包括可在 BuildConfig 对象中覆盖的默认设置,并覆盖适用于所有构建。规范名称为"集群"兼容性级别 1:在主发行版本中至少有 12 个月或 3 个次版本(以更长的时间为准)。
类型
对象
必填
  • spec

8.4.1. 规格

Expand
属性类型描述

apiVersion

字符串

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

kind

字符串

kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

metadata

ObjectMeta_v2

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

spec

对象

spec 包含构建控制器配置的用户可设置值

8.4.1.1. .spec

描述
spec 包含构建控制器配置的用户可设置值
类型
对象
Expand
属性类型描述

additionalTrustedCA

对象

additionalTrustedCA 是对包含额外 CA 的 ConfigMap 的引用,它应该可以被信任,以便在构建期间进行镜像拉取。此配置映射的命名空间是 openshift-config。DEPRECATED: 在 image.config.openshift.io/cluster 上应设置用于镜像拉取和推送的额外 CA。

buildDefaults

对象

buildDefaults 控制构建的默认信息

buildOverrides

对象

buildOverrides 控制构建的覆盖设置

8.4.1.2. .spec.additionalTrustedCA

描述
additionalTrustedCA 是对包含额外 CA 的 ConfigMap 的引用,它应该可以被信任,以便在构建期间进行镜像拉取。此配置映射的命名空间是 openshift-config。DEPRECATED: 在 image.config.openshift.io/cluster 上应设置用于镜像拉取和推送的额外 CA。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

8.4.1.3. .spec.buildDefaults

描述
buildDefaults 控制构建的默认信息
类型
对象
Expand
属性类型描述

defaultProxy

对象

defaultProxy 包含所有构建操作的默认代理设置,包括镜像拉取/推送和源下载。通过在构建配置策略中设置 HTTP_PROXYHTTPS_PROXYNO_PROXY 环境变量,可以过度使用值。

env

array

env 是一组默认环境变量,如果构建中不存在指定的变量,将应用于构建。

env[]

对象

EnvVar 代表容器中存在的环境变量。

gitProxy

对象

gitProxy 仅包含 git 操作的代理设置。如果设置,这将覆盖所有 git 命令的任何代理设置,如 git clone。此处未设置的值将从 DefaultProxy 继承。

imageLabels

array

imageLabels 是应用于生成的镜像的 docker 标签列表。用户可以通过在其 Build/BuildConfig 中提供具有相同名称的标签来覆盖默认标签。

imageLabels[]

对象

 

资源

对象

资源定义执行构建的资源要求。

8.4.1.4. .spec.buildDefaults.defaultProxy

描述
defaultProxy 包含所有构建操作的默认代理设置,包括镜像拉取/推送和源下载。通过在构建配置策略中设置 HTTP_PROXYHTTPS_PROXYNO_PROXY 环境变量,可以过度使用值。
类型
对象
Expand
属性类型描述

httpProxy

字符串

httpProxy 是 HTTP 请求的代理的 URL。空表示未设置,且不会导致 env 变量。

httpsProxy

字符串

httpsProxy 是 HTTPS 请求的代理的 URL。空表示未设置,且不会导致 env 变量。

noProxy

字符串

noProxy 是不应为其使用代理的主机名和/或 CIDR 和/或 IP 的逗号分隔列表。空表示未设置,且不会导致 env 变量。

readinessEndpoints

数组(字符串)

readinessEndpoints 是用于验证代理就绪度的端点列表。

trustedCA

对象

trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 读取证书捆绑包,将其与系统默认信任捆绑包合并,并在 "openshift-config-managed" 命名空间中将合并的信任捆绑包写入名为 "trusted-ca-bundle" 的 ConfigMap。期望代理连接的客户端必须使用 trusted-ca-bundle 进行代理的所有 HTTPS 请求,也可以使用 trusted-ca-bundle 进行非代理 HTTPS 请求。trustedCA 引用的 ConfigMap 的命名空间是 "openshift-config"。以下是一个 ConfigMap 示例(在 yaml 中):api1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

8.4.1.5. .spec.buildDefaults.defaultProxy.trustedCA

描述
trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 读取证书捆绑包,将其与系统默认信任捆绑包合并,并在 "openshift-config-managed" 命名空间中将合并的信任捆绑包写入名为 "trusted-ca-bundle" 的 ConfigMap。期望代理连接的客户端必须使用 trusted-ca-bundle 进行代理的所有 HTTPS 请求,也可以使用 trusted-ca-bundle 进行非代理 HTTPS 请求。trustedCA 引用的 ConfigMap 的命名空间是 "openshift-config"。以下是一个 ConfigMap 示例(在 yaml 中):api1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

8.4.1.6. .spec.buildDefaults.env

描述
env 是一组默认环境变量,如果构建中不存在指定的变量,将应用于构建。
类型
array

8.4.1.7. .spec.buildDefaults.env[]

描述
EnvVar 代表容器中存在的环境变量。
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

环境变量的名称。必须是 C_IDENTIFIER。

value

字符串

变量引用 $(VAR_NAME)使用容器中之前定义的环境变量以及任何服务环境变量进行扩展。如果无法解析变量,则输入字符串中的引用不会改变。双击单个 $,它允许转义 $(VAR_NAME)语法:例如 " (VAR_NAME) " 将生成字符串 literal "$(VAR_NAME) "。转义的引用永远不会扩展,无论变量是否存在。默认值为 ""。

valueFrom

对象

环境变量值的源。如果值不为空,则无法使用。

8.4.1.8. .spec.buildDefaults.env[].valueFrom

描述
环境变量值的源。如果值不为空,则无法使用。
类型
对象
Expand
属性类型描述

configMapKeyRef

对象

选择 ConfigMap 的键。

fieldRef

对象

选择 pod 的字段:支持 metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs。

resourceFieldRef

对象

选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limit.memory、limit.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。

secretKeyRef

对象

在 pod 命名空间中选择一个 secret 的密钥

描述
选择 ConfigMap 的键。
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要选择的键。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 ConfigMap 还是其密钥

8.4.1.10. .spec.buildDefaults.env[].valueFrom.fieldRef

描述
选择 pod 的字段:支持 metadata.name, metadata.namespace, metadata.labels['<KEY>'], metadata.annotations['<KEY>'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs。
类型
对象
必填
  • fieldPath
Expand
属性类型描述

apiVersion

字符串

FieldPath 编写的模式版本,默认为 "v1"。

fieldPath

字符串

要在指定 API 版本中选择的字段路径。

描述
选择容器的资源:当前仅支持资源限值和请求(limits.cpu、limit.memory、limit.ephemeral-storage、request.cpu、request.memory 和 requests.ephemeral-storage)。
类型
对象
必填
  • resource
Expand
属性类型描述

containerName

字符串

容器名称:卷需要,对于 env vars 是可选的

divisor

integer-or-string

指定公开资源的输出格式,默认为 "1"

resource

字符串

必需:要选择的资源

8.4.1.12. .spec.buildDefaults.env[].valueFrom.secretKeyRef

描述
在 pod 命名空间中选择一个 secret 的密钥
类型
对象
必填
  • key
Expand
属性类型描述

key

字符串

要从中选择的 secret 的密钥。必须是一个有效的 secret 密钥。

name

字符串

引用的名称。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names,添加其他有用的字段。api、kind、uid?

optional

布尔值

指定是否必须定义 Secret 还是其密钥

8.4.1.13. .spec.buildDefaults.gitProxy

描述
gitProxy 仅包含 git 操作的代理设置。如果设置,这将覆盖所有 git 命令的任何代理设置,如 git clone。此处未设置的值将从 DefaultProxy 继承。
类型
对象
Expand
属性类型描述

httpProxy

字符串

httpProxy 是 HTTP 请求的代理的 URL。空表示未设置,且不会导致 env 变量。

httpsProxy

字符串

httpsProxy 是 HTTPS 请求的代理的 URL。空表示未设置,且不会导致 env 变量。

noProxy

字符串

noProxy 是不应为其使用代理的主机名和/或 CIDR 和/或 IP 的逗号分隔列表。空表示未设置,且不会导致 env 变量。

readinessEndpoints

数组(字符串)

readinessEndpoints 是用于验证代理就绪度的端点列表。

trustedCA

对象

trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 读取证书捆绑包,将其与系统默认信任捆绑包合并,并在 "openshift-config-managed" 命名空间中将合并的信任捆绑包写入名为 "trusted-ca-bundle" 的 ConfigMap。期望代理连接的客户端必须使用 trusted-ca-bundle 进行代理的所有 HTTPS 请求,也可以使用 trusted-ca-bundle 进行非代理 HTTPS 请求。trustedCA 引用的 ConfigMap 的命名空间是 "openshift-config"。以下是一个 ConfigMap 示例(在 yaml 中):api1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----

8.4.1.14. .spec.buildDefaults.gitProxy.trustedCA

描述
trustedCA 是对包含 CA 证书捆绑包的 ConfigMap 的引用。trustedCA 字段应仅由代理验证器使用。验证器负责从所需的键 "ca-bundle.crt" 读取证书捆绑包,将其与系统默认信任捆绑包合并,并在 "openshift-config-managed" 命名空间中将合并的信任捆绑包写入名为 "trusted-ca-bundle" 的 ConfigMap。期望代理连接的客户端必须使用 trusted-ca-bundle 进行代理的所有 HTTPS 请求,也可以使用 trusted-ca-bundle 进行非代理 HTTPS 请求。trustedCA 引用的 ConfigMap 的命名空间是 "openshift-config"。以下是一个 ConfigMap 示例(在 yaml 中):api1 kind: ConfigMap metadata: name: user-ca-bundle namespace: openshift-config data: ca-bundle.crt: | -----BEGIN CERTIFICATE----- Custom CA certificate bundle. -----END CERTIFICATE-----
类型
对象
必填
  • name
Expand
属性类型描述

name

字符串

name 是引用的配置映射的 metadata.name

8.4.1.15. .spec.buildDefaults.imageLabels

描述
imageLabels 是应用于生成的镜像的 docker 标签列表。用户可以通过在其 Build/BuildConfig 中提供具有相同名称的标签来覆盖默认标签。
类型
array

8.4.1.16. .spec.buildDefaults.imageLabels[]

描述
类型
对象
Expand
属性类型描述

name

字符串

name 定义标签的名称。它必须具有非零长度。

value

字符串

value 定义标签的字面值。

8.4.1.17. .spec.buildDefaults.resources

描述
资源定义执行构建的资源要求。
类型
对象
Expand
属性类型描述

limits

integer-or-string

限制描述了允许的最大计算资源量。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

requests

integer-or-string

Requests 描述了所需的最少计算资源。如果容器省略了 Requests,则默认为 Limits (如果明确指定),否则默认为实现定义的值。更多信息: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

8.4.1.18. .spec.buildOverrides

描述
buildOverrides 控制构建的覆盖设置
类型
对象
Expand
属性类型描述

forcePull

布尔值

forcePull 覆盖,如果设置,构建中的等效值,即 false 禁用所有构建的强制拉取,true 会为所有构建启用强制拉取,具体取决于每个构建指定本身的内容

imageLabels

array

imageLabels 是应用于生成的镜像的 docker 标签列表。如果用户在其 Build/BuildConfig 中提供了与此列表中名称相同的标签,则用户的标签将被覆盖。

imageLabels[]

对象

 

nodeSelector

对象(字符串)

nodeSelector 是一个选择器,必须为 true 才能使构建 pod 适合某个节点

容限(tolerations)

array

容限(toleration)是一个容限列表,它将覆盖构建 pod 中设置的现有容限。

tolerations[]

对象

附加此 Toleration 的 pod,以使用匹配的 operator <operator> 来容许与 triple <key,value,effect> 匹配的任何污点。

8.4.1.19. .spec.buildOverrides.imageLabels

描述
imageLabels 是应用于生成的镜像的 docker 标签列表。如果用户在其 Build/BuildConfig 中提供了与此列表中名称相同的标签,则用户的标签将被覆盖。
类型
array

8.4.1.20. .spec.buildOverrides.imageLabels[]

描述
类型
对象
Expand
属性类型描述

name

字符串

name 定义标签的名称。它必须具有非零长度。

value

字符串

value 定义标签的字面值。

8.4.1.21. .spec.buildOverrides.tolerations

描述
容限(toleration)是一个容限列表,它将覆盖构建 pod 中设置的现有容限。
类型
array

8.4.1.22. .spec.buildOverrides.tolerations[]

描述
附加此 Toleration 的 pod,以使用匹配的 operator <operator> 来容许与 triple <key,value,effect> 匹配的任何污点。
类型
对象
Expand
属性类型描述

effect

字符串

effect 表示污点效果要匹配的污点。空意味着匹配所有污点效果。指定后,允许的值为 NoSchedule、PreferNoSchedule 和 NoExecute。

key

字符串

key 是容限应用到的污点键。empty 表示与所有污点键匹配。如果键为空,运算符必须是 Exists;此组合意味着匹配所有值和所有键。

operator

字符串

运算符表示键与值的关系。有效的运算符为 Exists 和 Equal。默认值为 Equal。exists 等同于值的通配符,以便 pod 可以容忍特定类别的所有污点。

tolerationSeconds

整数

tolerationSeconds 代表容限(必须具有 NoExecute effect,否则此字段将被忽略)容许污点的时间周期。默认情况下,它没有被设置,这意味着容许污点(不要驱除)。零值和负值将被视为系统 0 (立即撤离)。

value

字符串

value 是容限匹配的污点值。如果运算符是 Exists,则该值应该为空,否则仅是一个常规字符串。

8.4.2. API 端点

可用的 API 端点如下:

  • /apis/config.openshift.io/v1/builds

    • DELETE :删除构建的集合
    • GET: 列出 Build 类型的对象
    • POST :创建构建
  • /apis/config.openshift.io/v1/builds/{name}

    • DELETE :删除构建
    • GET :读取指定的构建
    • PATCH :部分更新指定的构建
    • PUT :替换指定的构建
  • /apis/config.openshift.io/v1/builds/{name}/status

    • GET: 指定 Build 的读取状态
    • PATCH :部分更新指定构建的状态
    • PUT: 替换指定构建的状态

8.4.2.1. /apis/config.openshift.io/v1/builds

Expand
表 8.63. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除构建集合
Expand
表 8.64. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.65. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
列出构建类型的对象
Expand
表 8.66. 查询参数
参数类型描述

allowWatchBookmarks

布尔值

allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。

继续

字符串

从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。

当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。

fieldSelector

字符串

用于限制返回的对象列表的选择器。默认为任何内容。

labelSelector

字符串

通过标签限制返回的对象列表的选择器。默认为任何内容。

limit

整数

限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。

服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

resourceVersionMatch

字符串

resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

timeoutSeconds

整数

list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。

watch

布尔值

观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。

Expand
表 8.67. HTTP 响应
HTTP 代码响应正文

200 - OK

BuildList 模式

401 - Unauthorized

HTTP 方法
POST
描述
创建构建
Expand
表 8.68. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.69. 主体参数
参数类型描述

正文(body)

Build 模式

 
Expand
表 8.70. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

201 - Created

Build 模式

202 - Accepted

Build 模式

401 - Unauthorized

8.4.2.2. /apis/config.openshift.io/v1/builds/{name}

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

name

字符串

构建的名称

Expand
表 8.72. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
DELETE
描述
删除构建
Expand
表 8.73. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

gracePeriodSeconds

整数

应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。

orphanDependents

布尔值

弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。

propagationPolicy

字符串

是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。

Expand
表 8.74. 主体参数
参数类型描述

正文(body)

DeleteOptions_v2 schema

 
Expand
表 8.75. HTTP 响应
HTTP 代码响应正文

200 - OK

Status_v2 模式

202 - Accepted

Status_v2 模式

401 - Unauthorized

HTTP 方法
GET
描述
读取指定的构建
Expand
表 8.76. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.77. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
部分更新指定的构建
Expand
表 8.78. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.79. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.80. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定的构建
Expand
表 8.81. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.82. 主体参数
参数类型描述

正文(body)

Build 模式

 
Expand
表 8.83. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

201 - Created

Build 模式

401 - Unauthorized

8.4.2.3. /apis/config.openshift.io/v1/builds/{name}/status

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

name

字符串

构建的名称

Expand
表 8.85. 全局查询参数
参数类型描述

pretty

字符串

如果 'true',则输出被用户友善。

HTTP 方法
GET
描述
指定构建的读取状态
Expand
表 8.86. 查询参数
参数类型描述

resourceVersion

字符串

resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions

默认为未设置

Expand
表 8.87. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

401 - Unauthorized

HTTP 方法
PATCH
描述
指定构建的部分更新状态
Expand
表 8.88. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.89. 主体参数
参数类型描述

正文(body)

Patch 模式

 
Expand
表 8.90. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

401 - Unauthorized

HTTP 方法
PUT
描述
替换指定构建的状态
Expand
表 8.91. 查询参数
参数类型描述

dryRun

字符串

出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理

fieldManager

字符串

fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。

Expand
表 8.92. 主体参数
参数类型描述

正文(body)

Build 模式

 
Expand
表 8.93. HTTP 响应
HTTP 代码响应正文

200 - OK

Build 模式

201 - Created

Build 模式

401 - Unauthorized

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat