Build 封装了生成新的可部署镜像所需的输入,以及执行状态和执行构建的 Pod 的引用。
兼容性级别 1:在主要版本中稳定至少 12 个月或 3 个次要版本(以较长者为准)。
Build 封装了生成新的可部署镜像所需的输入,以及执行状态和执行构建的 Pod 的引用。
兼容性级别 1:在主要版本中稳定至少 12 个月或 3 个次要版本(以较长者为准)。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
APIVersion 定义了此对象表示的版本化模式。服务器应将识别的模式转换为最新的内部值,并可能拒绝无法识别的值。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind 是一个字符串值,表示此对象表示的 REST 资源。服务器可以从客户端提交请求的端点推断出这一点。不能更新。使用驼峰式命名法。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
metadata 是标准对象的元数据。更多信息:https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
BuildSpec 包含表示构建的信息以及有关构建的其他信息。 |
|
|
BuildStatus 包含构建的状态。 |
BuildSpec 包含表示构建的信息以及有关构建的其他信息。
对象
strategy
属性 | 类型 | 描述 |
---|---|---|
|
|
completionDeadlineSeconds 是一个可选的秒数持续时间,从构建 pod 在系统中调度的时间开始计算,构建可以在节点上处于活动状态的时间,之后系统会主动尝试终止构建;值必须是正整数。 |
|
|
mountTrustedCA 将集群的受信任证书颁发机构(如集群的代理配置中所定义)绑定安装到构建中。这允许构建中的进程信任由自定义 PKI 证书颁发机构签名的组件,例如私有工件存储库和 HTTPS 代理。 当此字段设置为 true 时,构建中的 |
|
|
nodeSelector 是一个选择器,构建 pod 必须满足此选择器才能适应节点。如果为 nil,则可以被集群的默认构建节点选择器值覆盖。如果设置为空映射或包含任何值的映射,则忽略默认构建节点选择器值。 |
|
|
BuildOutput 是构建策略的输入,并描述策略应生成的容器镜像。 |
|
|
BuildPostCommitSpec 包含构建提交后钩子规范。钩子在镜像的最后一层提交后且在镜像推送到注册表之前,在一个运行构建输出镜像的临时容器中执行命令。命令的执行工作目录 ($PWD) 设置为镜像的 WORKDIR。 如果钩子执行失败,则构建将被标记为失败。如果脚本或命令返回非零退出代码,或者与启动临时容器相关的任何其他错误,它将失败。 有五种不同的方法来配置钩子。例如,以下所有形式都是等效的,并将执行 1. shell 脚本 "postCommit": { "script": "rake test --verbose", } 以上是一种便捷形式,等效于 "postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] } 2. 命令作为镜像入口点 "postCommit": { "commit": ["rake", "test", "--verbose"] } 命令覆盖 exec 形式中的镜像入口点,如 Docker 文档中所述:https://docs.docker.net.cn/engine/reference/builder/#entrypoint。 3. 将参数传递给默认入口点 "postCommit": { "args": ["rake", "test", "--verbose"] } 此形式仅在镜像入口点可以处理参数时才有用。 4. 带参数的 shell 脚本 "postCommit": { "script": "rake test $1", "args": ["--verbose"] } 如果您需要传递参数,否则难以在 shell 脚本中正确引用,则此形式很有用。在脚本中,$0 将是 "/bin/sh",$1、$2 等是来自 Args 的位置参数。 5. 带参数的命令 "postCommit": { "command": ["rake", "test"], "args": ["--verbose"] } 此形式等效于将参数附加到 Command 切片。 同时提供 Script 和 Command 是无效的。如果未指定任何字段,则不会执行钩子。 |
|
resources 计算执行构建所需的资源。 |
|
|
|
SourceRevision 是构建源的修订版或提交信息。 |
|
|
serviceAccount 是用于运行此构建创建的 pod 的 ServiceAccount 的名称。pod 将被允许使用 ServiceAccount 引用的密钥。 |
|
|
BuildSource 是用于构建的 SCM。 |
|
|
BuildStrategy 包含如何执行构建的详细信息。 |
|
|
triggeredBy 描述了哪些触发器启动了对构建配置的最新更新,并包含有关这些触发器的信息。 |
|
|
BuildTriggerCause 包含有关触发构建的信息。它用于显示每个构建和构建配置中 oc describe 的构建触发器数据。它还用于描述哪些触发器导致了构建配置中的最新更新。 |
BuildOutput 是构建策略的输入,并描述策略应生成的容器镜像。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
imageLabels 定义应用于结果镜像的标签列表。如果有多个同名标签,则使用列表中的最后一个标签。 |
|
|
ImageLabel 表示应用于结果镜像的标签。 |
|
PushSecret 是一个密钥的名称,该密钥将用于设置对启用身份验证的 Docker 注册表(或 Docker Hub)执行 Docker push 的身份验证。 |
|
|
to 定义一个可选位置,用于将此构建的输出推送到该位置。Kind 必须是 'ImageStreamTag' 或 'DockerImage' 之一。此值将用于查找要推送到其中的容器镜像存储库。对于 ImageStreamTag,除非指定 Namespace,否则将在构建的命名空间中查找 ImageStreamTag。 |
ImageLabel 表示应用于结果镜像的标签。
对象
name
属性 | 类型 | 描述 |
---|---|---|
|
|
name 定义标签的名称。它必须具有非零长度。 |
|
|
value 定义标签的字面值。 |
BuildPostCommitSpec 包含构建提交后钩子规范。钩子在镜像的最后一层提交后且在镜像推送到注册表之前,在一个运行构建输出镜像的临时容器中执行命令。命令的执行工作目录 ($PWD) 设置为镜像的 WORKDIR。
如果钩子执行失败,则构建将被标记为失败。如果脚本或命令返回非零退出代码,或者与启动临时容器相关的任何其他错误,它将失败。
有五种不同的方法来配置钩子。例如,以下所有形式都是等效的,并将执行rake test --verbose
。
shell 脚本
"postCommit": { "script": "rake test --verbose", }
The above is a convenient form which is equivalent to:
"postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }
命令作为镜像入口点
"postCommit": { "commit": ["rake", "test", "--verbose"] }
Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.net.cn/engine/reference/builder/#entrypoint.
将参数传递给默认入口点
"postCommit": { "args": ["rake", "test", "--verbose"] }
This form is only useful if the image entrypoint can handle arguments.
带参数的 shell 脚本
"postCommit": { "script": "rake test $1", "args": ["--verbose"] }
This form is useful if you need to pass arguments that would otherwise be hard to quote properly in the shell script. In the script, $0 will be "/bin/sh" and $1, $2, etc, are the positional arguments from Args.
带参数的命令
"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }
This form is equivalent to appending the arguments to the Command slice.
同时提供 Script 和 Command 是无效的。如果未指定任何字段,则不会执行钩子。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
args 是提供给 Command、Script 或容器镜像的默认入口点的参数列表。参数紧跟在要运行的命令之后。 |
|
|
command 是要运行的命令。它不能与 Script 一起指定。如果镜像没有 |
|
|
|
SourceRevision 是构建源的修订版或提交信息。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
|
GitSourceRevision 是构建的 git 源代码的提交信息。 |
|
|
构建源的类型,可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一。 |
GitSourceRevision 是构建的 git 源代码的提交信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
commit 是标识特定提交的提交哈希值。 |
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
message 是特定提交的描述。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
BuildSource 是用于构建的 SCM。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
BinaryBuildSource 描述一个将用于 Docker 和 Source 构建策略的二进制文件,该文件将被解压缩并用作构建源。 |
|
|
configMaps 表示将用于构建的 configMaps 列表及其目标。 |
|
|
ConfigMapBuildSource 描述一个 configmap 及其目标目录,这些目录仅在构建时使用。此处引用的 configmap 的内容将被复制到目标目录中,而不是挂载。 |
|
|
contextDir 指定应用程序源代码所在的子目录。这允许在除存储库根目录之外的目录中拥有可构建的源代码。 |
|
|
dockerfile 是要构建的 Dockerfile 的原始内容。当指定此选项时,FROM 可以根据您的策略基本镜像进行修改,并且来自您的策略环境的附加 ENV 语句将在 FROM 之后但您 Dockerfile 语句的其余部分之前添加。Dockerfile 源类型可以与其他选项(如 git)一起使用 - 在这些情况下,Git 存储库将替换上下文目录中的任何固有 Dockerfile。 |
|
|
GitBuildSource 定义 Git SCM 的参数。 |
|
|
images 描述一组将用于为构建提供源的镜像。 |
|
|
ImageSource 用于描述将从镜像中提取或在多阶段构建期间使用的构建源。可以使用 ImageStreamTag、ImageStreamImage 或 DockerImage 类型的引用。可以指定一个拉取密钥来从外部注册表拉取镜像,或者在从内部注册表拉取时覆盖默认的服务帐户密钥。镜像源可以用来从镜像中提取内容并将其与存储库源一起放入构建上下文,或者直接在多阶段容器镜像构建期间使用,以允许复制内容而不覆盖存储库源的内容(参见“paths”和“as”字段)。 |
|
|
secrets 表示仅用于构建的密钥列表及其目标。 |
|
|
SecretBuildSource 描述一个密钥及其目标目录,这些目录仅在构建时使用。此处引用的密钥的内容将被复制到目标目录中,而不是挂载。 |
|
sourceSecret 是一个密钥的名称,该密钥将用于设置克隆私有存储库的身份验证。密钥包含远程存储库的有效凭据,其中数据的键表示要使用的身份验证方法,而值是 base64 编码的凭据。支持的身份验证方法为:ssh-privatekey。 |
|
|
|
要接受的构建输入类型。 |
BinaryBuildSource 描述一个将用于 Docker 和 Source 构建策略的二进制文件,该文件将被解压缩并用作构建源。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
asFile 指示提供的二进制输入应被视为构建输入中的单个文件。例如,指定“webapp.war”会将提供的二进制文件作为 ` /webapp.war` 提供给构建器。如果留空,Docker 和 Source 构建策略假定此文件是 zip、tar 或 tar.gz 文件,并将其解压缩为源代码。自定义策略将此二进制文件作为标准输入接收。此文件名不能包含斜杠或为“..”或“.”。 |
ConfigMapBuildSource 描述一个 configmap 及其目标目录,这些目录仅在构建时使用。此处引用的 configmap 的内容将被复制到目标目录中,而不是挂载。
对象
configMap
属性 | 类型 | 描述 |
---|---|---|
|
configMap 是对您想要在构建中使用的现有 configmap 的引用。 |
|
|
|
destinationDir 是 configmap 中的文件在构建时可用的目录。对于 Source 构建策略,这些文件将被注入到运行组装脚本的容器中。对于容器镜像构建策略,这些文件将被复制到 Dockerfile 所在的构建目录中,以便用户可以在容器镜像构建期间添加或复制它们。 |
GitBuildSource 定义 Git SCM 的参数。
对象
uri
属性 | 类型 | 描述 |
---|---|---|
|
|
httpProxy 是用于通过 http 访问 git 存储库的代理。 |
|
|
httpsProxy 是用于通过 https 访问 git 存储库的代理。 |
|
|
noProxy 是不应使用代理的域列表。 |
|
|
ref 是要构建的分支/标签/引用。 |
|
|
uri 指向将要构建的源。源的结构将取决于要运行的构建类型。 |
ImageSource 用于描述将从镜像中提取或在多阶段构建期间使用的构建源。可以使用 ImageStreamTag、ImageStreamImage 或 DockerImage 类型的引用。可以指定一个拉取密钥来从外部注册表拉取镜像,或者在从内部注册表拉取时覆盖默认的服务帐户密钥。镜像源可以用来从镜像中提取内容并将其与存储库源一起放入构建上下文,或者直接在多阶段容器镜像构建期间使用,以允许复制内容而不覆盖存储库源的内容(参见“paths”和“as”字段)。
对象
from
属性 | 类型 | 描述 |
---|---|---|
|
|
在多阶段容器镜像构建期间,此源将替换的一组镜像名称列表。例如,使用“COPY --from=nginx:latest”的 Dockerfile 将首先检查此字段中是否包含“nginx:latest”的镜像源,然后再尝试直接拉取。如果 Dockerfile 没有引用镜像源,则会被忽略。此字段和 paths 都可以设置,在这种情况下,内容将被使用两次。 |
|
from 是对 ImageStreamTag、ImageStreamImage 或 DockerImage 的引用,用于从中复制源。 |
|
|
|
paths 是要从镜像复制的源路径和目标路径列表。在开始构建之前,此内容将被复制到构建上下文。如果未设置路径,则构建上下文将不会更改。 |
|
|
ImageSourcePath 描述要从源镜像复制的路径及其在构建目录中的目标。 |
|
pullSecret 是一个对 Secret 的引用,用于从注册表拉取镜像。如果镜像是从 OpenShift 注册表拉取的,则不需要设置此字段。 |
paths 是要从镜像复制的源路径和目标路径列表。在开始构建之前,此内容将被复制到构建上下文。如果未设置路径,则构建上下文将不会更改。
数组
ImageSourcePath 描述要从源镜像复制的路径及其在构建目录中的目标。
对象
sourcePath
destinationDir
属性 | 类型 | 描述 |
---|---|---|
|
|
destinationDir 是构建目录中用于放置从镜像复制文件的相对目录。 |
|
|
sourcePath 是镜像内要复制到构建目录的文件或目录的绝对路径。如果源路径以 / 结尾,则会复制目录的内容,但不会在目标位置创建目录本身。 |
SecretBuildSource 描述一个密钥及其目标目录,这些目录仅在构建时使用。此处引用的密钥的内容将被复制到目标目录中,而不是挂载。
对象
secret
属性 | 类型 | 描述 |
---|---|---|
|
|
destinationDir 是构建期间 Secret 中的文件可用的目录。对于 Source 构建策略,这些文件将注入到运行组装脚本的容器中。之后,当脚本完成时,所有注入的文件都将被截断为零长度。对于容器镜像构建策略,这些文件将被复制到包含 Dockerfile 的构建目录中,以便用户可以在容器镜像构建期间使用 ADD 或 COPY 命令操作它们。 |
|
secret 是对要在构建中使用的现有 Secret 的引用。 |
BuildStrategy 包含如何执行构建的详细信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
CustomBuildStrategy 定义了特定于自定义构建的输入参数。 |
|
|
DockerBuildStrategy 定义了特定于容器镜像构建的输入参数。 |
|
|
JenkinsPipelineBuildStrategy 包含 Jenkins Pipeline 构建的特定参数。已弃用:请使用 OpenShift Pipelines |
|
|
SourceBuildStrategy 定义了特定于 Source 构建的输入参数。 |
|
|
type 是构建策略的类型。 |
CustomBuildStrategy 定义了特定于自定义构建的输入参数。
对象
from
属性 | 类型 | 描述 |
---|---|---|
|
|
buildAPIVersion 是为序列化并传递给自定义构建器的 Build 对象请求的 API 版本。 |
|
env 包含要传递到构建器容器的其他环境变量。 |
|
|
|
exposeDockerSocket 将允许从容器内部运行 Docker 命令(并构建容器镜像)。 |
|
|
forcePull 描述了控制器是否应配置构建 pod 以始终拉取构建器镜像,或者仅在本地不存在时才拉取。 |
|
from 是对 DockerImage、ImageStreamTag 或 ImageStreamImage 的引用,从中应拉取容器镜像。 |
|
|
pullSecret 是 Secret 的名称,用于设置从私有 Docker 注册表拉取容器镜像的身份验证。 |
|
|
|
secrets 是将在构建 pod 中包含的其他 secrets 的列表。 |
|
|
SecretSpec 指定要包含在构建 pod 中的 secret 及其对应的挂载点。 |
SecretSpec 指定要包含在构建 pod 中的 secret 及其对应的挂载点。
对象
secretSource
mountPath
属性 | 类型 | 描述 |
---|---|---|
|
|
mountPath 是挂载 secret 的路径。 |
|
secretSource 是对 secret 的引用。 |
DockerBuildStrategy 定义了特定于容器镜像构建的输入参数。
对象
属性 | 类型 | 描述 |
---|---|---|
|
buildArgs 包含将在 Dockerfile 中解析的构建参数。有关更多详细信息,请参阅 https://docs.docker.net.cn/engine/reference/builder/#/arg。注意:仅支持“name”和“value”字段。“valueFrom”字段上的任何设置都将被忽略。 |
|
|
|
dockerfilePath 是将用于构建容器镜像的 Dockerfile 的路径,相对于上下文根目录 (contextDir)。如果未设置,则默认为 |
|
env 包含要传递到构建器容器的其他环境变量。 |
|
|
|
forcePull 描述了构建器是否应在构建之前从注册表拉取镜像。 |
|
from 是对 DockerImage、ImageStreamTag 或 ImageStreamImage 的引用,它会覆盖 Dockerfile 中的 FROM 镜像用于构建。如果 Dockerfile 使用多阶段构建,这将替换文件中最后一个 FROM 指令中的镜像。 |
|
|
|
imageOptimizationPolicy 描述了系统在构建镜像时可以使用哪些优化来减小最终大小或减少构建镜像所花费的时间。默认策略是“None”,这意味着最终构建镜像将等同于通过容器镜像构建 API 创建的镜像。“SkipLayers”实验性策略将避免在每个镜像步骤之间提交新的层,如果 Dockerfile 无法提供与“None”策略的兼容性,则将失败。另一个实验性策略“SkipLayersAndWarn”与“SkipLayers”相同,但如果无法保持兼容性,则只会发出警告。 |
|
|
noCache 如果设置为 true,则表示必须使用 --no-cache=true 标志执行容器镜像构建。 |
|
pullSecret 是 Secret 的名称,用于设置从私有 Docker 注册表拉取容器镜像的身份验证。 |
|
|
|
volumes 是可以挂载到构建运行时环境的输入卷的列表。构建仅支持 Kubernetes 卷源的一个子集。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes |
|
|
BuildVolume 描述了可用于构建 pod 的卷,以便可以将其挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的一个子集。 |
volumes 是可以挂载到构建运行时环境的输入卷的列表。构建仅支持 Kubernetes 卷源的一个子集。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes
数组
BuildVolume 描述了可用于构建 pod 的卷,以便可以将其挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的一个子集。
对象
name
source
mounts
属性 | 类型 | 描述 |
---|---|---|
|
|
mounts 表示卷在镜像构建容器中的位置。 |
|
|
BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。 |
|
|
name 是此 BuildVolume 的唯一标识符。它必须符合 Kubernetes DNS 标签标准,并且在 pod 内必须唯一。与构建控制器添加的名称冲突的名称将导致构建失败,并显示详细说明哪个名称导致错误的错误消息。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names |
|
|
BuildVolumeSource 表示要挂载的卷的来源。在任何给定时间只能指定其支持类型之一。 |
BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。
对象
destinationPath
属性 | 类型 | 描述 |
---|---|---|
|
|
destinationPath 是在 buildah 运行时环境中应挂载卷的路径。构建镜像中的临时挂载和后备卷都将以只读方式挂载。必须是绝对路径,不能包含“..”或“:”,并且不能与构建器进程生成的目的地路径冲突。与构建控制器添加的路径冲突的路径将导致构建失败,并显示详细说明哪个路径导致错误的错误消息。 |
BuildVolumeSource 表示要挂载的卷的来源。在任何给定时间只能指定其支持类型之一。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
configMap 代表一个 ConfigMap,用于填充此卷 |
|
|
csi 代表由支持此功能的外部 CSI 驱动程序提供的临时存储 |
|
|
secret 代表一个 Secret,用于填充此卷。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#secret |
|
|
|
type 是卷源的 BuildVolumeSourceType。类型必须与填充的卷源匹配。有效类型为:Secret、ConfigMap |
JenkinsPipelineBuildStrategy 包含 Jenkins Pipeline 构建的特定参数。已弃用:请使用 OpenShift Pipelines
对象
属性 | 类型 | 描述 |
---|---|---|
|
env 包含您想要传递到构建管道的其他环境变量。 |
|
|
|
Jenkinsfile 定义 Jenkinsfile 的可选原始内容,该文件定义了 Jenkins pipeline 构建。 |
|
|
JenkinsfilePath 是 Jenkinsfile 的可选路径,该路径将用于相对于上下文根目录 (contextDir) 配置管道。如果 JenkinsfilePath 和 Jenkinsfile 都未指定,则默认为指定 contextDir 根目录中的 Jenkinsfile。 |
SourceBuildStrategy 定义了特定于 Source 构建的输入参数。
对象
from
属性 | 类型 | 描述 |
---|---|---|
|
env 包含要传递到构建器容器的其他环境变量。 |
|
|
|
forcePull 描述了构建器是否应在构建之前从注册表拉取镜像。 |
|
from 是对 DockerImage、ImageStreamTag 或 ImageStreamImage 的引用,从中应拉取容器镜像。 |
|
|
|
如果 incremental 标志为 true,则强制 Source 构建进行增量构建。 |
|
pullSecret 是 Secret 的名称,用于设置从私有 Docker 注册表拉取容器镜像的身份验证。 |
|
|
|
scripts 是 Source 脚本的位置 |
|
|
volumes 是可以挂载到构建运行时环境的输入卷的列表。构建仅支持 Kubernetes 卷源的一个子集。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes |
|
|
BuildVolume 描述了可用于构建 pod 的卷,以便可以将其挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的一个子集。 |
volumes 是可以挂载到构建运行时环境的输入卷的列表。构建仅支持 Kubernetes 卷源的一个子集。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes
数组
BuildVolume 描述了可用于构建 pod 的卷,以便可以将其挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的一个子集。
对象
name
source
mounts
属性 | 类型 | 描述 |
---|---|---|
|
|
mounts 表示卷在镜像构建容器中的位置。 |
|
|
BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。 |
|
|
name 是此 BuildVolume 的唯一标识符。它必须符合 Kubernetes DNS 标签标准,并且在 pod 内必须唯一。与构建控制器添加的名称冲突的名称将导致构建失败,并显示详细说明哪个名称导致错误的错误消息。更多信息:https://kubernetes.ac.cn/docs/concepts/overview/working-with-objects/names/#names |
|
|
BuildVolumeSource 表示要挂载的卷的来源。在任何给定时间只能指定其支持类型之一。 |
BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。
对象
destinationPath
属性 | 类型 | 描述 |
---|---|---|
|
|
destinationPath 是在 buildah 运行时环境中应挂载卷的路径。构建镜像中的临时挂载和后备卷都将以只读方式挂载。必须是绝对路径,不能包含“..”或“:”,并且不能与构建器进程生成的目的地路径冲突。与构建控制器添加的路径冲突的路径将导致构建失败,并显示详细说明哪个路径导致错误的错误消息。 |
BuildVolumeSource 表示要挂载的卷的来源。在任何给定时间只能指定其支持类型之一。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
configMap 代表一个 ConfigMap,用于填充此卷 |
|
|
csi 代表由支持此功能的外部 CSI 驱动程序提供的临时存储 |
|
|
secret 代表一个 Secret,用于填充此卷。更多信息:https://kubernetes.ac.cn/docs/concepts/storage/volumes#secret |
|
|
|
type 是卷源的 BuildVolumeSourceType。类型必须与填充的卷源匹配。有效类型为:Secret、ConfigMap |
BuildTriggerCause 包含有关触发构建的信息。它用于显示每个构建和构建配置中 oc describe 的构建触发器数据。它还用于描述哪些触发器导致了构建配置中的最新更新。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
BitbucketWebHookCause 包含触发构建的 Bitbucket webhook 的信息。 |
|
|
GenericWebHookCause 包含触发构建的通用 WebHook 的信息。 |
|
|
GitHubWebHookCause 包含触发构建的 GitHub webhook 的信息。 |
|
|
GitLabWebHookCause 包含触发构建的 GitLab webhook 的信息。 |
|
|
ImageChangeCause 包含触发构建的镜像信息 |
|
|
message 用于存储关于触发构建原因的人类可读消息。例如:“用户手动触发”、“配置更改”等。 |
BitbucketWebHookCause 包含触发构建的 Bitbucket webhook 的信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceRevision 是构建源的修订版或提交信息。 |
|
|
Secret 是触发构建的已模糊处理的 webhook 密钥。 |
SourceRevision 是构建源的修订版或提交信息。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
|
GitSourceRevision 是构建的 git 源代码的提交信息。 |
|
|
构建源的类型,可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一。 |
GitSourceRevision 是构建的 git 源代码的提交信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
commit 是标识特定提交的提交哈希值。 |
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
message 是特定提交的描述。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
GenericWebHookCause 包含触发构建的通用 WebHook 的信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceRevision 是构建源的修订版或提交信息。 |
|
|
secret 是触发构建的已模糊处理的 webhook 密钥。 |
SourceRevision 是构建源的修订版或提交信息。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
|
GitSourceRevision 是构建的 git 源代码的提交信息。 |
|
|
构建源的类型,可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一。 |
GitSourceRevision 是构建的 git 源代码的提交信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
commit 是标识特定提交的提交哈希值。 |
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
message 是特定提交的描述。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
GitHubWebHookCause 包含触发构建的 GitHub webhook 的信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceRevision 是构建源的修订版或提交信息。 |
|
|
secret 是触发构建的已模糊处理的 webhook 密钥。 |
SourceRevision 是构建源的修订版或提交信息。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
|
GitSourceRevision 是构建的 git 源代码的提交信息。 |
|
|
构建源的类型,可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一。 |
GitSourceRevision 是构建的 git 源代码的提交信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
commit 是标识特定提交的提交哈希值。 |
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
message 是特定提交的描述。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
GitLabWebHookCause 包含触发构建的 GitLab webhook 的信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceRevision 是构建源的修订版或提交信息。 |
|
|
Secret 是触发构建的已模糊处理的 webhook 密钥。 |
SourceRevision 是构建源的修订版或提交信息。
对象
类型
属性 | 类型 | 描述 |
---|---|---|
|
|
GitSourceRevision 是构建的 git 源代码的提交信息。 |
|
|
构建源的类型,可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一。 |
GitSourceRevision 是构建的 git 源代码的提交信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
commit 是标识特定提交的提交哈希值。 |
|
|
SourceControlUser 定义源代码控制用户的身份。 |
|
|
message 是特定提交的描述。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
SourceControlUser 定义源代码控制用户的身份。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
源代码控制用户的邮箱。 |
|
|
源代码控制用户的姓名。 |
ImageChangeCause 包含触发构建的镜像信息
对象
属性 | 类型 | 描述 |
---|---|---|
|
fromRef 包含触发构建的镜像的详细信息。 |
|
|
|
imageID 是触发新构建的镜像的 ID。 |
BuildStatus 包含构建的状态。
对象
phase
属性 | 类型 | 描述 |
---|---|---|
|
|
cancelled 描述是否为构建触发了取消事件。 |
|
completionTimestamp 是一个时间戳,表示此构建完成时的服务器时间,无论该构建成功还是失败。它反映了运行构建的 Pod 终止的时间。它以 RFC3339 格式表示,并采用 UTC 时间。 |
|
|
|
Conditions 代表构建当前状态的最新可用观察结果。 |
|
|
BuildCondition 描述构建在某一时刻的状态。 |
|
config 是此构建所基于的 BuildConfig 的 ObjectReference。 |
|
|
|
duration 包含描述构建时间的 time.Duration 对象。 |
|
|
logSnippet 是构建日志的最后几行。此值仅为失败的构建设置。 |
|
|
message 是一条人类可读的消息,指示有关构建具有此状态的原因的详细信息。 |
|
|
BuildStatusOutput 包含已构建镜像的状态。 |
|
|
outputDockerImageReference 包含对将由此构建构建的容器镜像的引用。其值根据 Build.Spec.Output.To 计算得出,应包含注册表地址,以便可以用于推送和拉取镜像。 |
|
|
phase 是构建生命周期中的阶段。可能的值为“New”、“Pending”、“Running”、“Complete”、“Failed”、“Error”和“Cancelled”。 |
|
|
reason 是一个简短的驼峰式字符串,描述任何失败,旨在用于机器解析和在 CLI 中整齐显示。 |
|
|
stages 包含有关构建过程中发生的每个阶段的详细信息,包括开始时间、持续时间(以毫秒为单位)以及每个阶段内发生的步骤。 |
|
|
StageInfo 包含有关构建阶段的详细信息。 |
|
startTimestamp 是一个时间戳,表示此构建在 Pod 中开始运行时的服务器时间。它以 RFC3339 格式表示,并采用 UTC 时间。 |
BuildCondition 描述构建在某一时刻的状态。
对象
类型
status
属性 | 类型 | 描述 |
---|---|---|
|
条件从一种状态转换到另一种状态的最后时间。 |
|
|
此条件最后一次更新的时间。 |
|
|
|
指示有关转换的详细信息的人类可读消息。 |
|
|
条件最后一次转换的原因。 |
|
|
条件的状态,True、False、Unknown 之一。 |
|
|
构建条件的类型。 |
BuildStatusOutput 包含已构建镜像的状态。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
BuildStatusOutputTo 描述已构建镜像的状态,以及它应该被推送到哪个镜像注册表。 |
BuildStatusOutputTo 描述已构建镜像的状态,以及它应该被推送到哪个镜像注册表。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
imageDigest 是构建的容器镜像的摘要。该摘要唯一标识其被推送到注册表中的镜像。 请注意,即使推送成功完成,此字段也可能并非总是设置 - 例如,当注册表没有返回摘要或返回的格式构建器无法理解时。 |
StageInfo 包含有关构建阶段的详细信息。
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
durationMilliseconds 以毫秒为单位标识阶段完成所需的时间。注意:阶段的持续时间可能超过阶段内步骤持续时间的总和,因为并非所有操作都记入显式构建步骤中。 |
|
|
name 是每个构建阶段发生的唯一标识符。 |
|
startTime 是表示此阶段开始时服务器时间的 timestamps。它以 RFC3339 格式表示,并采用 UTC 时间。 |
|
|
|
steps 包含构建阶段中每个步骤的详细信息,包括以毫秒为单位的开始时间和持续时间。 |
|
|
StepInfo 包含构建步骤的详细信息。 |
提供以下 API 端点
/apis/build.openshift.io/v1/builds
GET
:列出或监视 Build 类型对象
/apis/build.openshift.io/v1/watch/builds
GET
:监视 Build 列表的单个更改。已弃用:改为使用列表操作中的“watch”参数。
/apis/build.openshift.io/v1/namespaces/{namespace}/builds
DELETE
:删除 Build 集合
GET
:列出或监视 Build 类型对象
POST
:创建 Build
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds
GET
:监视 Build 列表的单个更改。已弃用:改为使用列表操作中的“watch”参数。
/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}
DELETE
:删除 Build
GET
:读取指定的 Build
PATCH
:部分更新指定的 Build
PUT
:替换指定的 Build
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds/{name}
GET
:监视 Build 类型对象的更改。已弃用:改为使用列表操作中的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。
/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/details
PUT
:替换指定的 Build 的详细信息
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks
POST
:将 POST 请求连接到 BuildConfig 的 Webhook
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}
POST
:将 POST 请求连接到 BuildConfig 的 Webhook
GET
列出或监视 Build 类型对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
GET
监视 Build 列表的单个更改。已弃用:改为使用列表操作中的“watch”参数。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
DELETE
删除 Build 集合
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
GET
列出或监视 Build 类型对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
POST
创建 Build
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
|
|
fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段,只保留最后一个。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - 已创建 |
|
202 - 已接受 |
|
401 - 未授权 |
空 |
GET
监视 Build 列表的单个更改。已弃用:改为使用列表操作中的“watch”参数。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
参数 | 类型 | 描述 |
---|---|---|
|
|
Build 的名称 |
DELETE
删除 Build
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
202 - 已接受 |
|
401 - 未授权 |
空 |
GET
读取指定的 Build
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
PATCH
部分更新指定的 Build
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
|
|
fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段,只保留最后一个。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - 已创建 |
|
401 - 未授权 |
空 |
PUT
替换指定的 Build
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
|
|
fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段,只保留最后一个。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - 已创建 |
|
401 - 未授权 |
空 |
参数 | 类型 | 描述 |
---|---|---|
|
|
Build 的名称 |
GET
监视 Build 类型对象的更改。已弃用:改为使用列表操作中的“watch”参数,并使用“fieldSelector”参数过滤为单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - 未授权 |
空 |
参数 | 类型 | 描述 |
---|---|---|
|
|
Build 的名称 |
参数 | 类型 | 描述 |
---|---|---|
|
|
如果存在,则表示不应持久化修改。无效或无法识别的 dryRun 指令将导致错误响应,并且不会进一步处理请求。有效值为:- All:将处理所有 dry run 阶段 |
|
|
fieldValidation 指示服务器如何处理请求 (POST/PUT/PATCH) 中包含未知或重复字段的对象。有效值为:- Ignore:这将忽略任何被对象静默删除的未知字段,并且将忽略解码器遇到的所有重复字段,只保留最后一个。这是 v1.23 之前的默认行为。- Warn:这将通过标准警告响应标头为每个从对象中删除的未知字段和遇到的每个重复字段发送警告。如果没有任何其他错误,请求仍将成功,并且只会保留任何重复字段中的最后一个。这是 v1.23+ 的默认值 - Strict:如果任何未知字段将从对象中删除,或者存在任何重复字段,这将使请求失败并返回 BadRequest 错误。服务器返回的错误将包含遇到的所有未知和重复字段。 |
PUT
替换指定的 Build 的详细信息
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - 已创建 |
|
401 - 未授权 |
空 |