30.2. BuildConfig [build.openshift.io/v1]
- 描述
构建配置定义新容器镜像的构建过程。可以使用 Dockerfile 构建容器镜像 - 容器镜像构建,即 Source-to-Image 构建,它使用特殊准备的基础镜像来接受可运行的源代码,以及可作为基础运行 //任意容器镜像的自定义构建,并接受构建参数。构建在集群中运行,完成后将推送到 "output" 部分中指定的容器镜像 registry。构建可以通过 Webhook 触发,当基础镜像更改时,或者当用户手动请求新构建时,可以通过 Webhook 触发。
由构建配置创建的每个构建都会编号,并引用其父配置。可以同时触发多个构建。没有"输出"集的构建可用于测试代码或运行验证构建。
- 类型
-
对象
- 必填
-
spec
-
30.2.1. 规格 复制链接链接已复制到粘贴板!
属性 | 类型 | 描述 |
---|---|---|
|
| APIVersion 定义对象的这个表示法的版本化的 schema。服务器应该将识别的模式转换为最新的内部值,并可拒绝未识别的值。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
| kind 是一个字符串值,代表此对象所代表的 REST 资源。服务器可以从客户端向其提交请求的端点推断。无法更新。采用驼峰拼写法 (CamelCase)。更多信息: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
| ||
|
| BuildConfigSpec 描述构建的创建时间和方式 |
|
| BuildConfigStatus 包含构建配置对象的当前状态。 |
30.2.1.1. .spec 复制链接链接已复制到粘贴板!
- 描述
- BuildConfigSpec 描述构建的创建时间和方式
- 类型
-
对象
- 必填
-
策略
-
属性 | 类型 | 描述 |
---|---|---|
|
| completionDeadlineSeconds 是一个可选持续时间(以秒为单位),从构建 pod 调度到系统中的时间开始计算,该构建可能会在系统主动尝试终止构建前在节点上活跃;值必须是正整数 |
|
| failedBuildsHistoryLimit 是要保留的旧失败构建数量。创建 BuildConfig 时,除非设置了此值,否则将保留 5 个最近失败的构建。如果在 BuildConfig 创建后移除,则会保留所有失败的构建。 |
|
| mountTrustedCA bind 将集群的可信证书颁发机构(如集群代理配置中定义的)挂载到构建中。这允许在由自定义 PKI 证书颁发机构(如私有工件存储库和 HTTPS 代理)签名的构建信任组件内处理。
当此字段设置为 true 时,构建中的 |
|
| nodeSelector 是一个选择器,必须为 true,构建 pod 必须位于节点上(如果 nil),则集群的默认构建节点选择器值可以被覆盖。如果设置为空映射或具有任何值的映射,则忽略默认构建节点选择器值。 |
|
| BuildOutput 是构建策略的输入,并描述了策略应生成的容器镜像。 |
|
| BuildPostCommitSpec 包含构建后提交 hook 规格。hook 在运行构建输出镜像的临时容器内执行命令,紧接提交镜像的最后一层后,并在镜像推送到 registry 之前。命令执行,并将当前工作目录($PWD)设置为镜像的 WORKDIR。 如果 hook 执行失败,构建将标记为失败。如果脚本或命令返回非零退出代码,或者存在与启动临时容器相关的其他错误,它将会失败。
配置 hook 有五种不同的方法。例如,以下所有形式都等效,将执行 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.com/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"] } 这种形式等同于将参数附加到命令片段中。 同时提供脚本和命令无效。如果没有指定任何字段,则不会执行 hook。 |
| 资源计算执行构建的资源要求。 | |
|
| SourceRevision 是构建的源的修订或提交信息 |
|
| runPolicy 描述了从此构建配置创建的新构建如何调度来执行。如果没有指定,则这是可选的,则默认为 "Serial"。 |
|
| ServiceAccount 是用于运行此构建创建的 pod 的 ServiceAccount 的名称。pod 允许使用由 ServiceAccount 引用的 secret |
|
| BuildSource 是用于构建的 SCM。 |
|
| BuildStrategy 包含如何执行构建的详情。 |
|
| successfulBuildsHistoryLimit 是要保留的旧成功构建数量。创建 BuildConfig 时,除非设置了此值,否则将保留 5 个最新的成功构建。如果在 BuildConfig 创建后移除,则会保留所有成功构建。 |
|
| 触发器决定了如何从 BuildConfig 启动新构建。如果没有定义触发器,则只能在明确创建客户端构建时发生新构建。 |
|
| BuildTriggerPolicy 描述了单个触发器的策略,它生成新的构建。 |
30.2.1.2. .spec.output 复制链接链接已复制到粘贴板!
- 描述
- BuildOutput 是构建策略的输入,并描述了策略应生成的容器镜像。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| imageLabels 定义应用到生成的镜像的标签列表。如果有多个具有相同名称的标签,则使用列表中的最后一个标签。 |
|
| ImageLabel 代表应用到生成的镜像的标签。 |
| pushSecret 是 Secret 的名称,用于设置执行 Docker 推送以启用 Docker Registry (或 Docker Hub)的身份验证。 | |
| 定义此构建输出要推送到的可选位置。kind 必须是 'ImageStreamTag' 或 'DockerImage' 之一。此值将用于查找要推送到的容器镜像存储库。如果是 ImageStreamTag,ImageStreamTag 会在构建的命名空间中查找,除非指定了 Namespace。 |
30.2.1.3. .spec.output.imageLabels 复制链接链接已复制到粘贴板!
- 描述
- imageLabels 定义应用到生成的镜像的标签列表。如果有多个具有相同名称的标签,则使用列表中的最后一个标签。
- 类型
-
数组
30.2.1.4. .spec.output.imageLabels[] 复制链接链接已复制到粘贴板!
- 描述
- ImageLabel 代表应用到生成的镜像的标签。
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 定义标签的名称。它必须具有非零长度。 |
|
| value 定义标签的字面值。 |
30.2.1.5. .spec.postCommit 复制链接链接已复制到粘贴板!
- 描述
BuildPostCommitSpec 包含构建后提交 hook 规格。hook 在运行构建输出镜像的临时容器内执行命令,紧接提交镜像的最后一层后,并在镜像推送到 registry 之前。命令执行,并将当前工作目录($PWD)设置为镜像的 WORKDIR。
如果 hook 执行失败,构建将标记为失败。如果脚本或命令返回非零退出代码,或者存在与启动临时容器相关的其他错误,它将会失败。
配置 hook 有五种不同的方法。例如,以下所有形式都等效,将执行
rake test --verbose
。Shell 脚本:
"postCommit": { "script": "rake test --verbose", }
"postCommit": { "script": "rake test --verbose", }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The above is a convenient form which is equivalent to:
The above is a convenient form which is equivalent to:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow "postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }
"postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 作为镜像入口点的命令:
"postCommit": { "commit": ["rake", "test", "--verbose"] }
"postCommit": { "commit": ["rake", "test", "--verbose"] }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.
Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将参数传递给默认入口点:
"postCommit": { "args": ["rake", "test", "--verbose"] }
"postCommit": { "args": ["rake", "test", "--verbose"] }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow This form is only useful if the image entrypoint can handle arguments.
This form is only useful if the image entrypoint can handle arguments.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Shell 脚本带有参数:
"postCommit": { "script": "rake test $1", "args": ["--verbose"] }
"postCommit": { "script": "rake test $1", "args": ["--verbose"] }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 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.
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.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 命令带有参数:
"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }
"postCommit": { "command": ["rake", "test"], "args": ["--verbose"] }
Copy to Clipboard Copied! Toggle word wrap Toggle overflow This form is equivalent to appending the arguments to the Command slice.
This form is equivalent to appending the arguments to the Command slice.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
同时提供脚本和命令无效。如果没有指定任何字段,则不会执行 hook。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| args 是提供给命令、脚本或容器镜像的默认入口点的参数列表。参数会在要运行的命令后立即放置。 |
|
|
command 是要运行的命令。它可能无法通过脚本指定。如果镜像没有 |
|
|
脚本是使用 |
30.2.1.6. .spec.revision 复制链接链接已复制到粘贴板!
- 描述
- SourceRevision 是构建的源的修订或提交信息
- 类型
-
对象
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| GitSourceRevision 是来自构建的 git 源的提交信息 |
|
| 构建源的类型可以是 'Source'、'Dockerfile'、'Binary' 或 'Images' 之一 |
30.2.1.7. .spec.revision.git 复制链接链接已复制到粘贴板!
- 描述
- GitSourceRevision 是来自构建的 git 源的提交信息
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| SourceControlUser 定义源控制用户的身份 |
|
| commit 是识别特定提交的提交哈希 |
|
| SourceControlUser 定义源控制用户的身份 |
|
| Message 是特定提交的描述 |
30.2.1.8. .spec.revision.git.author 复制链接链接已复制到粘贴板!
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 源控制用户的电子邮件 |
|
| 源控制用户的名称 |
30.2.1.9. .spec.revision.git.committer 复制链接链接已复制到粘贴板!
- 描述
- SourceControlUser 定义源控制用户的身份
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| 源控制用户的电子邮件 |
|
| 源控制用户的名称 |
30.2.1.10. .spec.source 复制链接链接已复制到粘贴板!
- 描述
- BuildSource 是用于构建的 SCM。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| BinaryBuildSource 描述了用于 Docker 和 Source 构建策略的二进制文件,其中将提取并用作构建源。 |
|
| ConfigMaps 代表用于构建的 configMap 列表及其目的地。 |
|
| ConfigMapBuildSource 描述了 configmap 及其目标目录,仅在构建时使用。此处引用的 configmap 的内容将复制到目标目录中,而不是挂载。 |
|
| contextDir 指定应用程序的源代码所在的子目录。这允许在存储库根目录以外的目录中具有可构建的源。 |
|
| Dockerfile 是应构建的 Dockerfile 的原始内容。指定此选项后,可以根据您的策略基础镜像和来自您的策略环境中的其他 ENV 小节来修改 FROM,但您的其余 Dockerfile 小节前面会添加其他 ENV 小节。Dockerfile 源类型可以与 git - 等其他选项一起使用,在这种情况下,Git 仓库将在上下文 dir 中替换任何 innate Dockerfile。 |
|
| GitBuildSource 定义 Git SCM 的参数 |
|
| image 描述了一组镜像,用于为构建提供源 |
|
| ImageSource 用于描述将从镜像提取或多阶段构建期间使用的构建源。可以使用 ImageStreamTag、ImageStreamImage 或 DockerImage 类型的引用。可以指定 pull secret 来从外部 registry 拉取镜像,或者在从内部 registry 中拉取时覆盖默认服务帐户 secret。镜像源可用于从镜像中提取内容并将其放在构建上下文中以及存储库源,或者在多阶段容器镜像构建期间直接使用,以允许在不覆盖存储库源内容的情况下复制内容(请参阅 'paths' 和 'as' 字段)。 |
|
| secret 代表 secret 列表及其目的地,仅用于构建。 |
|
| SecretBuildSource 描述了仅在构建时使用的 secret 及其目标目录。此处引用的 secret 的内容将复制到目标目录中,而不是挂载。 |
| sourceSecret 是 Secret 的名称,用于设置克隆私有存储库的身份验证。secret 包含远程存储库的有效凭据,其中 data 键代表要使用的身份验证方法,value 是 base64 编码的凭据。支持的身份验证方法有:ssh-privatekey。 | |
|
| 要接受的构建输入类型 |
30.2.1.11. .spec.source.binary 复制链接链接已复制到粘贴板!
- 描述
- BinaryBuildSource 描述了用于 Docker 和 Source 构建策略的二进制文件,其中将提取并用作构建源。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
|
asFile 表示提供的二进制输入应被视为构建输入中的单个文件。例如,指定 "webapp.war" 会将提供的二进制文件设置为构建器的 |
30.2.1.12. .spec.source.configMaps 复制链接链接已复制到粘贴板!
- 描述
- ConfigMaps 代表用于构建的 configMap 列表及其目的地。
- 类型
-
数组
30.2.1.13. .spec.source.configMaps[] 复制链接链接已复制到粘贴板!
- 描述
- ConfigMapBuildSource 描述了 configmap 及其目标目录,仅在构建时使用。此处引用的 configmap 的内容将复制到目标目录中,而不是挂载。
- 类型
-
对象
- 必填
-
configMap
-
属性 | 类型 | 描述 |
---|---|---|
| ConfigMap 是对要在构建中使用的现有 configmap 的引用。 | |
|
| destinationDir 是 configmap 中的文件应该可用于构建时间的目录。对于 Source 构建策略,它们将注入到运行 assemble 脚本的容器中。对于容器镜像构建策略,它们将复制到构建目录中,其中 Dockerfile 所在的位置,因此用户可以在容器镜像构建过程中 ADD 或 COPY。 |
30.2.1.14. .spec.source.git 复制链接链接已复制到粘贴板!
- 描述
- GitBuildSource 定义 Git SCM 的参数
- 类型
-
对象
- 必填
-
uri
-
属性 | 类型 | 描述 |
---|---|---|
|
| httpProxy 是一个代理,用于通过 http 访问 git 存储库 |
|
| httpsProxy 是一个代理,用于通过 https 访问 git 存储库 |
|
| noProxy 是不使用代理的域列表 |
|
| ref 是要构建的分支/标签/ref。 |
|
| URI 指向将要构建的源。源的结构将取决于要运行的构建类型 |
30.2.1.15. .spec.source.images 复制链接链接已复制到粘贴板!
- 描述
- image 描述了一组镜像,用于为构建提供源
- 类型
-
数组
30.2.1.16. .spec.source.images[] 复制链接链接已复制到粘贴板!
- 描述
- ImageSource 用于描述将从镜像提取或多阶段构建期间使用的构建源。可以使用 ImageStreamTag、ImageStreamImage 或 DockerImage 类型的引用。可以指定 pull secret 来从外部 registry 拉取镜像,或者在从内部 registry 中拉取时覆盖默认服务帐户 secret。镜像源可用于从镜像中提取内容并将其放在构建上下文中以及存储库源,或者在多阶段容器镜像构建期间直接使用,以允许在不覆盖存储库源内容的情况下复制内容(请参阅 'paths' 和 'as' 字段)。
- 类型
-
对象
- 必填
-
from
-
属性 | 类型 | 描述 |
---|---|---|
|
| 此源将在多阶段容器镜像构建过程中用于代替的镜像名称列表。例如,使用 "COPY --from=nginx:latest" 的 Dockerfile 首先会在尝试直接拉取前检查此字段中具有"nginx:latest"的镜像源。如果 Dockerfile 没有引用它被忽略的镜像源。此字段和路径可以同时被设置,在这种情况下,内容将使用两次。 |
| from 是从中复制源的 ImageStreamTag、ImageStreamImage 或 DockerImage 的引用。 | |
|
| paths 是要从镜像复制的源和目标路径列表。在开始构建前,此内容将复制到构建上下文中。如果没有设置路径,则不会更改构建上下文。 |
|
| ImageSourcePath 描述了从源镜像及其构建目录中的目的地复制的路径。 |
| pullSecret 是一个引用,用于从 registry 中拉取镜像(如果从 OpenShift registry 中拉取镜像),则不需要设置此字段。 |
30.2.1.17. .spec.source.images[].paths 复制链接链接已复制到粘贴板!
- 描述
- paths 是要从镜像复制的源和目标路径列表。在开始构建前,此内容将复制到构建上下文中。如果没有设置路径,则不会更改构建上下文。
- 类型
-
数组
30.2.1.18. .spec.source.images[].paths[] 复制链接链接已复制到粘贴板!
- 描述
- ImageSourcePath 描述了从源镜像及其构建目录中的目的地复制的路径。
- 类型
-
对象
- 必填
-
sourcePath
-
destinationDir
-
属性 | 类型 | 描述 |
---|---|---|
|
| destinationDir 是构建目录中放置从镜像复制文件的相对目录。 |
|
| sourcePath 是要复制到构建目录的镜像内的文件或目录的绝对路径。如果源路径以 /. 结尾,则复制目录的内容,但不会在目的地上创建该目录本身。 |
30.2.1.19. .spec.source.secrets 复制链接链接已复制到粘贴板!
- 描述
- secret 代表 secret 列表及其目的地,仅用于构建。
- 类型
-
数组
30.2.1.20. .spec.source.secrets[] 复制链接链接已复制到粘贴板!
- 描述
- SecretBuildSource 描述了仅在构建时使用的 secret 及其目标目录。此处引用的 secret 的内容将复制到目标目录中,而不是挂载。
- 类型
-
对象
- 必填
-
secret
-
属性 | 类型 | 描述 |
---|---|---|
|
| destinationDir 是来自 secret 的文件应该可用于构建时间的目录。对于 Source 构建策略,它们将注入到运行 assemble 脚本的容器中。之后,脚本完成后,注入的所有文件都将截断为零长度。对于容器镜像构建策略,它们将复制到构建目录中,其中 Dockerfile 所在的位置,因此用户可以在容器镜像构建过程中 ADD 或 COPY。 |
| secret 是对要在构建中使用的现有 secret 的引用。 |
30.2.1.21. .spec.strategy 复制链接链接已复制到粘贴板!
- 描述
- BuildStrategy 包含如何执行构建的详情。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| CustomBuildStrategy 定义特定于 Custom build 的输入参数。 |
|
| DockerBuildStrategy 定义特定于容器镜像构建的输入参数。 |
|
| JenkinsPipelineBuildStrategy 包含特定于 Jenkins Pipeline 构建的参数。弃用:使用 OpenShift Pipelines |
|
| SourceBuildStrategy 定义特定于 Source 构建的输入参数。 |
|
| type 是构建策略的类型。 |
30.2.1.22. .spec.strategy.customStrategy 复制链接链接已复制到粘贴板!
- 描述
- CustomBuildStrategy 定义特定于 Custom build 的输入参数。
- 类型
-
对象
- 必填
-
from
-
属性 | 类型 | 描述 |
---|---|---|
|
| buildAPIVersion 是 Build 对象序列化并传递给自定义构建器的请求 API 版本 |
| env 包含您要传递给构建器容器的其他环境变量。 | |
|
| exposeDockerSocket 允许从容器内运行 Docker 命令(和构建容器镜像)。 |
|
| forcePull 描述控制器是否应该将构建 Pod 配置为始终拉取构建器的镜像,或仅在本地不存在时拉取(pull) |
| from 引用了应拉取容器镜像的 DockerImage、ImageStreamTag 或 ImageStreamImage | |
| pullSecret 是 Secret 的名称,用于设置用于从私有 Docker registry 中拉取容器镜像的身份验证 | |
|
| secret 是构建 pod 中包含的附加 secret 列表 |
|
| SecretSpec 指定要包含在构建 pod 中的 secret 及其对应的挂载点 |
30.2.1.23. .spec.strategy.customStrategy.secrets 复制链接链接已复制到粘贴板!
- 描述
- secret 是构建 pod 中包含的附加 secret 列表
- 类型
-
数组
30.2.1.24. .spec.strategy.customStrategy.secrets[] 复制链接链接已复制到粘贴板!
- 描述
- SecretSpec 指定要包含在构建 pod 中的 secret 及其对应的挂载点
- 类型
-
对象
- 必填
-
secretSource
-
mountPath
-
属性 | 类型 | 描述 |
---|---|---|
|
| mountPath 是挂载 secret 的路径 |
| secretSource 是对 secret 的引用 |
30.2.1.25. .spec.strategy.dockerStrategy 复制链接链接已复制到粘贴板!
- 描述
- DockerBuildStrategy 定义特定于容器镜像构建的输入参数。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| buildArgs 包含将在 Dockerfile 中解析的构建参数。详情请查看 https://docs.docker.com/engine/reference/builder/#/arg。注意:只支持 'name' 和 'value' 字段。'valueFrom' 字段中的任何设置都会被忽略。 | |
|
|
dockerfilePath 是 Dockerfile 的路径,它将用于构建容器镜像,相对于上下文的根目录(contextDir)。如果未设置,则默认为 |
| env 包含您要传递给构建器容器的其他环境变量。 | |
|
| forcePull 描述构建器是否应该在构建前从 registry 拉取镜像。 |
| from 是 DockerImage、ImageStreamTag 或 ImageStreamImage 的引用,可覆盖构建的 Dockerfile 中的 FROM 镜像。如果 Dockerfile 使用多阶段构建,这将替换文件的最后一个 FROM 指令中的镜像。 | |
|
| imageOptimizationPolicy 描述了系统在构建镜像时可以使用哪些优化,以减少构建镜像的最后大小或时间。默认策略是 'None',这意味着最终构建镜像将等同于容器镜像构建 API 创建的镜像。实验性策略 'SkipLayers' 将避免在每个镜像步骤之间提交新层,如果 Dockerfile 无法提供与"None"策略的兼容性,将失败。额外的实验性策略 'SkipLayersAndWarn' 与 'SkipLayers' 相同,但只是在无法保留兼容性时发出警告。 |
|
| 如果设为 true,则不表示必须使用 --no-cache=true 标志执行容器镜像构建 |
| pullSecret 是 Secret 的名称,用于设置用于从私有 Docker registry 中拉取容器镜像的身份验证 | |
|
| 卷是可挂载到构建运行时环境中的输入卷列表。构建只支持 Kubernetes 卷源的子集。更多信息: https://kubernetes.io/docs/concepts/storage/volumes |
|
| BuildVolume 描述了用于构建 pod 的卷,以便它可以挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的子集。 |
30.2.1.26. .spec.strategy.dockerStrategy.volumes 复制链接链接已复制到粘贴板!
- 描述
- 卷是可挂载到构建运行时环境中的输入卷列表。构建只支持 Kubernetes 卷源的子集。更多信息: https://kubernetes.io/docs/concepts/storage/volumes
- 类型
-
数组
30.2.1.27. .spec.strategy.dockerStrategy.volumes[] 复制链接链接已复制到粘贴板!
- 描述
- BuildVolume 描述了用于构建 pod 的卷,以便它可以挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的子集。
- 类型
-
对象
- 必填
-
name
-
source
-
mounts
-
属性 | 类型 | 描述 |
---|---|---|
|
| mount 代表镜像构建容器中的卷位置 |
|
| BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。 |
|
| name 是此 BuildVolume 的唯一标识符。它必须符合 Kubernetes DNS 标签标准,且在 pod 中是唯一的。与构建控制器添加的内容冲突将导致构建失败,并显示出错信息详细描述哪个名称会导致错误。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| BuildVolumeSource 代表在任意给定时间仅挂载其受支持的类型的卷源。 |
- 描述
- mount 代表镜像构建容器中的卷位置
- 类型
-
数组
- 描述
- BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。
- 类型
-
对象
- 必填
-
destinationPath
-
属性 | 类型 | 描述 |
---|---|---|
|
| destinationPath 是应该挂载卷的 buildah 运行时环境中的路径。构建镜像中的临时挂载和后备卷都将被挂载为只读。必须是绝对路径,不得包含 '..' 或 ':',且不得与构建控制器添加的构建器进程路径生成的目标路径冲突,会导致构建失败,并显示出错信息。 |
- 描述
- BuildVolumeSource 代表在任意给定时间仅挂载其受支持的类型的卷源。
- 类型
-
对象
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
| ConfigMap 代表应填充此卷的 ConfigMap | |
| Secret 代表应填充此卷的 Secret。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret | |
|
| Type 是卷源的 BuildVolumeSourceType。type 必须与填充的卷源匹配。有效类型有: Secret、ConfigMap |
30.2.1.31. .spec.strategy.jenkinsPipelineStrategy 复制链接链接已复制到粘贴板!
- 描述
- JenkinsPipelineBuildStrategy 包含特定于 Jenkins Pipeline 构建的参数。弃用:使用 OpenShift Pipelines
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| env 包含您要传递给构建管道的额外环境变量。 | |
|
| Jenkinsfile 定义 Jenkinsfile 的可选原始内容,用于定义 Jenkins 管道构建。 |
|
| jenkinsfilePath 是 Jenkinsfile 的可选路径,它将用于配置相对于上下文根目录(contextDir)的管道。如果同时没有指定 JenkinsfilePath 和 Jenkinsfile,则默认为指定 contextDir 根中的 Jenkinsfile。 |
30.2.1.32. .spec.strategy.sourceStrategy 复制链接链接已复制到粘贴板!
- 描述
- SourceBuildStrategy 定义特定于 Source 构建的输入参数。
- 类型
-
对象
- 必填
-
from
-
属性 | 类型 | 描述 |
---|---|---|
| env 包含您要传递给构建器容器的其他环境变量。 | |
|
| forcePull 描述构建器是否应该在构建前从 registry 拉取镜像。 |
| from 引用了应拉取容器镜像的 DockerImage、ImageStreamTag 或 ImageStreamImage | |
|
| 增量标志强制 Source 构建在为 true 时进行增量构建。 |
| pullSecret 是 Secret 的名称,用于设置用于从私有 Docker registry 中拉取容器镜像的身份验证 | |
|
| 脚本是源脚本的位置 |
|
| 卷是可挂载到构建运行时环境中的输入卷列表。构建只支持 Kubernetes 卷源的子集。更多信息: https://kubernetes.io/docs/concepts/storage/volumes |
|
| BuildVolume 描述了用于构建 pod 的卷,以便它可以挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的子集。 |
30.2.1.33. .spec.strategy.sourceStrategy.volumes 复制链接链接已复制到粘贴板!
- 描述
- 卷是可挂载到构建运行时环境中的输入卷列表。构建只支持 Kubernetes 卷源的子集。更多信息: https://kubernetes.io/docs/concepts/storage/volumes
- 类型
-
数组
30.2.1.34. .spec.strategy.sourceStrategy.volumes[] 复制链接链接已复制到粘贴板!
- 描述
- BuildVolume 描述了用于构建 pod 的卷,以便它可以挂载到 buildah 的运行时环境中。仅支持 Kubernetes 卷源的子集。
- 类型
-
对象
- 必填
-
name
-
source
-
mounts
-
属性 | 类型 | 描述 |
---|---|---|
|
| mount 代表镜像构建容器中的卷位置 |
|
| BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。 |
|
| name 是此 BuildVolume 的唯一标识符。它必须符合 Kubernetes DNS 标签标准,且在 pod 中是唯一的。与构建控制器添加的内容冲突将导致构建失败,并显示出错信息详细描述哪个名称会导致错误。更多信息: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
| BuildVolumeSource 代表在任意给定时间仅挂载其受支持的类型的卷源。 |
- 描述
- mount 代表镜像构建容器中的卷位置
- 类型
-
数组
- 描述
- BuildVolumeMount 描述了在 buildah 的运行时环境中挂载卷。
- 类型
-
对象
- 必填
-
destinationPath
-
属性 | 类型 | 描述 |
---|---|---|
|
| destinationPath 是应该挂载卷的 buildah 运行时环境中的路径。构建镜像中的临时挂载和后备卷都将被挂载为只读。必须是绝对路径,不得包含 '..' 或 ':',且不得与构建控制器添加的构建器进程路径生成的目标路径冲突,会导致构建失败,并显示出错信息。 |
- 描述
- BuildVolumeSource 代表在任意给定时间仅挂载其受支持的类型的卷源。
- 类型
-
对象
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
| ConfigMap 代表应填充此卷的 ConfigMap | |
| Secret 代表应填充此卷的 Secret。更多信息: https://kubernetes.io/docs/concepts/storage/volumes#secret | |
|
| Type 是卷源的 BuildVolumeSourceType。type 必须与填充的卷源匹配。有效类型有: Secret、ConfigMap |
30.2.1.38. .spec.triggers 复制链接链接已复制到粘贴板!
- 描述
- 触发器决定了如何从 BuildConfig 启动新构建。如果没有定义触发器,则只能在明确创建客户端构建时发生新构建。
- 类型
-
数组
30.2.1.39. .spec.triggers[] 复制链接链接已复制到粘贴板!
- 描述
- BuildTriggerPolicy 描述了单个触发器的策略,它生成新的构建。
- 类型
-
对象
- 必填
-
type
-
属性 | 类型 | 描述 |
---|---|---|
|
| WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用 |
|
| WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用 |
|
| WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用 |
|
| WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用 |
|
| ImageChangeTrigger 允许在 ImageStream 更改时触发构建 |
|
| type 是构建触发器的类型。有效值: - GitHubWebHookBuildTriggerType 代表在 GitHub Webhook 调用上启动构建的触发器 - generic GenericWebHookBuildTriggerType 代表在通用 Webhook 调用上启动构建的触发器 - GitLab GitLabWebHookBuildTriggerType 代表在 GitLab Webhook 调用上启动构建的触发器 - BitbucketWebHookBuildTriggerType 代表在 Bitbucket Webhook 调用上启动构建的触发器 - ImageChange ImageChangeBuildTriggerType 代表一个触发器,它基于镜像的新版本启动构建 - ConfigChange ConfigChangeBuildTriggerType 将在初始构建配置创建警告时触发构建:未来的行为将更改以在任何配置更改时触发构建 |
30.2.1.40. .spec.triggers[].bitbucket 复制链接链接已复制到粘贴板!
- 描述
- WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| allowEnv 确定 Webhook 是否可以设置环境变量;对于 GenericWebHook,只能设置为 true。 |
|
| 用于验证请求的 secret。弃用: 使用 SecretReference 替代。 |
|
| SecretLocalReference 包含指向使用的本地 secret 的信息 |
30.2.1.41. .spec.triggers[].bitbucket.secretReference 复制链接链接已复制到粘贴板!
- 描述
- SecretLocalReference 包含指向使用的本地 secret 的信息
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是所引用同一命名空间中的资源名称 |
30.2.1.42. .spec.triggers[].generic 复制链接链接已复制到粘贴板!
- 描述
- WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| allowEnv 确定 Webhook 是否可以设置环境变量;对于 GenericWebHook,只能设置为 true。 |
|
| 用于验证请求的 secret。弃用: 使用 SecretReference 替代。 |
|
| SecretLocalReference 包含指向使用的本地 secret 的信息 |
30.2.1.43. .spec.triggers[].generic.secretReference 复制链接链接已复制到粘贴板!
- 描述
- SecretLocalReference 包含指向使用的本地 secret 的信息
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是所引用同一命名空间中的资源名称 |
30.2.1.44. .spec.triggers[].github 复制链接链接已复制到粘贴板!
- 描述
- WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| allowEnv 确定 Webhook 是否可以设置环境变量;对于 GenericWebHook,只能设置为 true。 |
|
| 用于验证请求的 secret。弃用: 使用 SecretReference 替代。 |
|
| SecretLocalReference 包含指向使用的本地 secret 的信息 |
30.2.1.45. .spec.triggers[].github.secretReference 复制链接链接已复制到粘贴板!
- 描述
- SecretLocalReference 包含指向使用的本地 secret 的信息
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是所引用同一命名空间中的资源名称 |
30.2.1.46. .spec.triggers[].gitlab 复制链接链接已复制到粘贴板!
- 描述
- WebHookTrigger 是一个触发器,它使用 webhook 类型 post 调用
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| allowEnv 确定 Webhook 是否可以设置环境变量;对于 GenericWebHook,只能设置为 true。 |
|
| 用于验证请求的 secret。弃用: 使用 SecretReference 替代。 |
|
| SecretLocalReference 包含指向使用的本地 secret 的信息 |
30.2.1.47. .spec.triggers[].gitlab.secretReference 复制链接链接已复制到粘贴板!
- 描述
- SecretLocalReference 包含指向使用的本地 secret 的信息
- 类型
-
对象
- 必填
-
name
-
属性 | 类型 | 描述 |
---|---|---|
|
| name 是所引用同一命名空间中的资源名称 |
30.2.1.48. .spec.triggers[].imageChange 复制链接链接已复制到粘贴板!
- 描述
- ImageChangeTrigger 允许在 ImageStream 更改时触发构建
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
| from 是对 ImageStreamTag 的引用,它会在更新时触发构建,它是可选的。如果没有指定 From,则使用构建策略中的 from 镜像。构建配置中只允许一个带有空的 From 引用的 ImageChangeTrigger。 | |
|
| lastTriggeredImageID 由 ImageChangeController 在内部用来保存构建此字段的最后使用的镜像 ID 已被弃用,并将在以后的发行版本中删除。已弃用 |
|
| 如果临时禁用此触发器,则暂停为 true。可选。 |
30.2.1.49. .status 复制链接链接已复制到粘贴板!
- 描述
- BuildConfigStatus 包含构建配置对象的当前状态。
- 类型
-
对象
- 必填
-
lastVersion
-
属性 | 类型 | 描述 |
---|---|---|
|
| imageChangeTriggers 捕获 BuildConfigSpec 中指定的任何 ImageChangeTrigger 的运行时状态,包括由 OpenShift APIServer 为 lastTriggeredImageID 协调的值。此数组中每个镜像更改触发器都有一个条目。每个触发器状态都会引用作为触发器源的 ImageStreamTag。 |
|
| ImageChangeTriggerStatus 跟踪 BuildConfigSpec.Triggers struct 中指定的关联 ImageChangeTrigger 策略的最新解析状态。 |
|
| lastVersion 用于告知最后一次触发的构建数量。 |
30.2.1.50. .status.imageChangeTriggers 复制链接链接已复制到粘贴板!
- 描述
- imageChangeTriggers 捕获 BuildConfigSpec 中指定的任何 ImageChangeTrigger 的运行时状态,包括由 OpenShift APIServer 为 lastTriggeredImageID 协调的值。此数组中每个镜像更改触发器都有一个条目。每个触发器状态都会引用作为触发器源的 ImageStreamTag。
- 类型
-
数组
30.2.1.51. .status.imageChangeTriggers[] 复制链接链接已复制到粘贴板!
- 描述
- ImageChangeTriggerStatus 跟踪 BuildConfigSpec.Triggers struct 中指定的关联 ImageChangeTrigger 策略的最新解析状态。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| ImageStreamTagReference 根据命名空间和名称引用镜像更改触发器中的 ImageStreamTag。 |
| lastTriggerTime 是此特定 ImageStreamTag 最后一次触发构建来启动的时间。只有在此触发器专门启动构建时才会更新此字段。 | |
|
| 当启动此 BuildConfig 的构建时,lastTriggeredImageID 代表 ImageStreamTag 的 sha/id。每次启动此 BuildConfig 的构建时,lastTriggeredImageID 都会更新,即使此 ImageStreamTag 不是启动构建的原因。 |
30.2.1.52. .status.imageChangeTriggers[].from 复制链接链接已复制到粘贴板!
- 描述
- ImageStreamTagReference 根据命名空间和名称引用镜像更改触发器中的 ImageStreamTag。
- 类型
-
对象
属性 | 类型 | 描述 |
---|---|---|
|
| name 是 ImageChangeTrigger 的 ImageStreamTag 的名称 |
|
| namespace 是 ImageChangeTrigger 的 ImageStreamTag 所在的命名空间 |
30.2.2. API 端点 复制链接链接已复制到粘贴板!
可用的 API 端点如下:
/apis/build.openshift.io/v1/buildconfigs
-
GET
:列出或监视 BuildConfig 类型的对象
-
/apis/build.openshift.io/v1/watch/buildconfigs
-
GET
: 观察对 BuildConfig 列表的各个更改。已弃用:改为使用 'watch' 参数和列表操作。
-
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs
-
DELETE
:删除 BuildConfig 的集合 -
GET
:列出或监视 BuildConfig 类型的对象 -
POST
:创建 BuildConfig
-
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs
-
GET
: 观察对 BuildConfig 列表的各个更改。已弃用:改为使用 'watch' 参数和列表操作。
-
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}
-
DELETE
:删除 BuildConfig -
GET
:读取指定的 BuildConfig -
PATCH
:部分更新指定的 BuildConfig -
PUT
:替换指定的 BuildConfig
-
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/buildconfigs/{name}
-
GET
: 观察对类型为 BuildConfig 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
-
30.2.2.1. /apis/build.openshift.io/v1/buildconfigs 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 如果 'true',则输出被用户友善。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 列出或监视 BuildConfig 类型的对象
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
30.2.2.2. /apis/build.openshift.io/v1/watch/buildconfigs 复制链接链接已复制到粘贴板!
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 如果 'true',则输出被用户友善。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对 BuildConfig 列表的各个更改。已弃用:改为使用 'watch' 参数以及 list 操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 BuildConfig 集合
参数 | 类型 | 描述 |
---|---|---|
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
参数 | 类型 | 描述 |
---|---|---|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
GET
- 描述
- 列出或监视 BuildConfig 类型的对象
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
POST
- 描述
- 创建 BuildConfig
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 如果 'true',则输出被用户友善。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对 BuildConfig 列表的各个更改。已弃用:改为使用 'watch' 参数以及 list 操作。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| BuildConfig 的名称 |
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| 如果 'true',则输出被用户友善。 |
- HTTP 方法
-
DELETE
- 描述
- 删除 BuildConfig
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| 应该删除对象前的持续时间(以秒为单位)。值必须是非负整数。值零表示立即删除。如果这个值是 nil,则使用指定类型的默认宽限期。如果没有指定,则默认为每个对象值。零表示立即删除。 |
|
| 弃用:请使用 PropagationPolicy,此字段将在 1.7 中被弃用。应该依赖的对象被孤立。如果为 true/false,"orphan"终结器将从对象的终结器列表添加到/删除。可以设置此字段或 PropagationPolicy,但不能同时设置两者。 |
|
| 是否以及是否执行垃圾回收。此字段或 OrphanDependents 可以设置,但不能同时设置两者。默认策略由 metadata.finalizers 和特定于资源的默认策略中设置的现有终结器决定。可接受的值为: 'Orphan' - 孤立依赖; 'Background' - 允许垃圾收集器在后台删除依赖的依赖关系; 'Foreground' - 一个删除前台所有依赖的级联策略。 |
参数 | 类型 | 描述 |
---|---|---|
|
- HTTP 方法
-
GET
- 描述
- 读取指定的 BuildConfig
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PATCH
- 描述
- 部分更新指定的 BuildConfig
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。应用请求(application/apply-patch)需要此字段,但对于非应用补丁类型(JsonPatch、MergePatch、OptMergePatch)是可选的。 |
|
| 强制将"强制"应用请求。这意味着用户会重新清空由其他人员拥有的冲突字段。对于非应用补丁请求,必须取消设置 force 标志。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |
- HTTP 方法
-
PUT
- 描述
- 替换指定的 BuildConfig
参数 | 类型 | 描述 |
---|---|---|
|
| 出现时,表示不应保留修改。无效的或未被识别的 dryRun 指令将导致错误响应,且请求不会被进一步处理。有效值为: - All: 所有预演阶段都将被处理 |
|
| fieldmanager 是与进行这些更改的参与者或实体相关联的名称。该值必须小于或是 128 个字符长,且仅包含可打印的字符,如 https://golang.org/pkg/unicode/#IsPrint 所定义的那样。 |
参数 | 类型 | 描述 |
---|---|---|
|
|
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized | 空 |
参数 | 类型 | 描述 |
---|---|---|
|
| BuildConfig 的名称 |
|
| 对象名称和身份验证范围,如团队和项目 |
参数 | 类型 | 描述 |
---|---|---|
|
| allowWatchBookmarks请求类型为“BOOKMARK”的监视事件。没有实现书签的服务器可能会忽略这个标志和书签,由服务器自由裁量发送。客户端不应假设书签在任何特定间隔返回,也不会假定服务器在会话期间发送任何 BOOKMARK 事件。如果这不是监视,则忽略此字段。如果 apiserver 中没有启用功能门 WatchBookmarks,则忽略此字段。 |
|
| 从服务器检索更多结果时,应设置 continue 选项。由于这个值是定义的服务器,因此客户端只能使用之前查询结果中的 continue 值,并带有相同的查询参数(除 continue 值除外),因此服务器可能会拒绝它无法识别的值。如果指定的 continue 值不再有效,无论是因为过期时间(通常为 5 到十五分钟)还是服务器上的配置更改,服务器将会与继续令牌一起响应 410 ResourceExpired 错误。如果客户端需要一致的列表,它必须在没有 continue 字段的情况下重启其列表。否则,客户端可能会发送另一个列表请求,并带有 410 错误收到的令牌,服务器将通过从下一个密钥开始的列表进行响应,但从最新的快照(从最后一个列表结果中不一致) - 在第一个列表请求后创建、修改或删除的对象将包含在响应中,只要其密钥在"next key"后。 当 watch 为 true 时,不支持此字段。客户端可以从服务器返回的最后一个 resourceVersion 值启动监视,而不丢失任何修改。 |
|
| 用于限制返回的对象列表的选择器。默认为任何内容。 |
|
| 通过标签限制返回的对象列表的选择器。默认为任何内容。 |
|
| 限制是列表调用要返回的最大响应数。如果存在更多项目,服务器会将列表元数据上的"continue"字段设置为可用于同一初始查询的值,以检索下一个结果集。在过滤所有请求的对象时,设置限制可能会返回比请求的项目数量少(最多为零项),客户端应只使用 continue 字段的存在来确定是否有更多结果可用。服务器可以选择不支持限制参数,并将返回所有可用的结果。如果指定了限制,并且 continue 字段为空,客户端可能会假设没有更多可用的结果。如果 watch 为 true,则不支持此字段。 服务器保证在使用 continue 时返回的对象与在没有限制的情况下发出单个列表调用相同 - 也就是说,在发出第一个请求后不会创建、修改或删除对象。这有时被称为一致的快照,并确保使用限制的客户端接收一个非常大的结果较小的块可以确保它们看到所有可能的对象。如果在块列出期间更新对象,则返回第一次列表结果时存在的对象版本。 |
|
| 如果 'true',则输出被用户友善。 |
|
| resourceVersion 对可能给请求提供服务的资源版本设置一个约束。详情请查看 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions 默认为未设置 |
|
| resourceVersionMatch 决定 resourceVersion 如何应用到列出调用。强烈建议您为设置了 resourceVersion 的列表调用设置 resourceVersionMatch。详情请参阅 https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions。 默认为未设置 |
|
| list/watch 调用的超时。这限制了调用的时间,无论任何活动或不活跃。 |
|
| 观察对描述的资源的更改,并将其作为添加、更新和删除通知流返回。指定 resourceVersion。 |
- HTTP 方法
-
GET
- 描述
- 观察对类型为 BuildConfig 的对象的更改。已弃用:使用带有列表操作的 'watch' 参数,而是过滤到带有 'fieldSelector' 参数的单个项目。
HTTP 代码 | 响应正文 |
---|---|
200 - OK |
|
401 - Unauthorized | 空 |