Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the execution and a reference to the Pod which executed the build.
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
object
| Property | Type | Description |
|---|---|---|
|
|
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources |
|
|
Kind is a string value representing the ReST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds |
|
metadata is the standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata |
|
|
|
BuildSpec has the information to represent a build and also additional information about a build |
|
|
BuildStatus contains the status of a build |
BuildSpec has the information to represent a build and also additional information about a build
object
strategy
| Property | Type | Description |
|---|---|---|
|
|
completionDeadlineSeconds is an optional duration in seconds, counted from the time when a build pod gets scheduled in the system, that the build may be active on a node before the system actively tries to terminate the build; value must be positive integer |
|
|
mountTrustedCA bind mounts the cluster’s trusted certificate authorities, as defined in the cluster’s proxy configuration, into the build. This lets processes within a build trust components signed by custom PKI certificate authorities, such as private artifact repositories and HTTPS proxies. When this field is set to true, the contents of |
|
|
nodeSelector is a selector which must be true for the build pod to fit on a node If nil, it can be overridden by default build nodeselector values for the cluster. If set to an empty map or a map with any values, default build nodeselector values are ignored. |
|
|
BuildOutput is input to a build strategy and describes the container image that the strategy should produce. |
|
|
A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory ($PWD) set to the image’s WORKDIR. The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container. There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute 1. Shell script: "postCommit": { "script": "rake test --verbose", } The above is a convenient form which is equivalent to: "postCommit": { "command": ["/bin/sh", "-ic"], "args": ["rake test --verbose"] } 2. A command as the image entrypoint: "postCommit": { "commit": ["rake", "test", "--verbose"] } Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint. 3. Pass arguments to the default entrypoint: "postCommit": { "args": ["rake", "test", "--verbose"] } This form is only useful if the image entrypoint can handle arguments. 4. Shell script with arguments: "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. 5. Command with arguments: "postCommit": { "command": ["rake", "test"], "args": ["--verbose"] } This form is equivalent to appending the arguments to the Command slice. It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed. |
|
resources computes resource requirements to execute the build. |
|
|
|
SourceRevision is the revision or commit information from the source for the build |
|
|
serviceAccount is the name of the ServiceAccount to use to run the pod created by this build. The pod will be allowed to use secrets referenced by the ServiceAccount |
|
|
BuildSource is the SCM used for the build. |
|
|
BuildStrategy contains the details of how to perform a build. |
|
|
triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers. |
|
|
BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration. |
BuildOutput is input to a build strategy and describes the container image that the strategy should produce.
object
| Property | Type | Description |
|---|---|---|
|
|
imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used. |
|
|
ImageLabel represents a label applied to the resulting image. |
|
PushSecret is the name of a Secret that would be used for setting up the authentication for executing the Docker push to authentication enabled Docker Registry (or Docker Hub). |
|
|
to defines an optional location to push the output of this build to. Kind must be one of 'ImageStreamTag' or 'DockerImage'. This value will be used to look up a container image repository to push to. In the case of an ImageStreamTag, the ImageStreamTag will be looked for in the namespace of the build unless Namespace is specified. |
imageLabels define a list of labels that are applied to the resulting image. If there are multiple labels with the same name then the last one in the list is used.
array
ImageLabel represents a label applied to the resulting image.
object
name
| Property | Type | Description |
|---|---|---|
|
|
name defines the name of the label. It must have non-zero length. |
|
|
value defines the literal value of the label. |
A BuildPostCommitSpec holds a build post commit hook specification. The hook executes a command in a temporary container running the build output image, immediately after the last layer of the image is committed and before the image is pushed to a registry. The command is executed with the current working directory ($PWD) set to the image’s WORKDIR.
The build will be marked as failed if the hook execution fails. It will fail if the script or command return a non-zero exit code, or if there is any other error related to starting the temporary container.
There are five different ways to configure the hook. As an example, all forms below are equivalent and will execute rake test --verbose.
Shell script:
"postCommit": {
"script": "rake test --verbose",
}
The above is a convenient form which is equivalent to:
"postCommit": {
"command": ["/bin/sh", "-ic"],
"args": ["rake test --verbose"]
}
A command as the image entrypoint:
"postCommit": {
"commit": ["rake", "test", "--verbose"]
}
Command overrides the image entrypoint in the exec form, as documented in Docker: https://docs.docker.com/engine/reference/builder/#entrypoint.
Pass arguments to the default entrypoint:
"postCommit": {
"args": ["rake", "test", "--verbose"]
}
This form is only useful if the image entrypoint can handle arguments.
Shell script with arguments:
"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.
Command with arguments:
"postCommit": {
"command": ["rake", "test"],
"args": ["--verbose"]
}
This form is equivalent to appending the arguments to the Command slice.
It is invalid to provide both Script and Command simultaneously. If none of the fields are specified, the hook is not executed.
object
| Property | Type | Description |
|---|---|---|
|
|
args is a list of arguments that are provided to either Command, Script or the container image’s default entrypoint. The arguments are placed immediately after the command to be run. |
|
|
command is the command to run. It may not be specified with Script. This might be needed if the image doesn’t have |
|
|
script is a shell script to be run with |
SourceRevision is the revision or commit information from the source for the build
object
type
| Property | Type | Description |
|---|---|---|
|
|
GitSourceRevision is the commit information from a git source for a build |
|
|
type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |
GitSourceRevision is the commit information from a git source for a build
object
| Property | Type | Description |
|---|---|---|
|
|
SourceControlUser defines the identity of a user of source control |
|
|
commit is the commit hash identifying a specific commit |
|
|
SourceControlUser defines the identity of a user of source control |
|
|
message is the description of a specific commit |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
BuildSource is the SCM used for the build.
object
| Property | Type | Description |
|---|---|---|
|
|
BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source. |
|
|
configMaps represents a list of configMaps and their destinations that will be used for the build. |
|
|
ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time. The content of the configmap referenced here will be copied into the destination directory instead of mounting. |
|
|
contextDir specifies the sub-directory where the source code for the application exists. This allows to have buildable sources in directory other than root of repository. |
|
|
dockerfile is the raw contents of a Dockerfile which should be built. When this option is specified, the FROM may be modified based on your strategy base image and additional eNV stanzas from your strategy environment will be added after the FROM, but before the rest of your Dockerfile stanzas. The Dockerfile source type may be used with other options like git - in those cases the Git repo will have any innate Dockerfile replaced in the context dir. |
|
|
GitBuildSource defines the parameters of a Git SCM |
|
|
images describes a set of images to be used to provide source for the build |
|
|
ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. Image sources can either be used to extract content from an image and place it into the build context along with the repository source, or used directly during a multi-stage container image build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields). |
|
|
secrets represents a list of secrets and their destinations that will be used only for the build. |
|
|
SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting. |
|
sourceSecret is the name of a Secret that would be used for setting up the authentication for cloning private repository. The secret contains valid credentials for remote repository, where the data’s key represent the authentication method to be used and value is the base64 encoded credentials. Supported auth methods are: ssh-privatekey. |
|
|
|
type of build input to accept |
BinaryBuildSource describes a binary file to be used for the Docker and Source build strategies, where the file will be extracted and used as the build source.
object
| Property | Type | Description |
|---|---|---|
|
|
asFile indicates that the provided binary input should be considered a single file within the build input. For example, specifying "webapp.war" would place the provided binary as |
configMaps represents a list of configMaps and their destinations that will be used for the build.
array
ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time. The content of the configmap referenced here will be copied into the destination directory instead of mounting.
object
configMap
| Property | Type | Description |
|---|---|---|
|
configMap is a reference to an existing configmap that you want to use in your build. |
|
|
|
destinationDir is the directory where the files from the configmap should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. |
GitBuildSource defines the parameters of a Git SCM
object
uri
| Property | Type | Description |
|---|---|---|
|
|
httpProxy is a proxy used to reach the git repository over http |
|
|
httpsProxy is a proxy used to reach the git repository over https |
|
|
noProxy is the list of domains for which the proxy should not be used |
|
|
ref is the branch/tag/ref to build. |
|
|
uri points to the source that will be built. The structure of the source will depend on the type of build to run |
images describes a set of images to be used to provide source for the build
array
ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build. A reference of type ImageStreamTag, ImageStreamImage or DockerImage may be used. A pull secret can be specified to pull the image from an external registry or override the default service account secret if pulling from the internal registry. Image sources can either be used to extract content from an image and place it into the build context along with the repository source, or used directly during a multi-stage container image build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields).
object
from
| Property | Type | Description |
|---|---|---|
|
|
A list of image names that this source will be used in place of during a multi-stage container image build. For instance, a Dockerfile that uses "COPY --from=nginx:latest" will first check for an image source that has "nginx:latest" in this field before attempting to pull directly. If the Dockerfile does not reference an image source it is ignored. This field and paths may both be set, in which case the contents will be used twice. |
|
from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from. |
|
|
|
paths is a list of source and destination paths to copy from the image. This content will be copied into the build context prior to starting the build. If no paths are set, the build context will not be altered. |
|
|
ImageSourcePath describes a path to be copied from a source image and its destination within the build directory. |
|
pullSecret is a reference to a secret to be used to pull the image from a registry If the image is pulled from the OpenShift registry, this field does not need to be set. |
paths is a list of source and destination paths to copy from the image. This content will be copied into the build context prior to starting the build. If no paths are set, the build context will not be altered.
array
ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.
object
sourcePath
destinationDir
| Property | Type | Description |
|---|---|---|
|
|
destinationDir is the relative directory within the build directory where files copied from the image are placed. |
|
|
sourcePath is the absolute path of the file or directory inside the image to copy to the build directory. If the source path ends in /. then the content of the directory will be copied, but the directory itself will not be created at the destination. |
secrets represents a list of secrets and their destinations that will be used only for the build.
array
SecretBuildSource describes a secret and its destination directory that will be used only at the build time. The content of the secret referenced here will be copied into the destination directory instead of mounting.
object
secret
| Property | Type | Description |
|---|---|---|
|
|
destinationDir is the directory where the files from the secret should be available for the build time. For the Source build strategy, these will be injected into a container where the assemble script runs. Later, when the script finishes, all files injected will be truncated to zero length. For the container image build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during container image build. |
|
secret is a reference to an existing secret that you want to use in your build. |
BuildStrategy contains the details of how to perform a build.
object
| Property | Type | Description |
|---|---|---|
|
|
CustomBuildStrategy defines input parameters specific to Custom build. |
|
|
DockerBuildStrategy defines input parameters specific to container image build. |
|
|
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines |
|
|
SourceBuildStrategy defines input parameters specific to an Source build. |
|
|
type is the kind of build strategy. |
CustomBuildStrategy defines input parameters specific to Custom build.
object
from
| Property | Type | Description |
|---|---|---|
|
|
buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder |
|
env contains additional environment variables you want to pass into a builder container. |
|
|
|
exposeDockerSocket will allow running Docker commands (and build container images) from inside the container. |
|
|
forcePull describes if the controller should configure the build pod to always pull the images for the builder or only pull if it is not present locally |
|
from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled |
|
|
pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries |
|
|
|
secrets is a list of additional secrets that will be included in the build pod |
|
|
SecretSpec specifies a secret to be included in a build pod and its corresponding mount point |
secrets is a list of additional secrets that will be included in the build pod
array
SecretSpec specifies a secret to be included in a build pod and its corresponding mount point
object
secretSource
mountPath
| Property | Type | Description |
|---|---|---|
|
|
mountPath is the path at which to mount the secret |
|
secretSource is a reference to the secret |
DockerBuildStrategy defines input parameters specific to container image build.
object
| Property | Type | Description |
|---|---|---|
|
buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details. NOTe: Only the 'name' and 'value' fields are supported. Any settings on the 'valueFrom' field are ignored. |
|
|
|
dockerfilePath is the path of the Dockerfile that will be used to build the container image, relative to the root of the context (contextDir). Defaults to |
|
env contains additional environment variables you want to pass into a builder container. |
|
|
|
forcePull describes if the builder should pull the images from registry prior to building. |
|
from is a reference to an DockerImage, ImageStreamTag, or ImageStreamImage which overrides the FROM image in the Dockerfile for the build. If the Dockerfile uses multi-stage builds, this will replace the image in the last FROM directive of the file. |
|
|
|
imageOptimizationPolicy describes what optimizations the system can use when building images to reduce the final size or time spent building the image. The default policy is 'None' which means the final build image will be equivalent to an image created by the container image build API. The experimental policy 'SkipLayers' will avoid commiting new layers in between each image step, and will fail if the Dockerfile cannot provide compatibility with the 'None' policy. An additional experimental policy 'SkipLayersAndWarn' is the same as 'SkipLayers' but simply warns if compatibility cannot be preserved. |
|
|
noCache if set to true indicates that the container image build must be executed with the --no-cache=true flag |
|
pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries |
|
|
|
volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes |
|
|
BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah’s runtime environment. Only a subset of Kubernetes Volume sources are supported. |
volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes
array
BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah’s runtime environment. Only a subset of Kubernetes Volume sources are supported.
object
name
source
mounts
| Property | Type | Description |
|---|---|---|
|
|
mounts represents the location of the volume in the image build container |
|
|
BuildVolumeMount describes the mounting of a Volume within buildah’s runtime environment. |
|
|
name is a unique identifier for this BuildVolume. It must conform to the Kubernetes DNS label standard and be unique within the pod. Names that collide with those added by the build controller will result in a failed build with an error message detailing which name caused the error. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |
mounts represents the location of the volume in the image build container
array
BuildVolumeMount describes the mounting of a Volume within buildah’s runtime environment.
object
destinationPath
| Property | Type | Description |
|---|---|---|
|
|
destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |
BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time.
object
type
| Property | Type | Description |
|---|---|---|
|
configMap represents a ConfigMap that should populate this volume |
|
|
csi represents ephemeral storage provided by external CSI drivers which support this capability |
|
|
secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
|
type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build. Deprecated: use OpenShift Pipelines
object
| Property | Type | Description |
|---|---|---|
|
env contains additional environment variables you want to pass into a build pipeline. |
|
|
|
Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build. |
|
|
JenkinsfilePath is the optional path of the Jenkinsfile that will be used to configure the pipeline relative to the root of the context (contextDir). If both JenkinsfilePath & Jenkinsfile are both not specified, this defaults to Jenkinsfile in the root of the specified contextDir. |
SourceBuildStrategy defines input parameters specific to an Source build.
object
from
| Property | Type | Description |
|---|---|---|
|
env contains additional environment variables you want to pass into a builder container. |
|
|
|
forcePull describes if the builder should pull the images from registry prior to building. |
|
from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the container image should be pulled |
|
|
|
incremental flag forces the Source build to do incremental builds if true. |
|
pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the container images from the private Docker registries |
|
|
|
scripts is the location of Source scripts |
|
|
volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes |
|
|
BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah’s runtime environment. Only a subset of Kubernetes Volume sources are supported. |
volumes is a list of input volumes that can be mounted into the builds runtime environment. Only a subset of Kubernetes Volume sources are supported by builds. More info: https://kubernetes.io/docs/concepts/storage/volumes
array
BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah’s runtime environment. Only a subset of Kubernetes Volume sources are supported.
object
name
source
mounts
| Property | Type | Description |
|---|---|---|
|
|
mounts represents the location of the volume in the image build container |
|
|
BuildVolumeMount describes the mounting of a Volume within buildah’s runtime environment. |
|
|
name is a unique identifier for this BuildVolume. It must conform to the Kubernetes DNS label standard and be unique within the pod. Names that collide with those added by the build controller will result in a failed build with an error message detailing which name caused the error. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time. |
mounts represents the location of the volume in the image build container
array
BuildVolumeMount describes the mounting of a Volume within buildah’s runtime environment.
object
destinationPath
| Property | Type | Description |
|---|---|---|
|
|
destinationPath is the path within the buildah runtime environment at which the volume should be mounted. The transient mount within the build image and the backing volume will both be mounted read only. Must be an absolute path, must not contain '..' or ':', and must not collide with a destination path generated by the builder process Paths that collide with those added by the build controller will result in a failed build with an error message detailing which path caused the error. |
BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time.
object
type
| Property | Type | Description |
|---|---|---|
|
configMap represents a ConfigMap that should populate this volume |
|
|
csi represents ephemeral storage provided by external CSI drivers which support this capability |
|
|
secret represents a Secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret |
|
|
|
type is the BuildVolumeSourceType for the volume source. Type must match the populated volume source. Valid types are: Secret, ConfigMap |
triggeredBy describes which triggers started the most recent update to the build configuration and contains information about those triggers.
array
BuildTriggerCause holds information about a triggered build. It is used for displaying build trigger data for each build and build configuration in oc describe. It is also used to describe which triggers led to the most recent update in the build configuration.
object
| Property | Type | Description |
|---|---|---|
|
|
BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build. |
|
|
GenericWebHookCause holds information about a generic WebHook that triggered a build. |
|
|
GitHubWebHookCause has information about a GitHub webhook that triggered a build. |
|
|
GitLabWebHookCause has information about a GitLab webhook that triggered a build. |
|
|
ImageChangeCause contains information about the image that triggered a build |
|
|
message is used to store a human readable message for why the build was triggered. e.g.: "Manually triggered by user", "Configuration change",etc. |
BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.
object
| Property | Type | Description |
|---|---|---|
|
|
SourceRevision is the revision or commit information from the source for the build |
|
|
Secret is the obfuscated webhook secret that triggered a build. |
SourceRevision is the revision or commit information from the source for the build
object
type
| Property | Type | Description |
|---|---|---|
|
|
GitSourceRevision is the commit information from a git source for a build |
|
|
type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |
GitSourceRevision is the commit information from a git source for a build
object
| Property | Type | Description |
|---|---|---|
|
|
SourceControlUser defines the identity of a user of source control |
|
|
commit is the commit hash identifying a specific commit |
|
|
SourceControlUser defines the identity of a user of source control |
|
|
message is the description of a specific commit |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
GenericWebHookCause holds information about a generic WebHook that triggered a build.
object
| Property | Type | Description |
|---|---|---|
|
|
SourceRevision is the revision or commit information from the source for the build |
|
|
secret is the obfuscated webhook secret that triggered a build. |
SourceRevision is the revision or commit information from the source for the build
object
type
| Property | Type | Description |
|---|---|---|
|
|
GitSourceRevision is the commit information from a git source for a build |
|
|
type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |
GitSourceRevision is the commit information from a git source for a build
object
| Property | Type | Description |
|---|---|---|
|
|
SourceControlUser defines the identity of a user of source control |
|
|
commit is the commit hash identifying a specific commit |
|
|
SourceControlUser defines the identity of a user of source control |
|
|
message is the description of a specific commit |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
GitHubWebHookCause has information about a GitHub webhook that triggered a build.
object
| Property | Type | Description |
|---|---|---|
|
|
SourceRevision is the revision or commit information from the source for the build |
|
|
secret is the obfuscated webhook secret that triggered a build. |
SourceRevision is the revision or commit information from the source for the build
object
type
| Property | Type | Description |
|---|---|---|
|
|
GitSourceRevision is the commit information from a git source for a build |
|
|
type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |
GitSourceRevision is the commit information from a git source for a build
object
| Property | Type | Description |
|---|---|---|
|
|
SourceControlUser defines the identity of a user of source control |
|
|
commit is the commit hash identifying a specific commit |
|
|
SourceControlUser defines the identity of a user of source control |
|
|
message is the description of a specific commit |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
GitLabWebHookCause has information about a GitLab webhook that triggered a build.
object
| Property | Type | Description |
|---|---|---|
|
|
SourceRevision is the revision or commit information from the source for the build |
|
|
Secret is the obfuscated webhook secret that triggered a build. |
SourceRevision is the revision or commit information from the source for the build
object
type
| Property | Type | Description |
|---|---|---|
|
|
GitSourceRevision is the commit information from a git source for a build |
|
|
type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images' |
GitSourceRevision is the commit information from a git source for a build
object
| Property | Type | Description |
|---|---|---|
|
|
SourceControlUser defines the identity of a user of source control |
|
|
commit is the commit hash identifying a specific commit |
|
|
SourceControlUser defines the identity of a user of source control |
|
|
message is the description of a specific commit |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
SourceControlUser defines the identity of a user of source control
object
| Property | Type | Description |
|---|---|---|
|
|
email of the source control user |
|
|
name of the source control user |
ImageChangeCause contains information about the image that triggered a build
object
| Property | Type | Description |
|---|---|---|
|
fromRef contains detailed information about an image that triggered a build. |
|
|
|
imageID is the ID of the image that triggered a new build. |
BuildStatus contains the status of a build
object
phase
| Property | Type | Description |
|---|---|---|
|
|
cancelled describes if a cancel event was triggered for the build. |
|
completionTimestamp is a timestamp representing the server time when this Build was finished, whether that build failed or succeeded. It reflects the time at which the Pod running the Build terminated. It is represented in RFC3339 form and is in UTC. |
|
|
|
Conditions represents the latest available observations of a build’s current state. |
|
|
BuildCondition describes the state of a build at a certain point. |
|
config is an ObjectReference to the BuildConfig this Build is based on. |
|
|
|
duration contains time.Duration object describing build time. |
|
|
logSnippet is the last few lines of the build log. This value is only set for builds that failed. |
|
|
message is a human-readable message indicating details about why the build has this status. |
|
|
BuildStatusOutput contains the status of the built image. |
|
|
outputDockerImageReference contains a reference to the container image that will be built by this build. Its value is computed from Build.Spec.Output.To, and should include the registry address, so that it can be used to push and pull the image. |
|
|
phase is the point in the build lifecycle. Possible values are "New", "Pending", "Running", "Complete", "Failed", "error", and "Cancelled". |
|
|
reason is a brief CamelCase string that describes any failure and is meant for machine parsing and tidy display in the CLI. |
|
|
stages contains details about each stage that occurs during the build including start time, duration (in milliseconds), and the steps that occured within each stage. |
|
|
StageInfo contains details about a build stage. |
|
startTimestamp is a timestamp representing the server time when this Build started running in a Pod. It is represented in RFC3339 form and is in UTC. |
Conditions represents the latest available observations of a build’s current state.
array
BuildCondition describes the state of a build at a certain point.
object
type
status
| Property | Type | Description |
|---|---|---|
|
The last time the condition transitioned from one status to another. |
|
|
The last time this condition was updated. |
|
|
|
A human readable message indicating details about the transition. |
|
|
The reason for the condition’s last transition. |
|
|
Status of the condition, one of True, False, Unknown. |
|
|
Type of build condition. |
BuildStatusOutput contains the status of the built image.
object
| Property | Type | Description |
|---|---|---|
|
|
BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed. |
BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.
object
| Property | Type | Description |
|---|---|---|
|
|
imageDigest is the digest of the built container image. The digest uniquely identifies the image in the registry to which it was pushed. Please note that this field may not always be set even if the push completes successfully - e.g. when the registry returns no digest or returns it in a format that the builder doesn’t understand. |
stages contains details about each stage that occurs during the build including start time, duration (in milliseconds), and the steps that occured within each stage.
array
StageInfo contains details about a build stage.
object
| Property | Type | Description |
|---|---|---|
|
|
durationMilliseconds identifies how long the stage took to complete in milliseconds. Note: the duration of a stage can exceed the sum of the duration of the steps within the stage as not all actions are accounted for in explicit build steps. |
|
|
name is a unique identifier for each build stage that occurs. |
|
startTime is a timestamp representing the server time when this Stage started. It is represented in RFC3339 form and is in UTC. |
|
|
|
steps contains details about each step that occurs during a build stage including start time and duration in milliseconds. |
|
|
StepInfo contains details about a build step. |
steps contains details about each step that occurs during a build stage including start time and duration in milliseconds.
array
StepInfo contains details about a build step.
object
| Property | Type | Description |
|---|---|---|
|
|
durationMilliseconds identifies how long the step took to complete in milliseconds. |
|
|
name is a unique identifier for each build step. |
|
startTime is a timestamp representing the server time when this Step started. it is represented in RFC3339 form and is in UTC. |
The following API endpoints are available:
/apis/build.openshift.io/v1/builds
GeT: list or watch objects of kind Build
/apis/build.openshift.io/v1/watch/builds
GeT: watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead.
/apis/build.openshift.io/v1/namespaces/{namespace}/builds
DeLeTe: delete collection of Build
GeT: list or watch objects of kind Build
POST: create a Build
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds
GeT: watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead.
/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}
DeLeTe: delete a Build
GeT: read the specified Build
PATCH: partially update the specified Build
PUT: replace the specified Build
/apis/build.openshift.io/v1/watch/namespaces/{namespace}/builds/{name}
GeT: watch changes to an object of kind Build. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
/apis/build.openshift.io/v1/namespaces/{namespace}/builds/{name}/details
PUT: replace details of the specified Build
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks
POST: connect POST requests to webhooks of BuildConfig
/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}
POST: connect POST requests to webhooks of BuildConfig
GeT
list or watch objects of kind Build
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
GeT
watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
DeLeTe
delete collection of Build
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
GeT
list or watch objects of kind Build
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
POST
create a Build
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
202 - Accepted |
|
401 - Unauthorized |
empty |
GeT
watch individual changes to a list of Build. deprecated: use the 'watch' parameter with a list operation instead.
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Build |
DeLeTe
delete a Build
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
202 - Accepted |
|
401 - Unauthorized |
empty |
GeT
read the specified Build
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
PATCH
partially update the specified Build
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
empty |
PUT
replace the specified Build
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Build |
GeT
watch changes to an object of kind Build. deprecated: use the 'watch' parameter with a list operation instead, filtered to a single item with the 'fieldSelector' parameter.
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Build |
| Parameter | Type | Description |
|---|---|---|
|
|
When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed |
|
|
fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered. |
PUT
replace details of the specified Build
| Parameter | Type | Description |
|---|---|---|
|
|
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
201 - Created |
|
401 - Unauthorized |
empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Build |
POST
connect POST requests to webhooks of BuildConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |
| Parameter | Type | Description |
|---|---|---|
|
|
name of the Build |
POST
connect POST requests to webhooks of BuildConfig
| HTTP code | Reponse body |
|---|---|
200 - OK |
|
401 - Unauthorized |
empty |