Description

Build configurations define a build process for new Docker images. There are three types of builds possible - a Docker build using a Dockerfile, a Source-to-Image build that uses a specially prepared base image that accepts source code that it can make runnable, and a custom build that can run // arbitrary Docker images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the Docker registry specified in the "output" section. A build can be triggered via a webhook, when the base image changes, or when a user manually requests a new build be // created.

Each build created by a build configuration is numbered and refers back to its parent configuration. Multiple builds can be triggered at once. Builds that do not have "output" set can be used to test code or run a verification build.

Type

object

Required
  • spec

Specification

Property Type Description

.apiVersion

string

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/api-conventions.md#resources

.kind

string

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/api-conventions.md#types-kinds

.metadata

ObjectMeta meta/v1

metadata for BuildConfig.

.spec

object

BuildConfigSpec describes when and how builds are created

.status

object

BuildConfigStatus contains current state of the build config object.

.spec
Description

BuildConfigSpec describes when and how builds are created

Type

object

Required
  • triggers

  • strategy

Property Type Description

completionDeadlineSeconds

integer

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

failedBuildsHistoryLimit

integer

failedBuildsHistoryLimit is the number of old failed builds to retain. If not specified, all failed builds are retained.

nodeSelector

object (string)

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.

output

object

BuildOutput is input to a build strategy and describes the Docker image that the strategy should produce.

postCommit

object

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.

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

ResourceRequirements core/v1

resources computes resource requirements to execute the build.

revision

object

SourceRevision is the revision or commit information from the source for the build

runPolicy

string

RunPolicy describes how the new build created from this build configuration will be scheduled for execution. This is optional, if not specified we default to "Serial".

serviceAccount

string

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

source

object

BuildSource is the SCM used for the build.

strategy

object

BuildStrategy contains the details of how to perform a build.

successfulBuildsHistoryLimit

integer

successfulBuildsHistoryLimit is the number of old successful builds to retain. If not specified, all successful builds are retained.

triggers

array

triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation.

triggers[]

object

BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.

.spec.output
Description

BuildOutput is input to a build strategy and describes the Docker image that the strategy should produce.

Type

object

Property Type Description

imageLabels

array

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.

imageLabels[]

object

ImageLabel represents a label applied to the resulting image.

pushSecret

LocalObjectReference core/v1

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

ObjectReference core/v1

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 Docker 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.

.spec.output.imageLabels
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.

Type

array

.spec.output.imageLabels[]
Description

ImageLabel represents a label applied to the resulting image.

Type

object

Required
  • name

Property Type Description

name

string

name defines the name of the label. It must have non-zero length.

value

string

value defines the literal value of the label.

.spec.postCommit
Description

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.

  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.

Type

object

Property Type Description

args

array (string)

args is a list of arguments that are provided to either Command, Script or the Docker image’s default entrypoint. The arguments are placed immediately after the command to be run.

command

array (string)

command is the command to run. It may not be specified with Script. This might be needed if the image doesn’t have /bin/sh, or if you do not want to use a shell. In all other cases, using Script might be more convenient.

script

string

script is a shell script to be run with /bin/sh -ic. It may not be specified with Command. Use Script when a shell script is appropriate to execute the post build hook, for example for running unit tests with rake test. If you need control over the image entrypoint, or if the image does not have /bin/sh, use Command and/or Args. The -i flag is needed to support CentOS and RHEL images that use Software Collections (SCL), in order to have the appropriate collections enabled in the shell. E.g., in the Ruby image, this is necessary to make ruby, bundle and other binaries available in the PATH.

.spec.revision
Description

SourceRevision is the revision or commit information from the source for the build

Type

object

Required
  • type

Property Type Description

git

object

GitSourceRevision is the commit information from a git source for a build

type

string

type of the build source, may be one of 'Source', 'Dockerfile', 'Binary', or 'Images'

.spec.revision.git
Description

GitSourceRevision is the commit information from a git source for a build

Type

object

Property Type Description

author

object

SourceControlUser defines the identity of a user of source control

commit

string

commit is the commit hash identifying a specific commit

committer

object

SourceControlUser defines the identity of a user of source control

message

string

message is the description of a specific commit

.spec.revision.git.author
Description

SourceControlUser defines the identity of a user of source control

Type

object

Property Type Description

email

string

email of the source control user

name

string

name of the source control user

.spec.revision.git.committer
Description

SourceControlUser defines the identity of a user of source control

Type

object

Property Type Description

email

string

email of the source control user

name

string

name of the source control user

.spec.source
Description

BuildSource is the SCM used for the build.

Type

object

Required
  • type

Property Type Description

binary

object

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

array

configMaps represents a list of configMaps and their destinations that will be used for the build.

configMaps[]

object

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

string

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

string

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.

git

object

GitBuildSource defines the parameters of a Git SCM

images

array

images describes a set of images to be used to provide source for the build

images[]

object

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 Docker build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields).

secrets

array

secrets represents a list of secrets and their destinations that will be used only for the build.

secrets[]

object

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

LocalObjectReference core/v1

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

string

type of build input to accept

.spec.source.binary
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.

Type

object

Property Type Description

asFile

string

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 /webapp.war for the builder. If left empty, the Docker and Source build strategies assume this file is a zip, tar, or tar.gz file and extract it as the source. The custom strategy receives this binary as standard input. This filename may not contain slashes or be '..' or '.'.

.spec.source.configMaps
Description

configMaps represents a list of configMaps and their destinations that will be used for the build.

Type

array

.spec.source.configMaps[]
Description

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.

Type

object

Required
  • configMap

Property Type Description

configMap

LocalObjectReference core/v1

configMap is a reference to an existing configmap that you want to use in your build.

destinationDir

string

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 Docker build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during docker build.

.spec.source.git
Description

GitBuildSource defines the parameters of a Git SCM

Type

object

Required
  • uri

Property Type Description

httpProxy

string

httpProxy is a proxy used to reach the git repository over http

httpsProxy

string

httpsProxy is a proxy used to reach the git repository over https

noProxy

string

noProxy is the list of domains for which the proxy should not be used

ref

string

ref is the branch/tag/ref to build.

uri

string

uri points to the source that will be built. The structure of the source will depend on the type of build to run

.spec.source.images
Description

images describes a set of images to be used to provide source for the build

Type

array

.spec.source.images[]
Description

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 Docker build to allow content to be copied without overwriting the contents of the repository source (see the 'paths' and 'as' fields).

Type

object

Required
  • from

Property Type Description

as

array (string)

A list of image names that this source will be used in place of during a multi-stage Docker 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

ObjectReference core/v1

from is a reference to an ImageStreamTag, ImageStreamImage, or DockerImage to copy source from.

paths

array

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.

paths[]

object

ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.

pullSecret

LocalObjectReference core/v1

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.

.spec.source.images[].paths
Description

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.

Type

array

.spec.source.images[].paths[]
Description

ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.

Type

object

Required
  • sourcePath

  • destinationDir

Property Type Description

destinationDir

string

destinationDir is the relative directory within the build directory where files copied from the image are placed.

sourcePath

string

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.

.spec.source.secrets
Description

secrets represents a list of secrets and their destinations that will be used only for the build.

Type

array

.spec.source.secrets[]
Description

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.

Type

object

Required
  • secret

Property Type Description

destinationDir

string

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 Docker build strategy, these will be copied into the build directory, where the Dockerfile is located, so users can ADD or COPY them during docker build.

secret

LocalObjectReference core/v1

secret is a reference to an existing secret that you want to use in your build.

.spec.strategy
Description

BuildStrategy contains the details of how to perform a build.

Type

object

Required
  • type

Property Type Description

customStrategy

object

CustomBuildStrategy defines input parameters specific to Custom build.

dockerStrategy

object

DockerBuildStrategy defines input parameters specific to Docker build.

jenkinsPipelineStrategy

object

JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.

sourceStrategy

object

SourceBuildStrategy defines input parameters specific to an Source build.

type

string

type is the kind of build strategy.

.spec.strategy.customStrategy
Description

CustomBuildStrategy defines input parameters specific to Custom build.

Type

object

Required
  • from

Property Type Description

buildAPIVersion

string

buildAPIVersion is the requested API version for the Build object serialized and passed to the custom builder

env

array (EnvVar core/v1)

env contains additional environment variables you want to pass into a builder container.

exposeDockerSocket

boolean

exposeDockerSocket will allow running Docker commands (and build Docker images) from inside the Docker container.

forcePull

boolean

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

ObjectReference core/v1

from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled

pullSecret

LocalObjectReference core/v1

pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

secrets

array

secrets is a list of additional secrets that will be included in the build pod

secrets[]

object

SecretSpec specifies a secret to be included in a build pod and its corresponding mount point

.spec.strategy.customStrategy.secrets
Description

secrets is a list of additional secrets that will be included in the build pod

Type

array

.spec.strategy.customStrategy.secrets[]
Description

SecretSpec specifies a secret to be included in a build pod and its corresponding mount point

Type

object

Required
  • secretSource

  • mountPath

Property Type Description

mountPath

string

mountPath is the path at which to mount the secret

secretSource

LocalObjectReference core/v1

secretSource is a reference to the secret

.spec.strategy.dockerStrategy
Description

DockerBuildStrategy defines input parameters specific to Docker build.

Type

object

Property Type Description

buildArgs

array (EnvVar core/v1)

buildArgs contains build arguments that will be resolved in the Dockerfile. See https://docs.docker.com/engine/reference/builder/#/arg for more details.

dockerfilePath

string

dockerfilePath is the path of the Dockerfile that will be used to build the Docker image, relative to the root of the context (contextDir).

env

array (EnvVar core/v1)

env contains additional environment variables you want to pass into a builder container.

forcePull

boolean

forcePull describes if the builder should pull the images from registry prior to building.

from

ObjectReference core/v1

from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled the resulting image will be used in the FROM line of the Dockerfile for this build.

imageOptimizationPolicy

string

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 Docker 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

boolean

noCache if set to true indicates that the docker build must be executed with the --no-cache=true flag

pullSecret

LocalObjectReference core/v1

pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

.spec.strategy.jenkinsPipelineStrategy
Description

JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.

Type

object

Property Type Description

env

array (EnvVar core/v1)

env contains additional environment variables you want to pass into a build pipeline.

jenkinsfile

string

Jenkinsfile defines the optional raw contents of a Jenkinsfile which defines a Jenkins pipeline build.

jenkinsfilePath

string

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.

.spec.strategy.sourceStrategy
Description

SourceBuildStrategy defines input parameters specific to an Source build.

Type

object

Required
  • from

Property Type Description

env

array (EnvVar core/v1)

env contains additional environment variables you want to pass into a builder container.

forcePull

boolean

forcePull describes if the builder should pull the images from registry prior to building.

from

ObjectReference core/v1

from is reference to an DockerImage, ImageStreamTag, or ImageStreamImage from which the docker image should be pulled

incremental

boolean

incremental flag forces the Source build to do incremental builds if true.

pullSecret

LocalObjectReference core/v1

pullSecret is the name of a Secret that would be used for setting up the authentication for pulling the Docker images from the private Docker registries

scripts

string

scripts is the location of Source scripts

.spec.triggers
Description

triggers determine how new Builds can be launched from a BuildConfig. If no triggers are defined, a new build can only occur as a result of an explicit client build creation.

Type

array

.spec.triggers[]
Description

BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.

Type

object

Required
  • type

Property Type Description

bitbucket

object

WebHookTrigger is a trigger that gets invoked using a webhook type of post

generic

object

WebHookTrigger is a trigger that gets invoked using a webhook type of post

github

object

WebHookTrigger is a trigger that gets invoked using a webhook type of post

gitlab

object

WebHookTrigger is a trigger that gets invoked using a webhook type of post

imageChange

object

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

type

string

type is the type of build trigger

.spec.triggers[].bitbucket
Description

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Type

object

Property Type Description

allowEnv

boolean

allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.

secret

string

secret used to validate requests. Deprecated: use SecretReference instead.

secretReference

object

SecretLocalReference contains information that points to the local secret being used

.spec.triggers[].bitbucket.secretReference
Description

SecretLocalReference contains information that points to the local secret being used

Type

object

Required
  • name

Property Type Description

name

string

Name is the name of the resource in the same namespace being referenced

.spec.triggers[].generic
Description

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Type

object

Property Type Description

allowEnv

boolean

allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.

secret

string

secret used to validate requests. Deprecated: use SecretReference instead.

secretReference

object

SecretLocalReference contains information that points to the local secret being used

.spec.triggers[].generic.secretReference
Description

SecretLocalReference contains information that points to the local secret being used

Type

object

Required
  • name

Property Type Description

name

string

Name is the name of the resource in the same namespace being referenced

.spec.triggers[].github
Description

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Type

object

Property Type Description

allowEnv

boolean

allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.

secret

string

secret used to validate requests. Deprecated: use SecretReference instead.

secretReference

object

SecretLocalReference contains information that points to the local secret being used

.spec.triggers[].github.secretReference
Description

SecretLocalReference contains information that points to the local secret being used

Type

object

Required
  • name

Property Type Description

name

string

Name is the name of the resource in the same namespace being referenced

.spec.triggers[].gitlab
Description

WebHookTrigger is a trigger that gets invoked using a webhook type of post

Type

object

Property Type Description

allowEnv

boolean

allowEnv determines whether the webhook can set environment variables; can only be set to true for GenericWebHook.

secret

string

secret used to validate requests. Deprecated: use SecretReference instead.

secretReference

object

SecretLocalReference contains information that points to the local secret being used

.spec.triggers[].gitlab.secretReference
Description

SecretLocalReference contains information that points to the local secret being used

Type

object

Required
  • name

Property Type Description

name

string

Name is the name of the resource in the same namespace being referenced

.spec.triggers[].imageChange
Description

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

Type

object

Property Type Description

from

ObjectReference core/v1

from is a reference to an ImageStreamTag that will trigger a build when updated It is optional. If no From is specified, the From image from the build strategy will be used. Only one ImageChangeTrigger with an empty From reference is allowed in a build configuration.

lastTriggeredImageID

string

lastTriggeredImageID is used internally by the ImageChangeController to save last used image ID for build

paused

boolean

paused is true if this trigger is temporarily disabled. Optional.

.status
Description

BuildConfigStatus contains current state of the build config object.

Type

object

Required
  • lastVersion

Property Type Description

lastVersion

integer

lastVersion is used to inform about number of last triggered build.

API endpoints

The following API endpoints are available:

  • /apis/build.openshift.io/v1/buildconfigs

    • GET: list or watch objects of kind BuildConfig

  • /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs

    • DELETE: delete collection of BuildConfig

    • GET: list or watch objects of kind BuildConfig

    • POST: create a BuildConfig

  • /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}

    • DELETE: delete a BuildConfig

    • GET: read the specified BuildConfig

    • PATCH: partially update the specified BuildConfig

    • PUT: replace the specified BuildConfig

  • /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}/instantiate

    • POST: create instantiate of a BuildConfig

  • /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}

    • POST: connect POST requests to webhooks of BuildConfig

  • /apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary

    • POST: connect POST requests to instantiatebinary of BuildConfig

/apis/build.openshift.io/v1/buildconfigs

Table 1. Global guery parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

pretty

string

If 'true', then the output is pretty printed.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

HTTP method

GET

Description

list or watch objects of kind BuildConfig

Table 2. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfigList build.openshift.io/v1

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs

Table 3. Global path parameters
Parameter Type Description

namespace

string

object name and auth scope, such as for teams and projects

Table 4. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete collection of BuildConfig

Table 5. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 6. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

list or watch objects of kind BuildConfig

Table 7. Query parameters
Parameter Type Description

continue

string

The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server the server will respond with a 410 ResourceExpired error indicating the client must restart their list without the continue field. This field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.

fieldSelector

string

A selector to restrict the list of returned objects by their fields. Defaults to everything.

includeUninitialized

boolean

If true, partially initialized resources are included in the response.

labelSelector

string

A selector to restrict the list of returned objects by their labels. Defaults to everything.

limit

integer

limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.

The server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.

resourceVersion

string

When specified with a watch call, shows changes that occur after that particular version of a resource. Defaults to changes from the beginning of history. When specified for list: - if unset, then the result is returned from remote storage based on quorum-read flag; - if it's 0, then we simply return what we currently have in cache, no guarantee; - if set to non zero, then the result is at least as fresh as given rv.

timeoutSeconds

integer

Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.

watch

boolean

Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.

Table 8. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfigList build.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

POST

Description

create a BuildConfig

Table 9. Body parameters
Parameter Type Description

body

BuildConfig build.openshift.io/v1

Table 10. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfig build.openshift.io/v1

201 - Created

BuildConfig build.openshift.io/v1

202 - Accepted

BuildConfig build.openshift.io/v1

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}

Table 11. Global path parameters
Parameter Type Description

name

string

name of the BuildConfig

namespace

string

object name and auth scope, such as for teams and projects

Table 12. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

DELETE

Description

delete a BuildConfig

Table 13. Query parameters
Parameter Type Description

gracePeriodSeconds

integer

The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.

orphanDependents

boolean

Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.

propagationPolicy

string

Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.

Table 14. Body parameters
Parameter Type Description

body

DeleteOptions meta/v1

Table 15. HTTP responses
HTTP code Reponse body

200 - OK

Status meta/v1

401 - Unauthorized

Empty

HTTP method

GET

Description

read the specified BuildConfig

Table 16. Query parameters
Parameter Type Description

exact

boolean

Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'.

export

boolean

Should this value be exported. Export strips fields that a user can not specify.

Table 17. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfig build.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

PATCH

Description

partially update the specified BuildConfig

Table 18. Body parameters
Parameter Type Description

body

Patch meta/v1

Table 19. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfig build.openshift.io/v1

401 - Unauthorized

Empty

HTTP method

PUT

Description

replace the specified BuildConfig

Table 20. Body parameters
Parameter Type Description

body

BuildConfig build.openshift.io/v1

Table 21. HTTP responses
HTTP code Reponse body

200 - OK

BuildConfig build.openshift.io/v1

201 - Created

BuildConfig build.openshift.io/v1

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks

Table 22. Global path parameters
Parameter Type Description

name

string

name of the Build

namespace

string

object name and auth scope, such as for teams and projects

Table 23. Global guery parameters
Parameter Type Description

path

string

Path is the URL path to use for the current proxy request to pod.

HTTP method

POST

Description

connect POST requests to webhooks of BuildConfig

Table 24. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiate

Table 25. Global path parameters
Parameter Type Description

name

string

name of the BuildRequest

namespace

string

object name and auth scope, such as for teams and projects

Table 26. Global guery parameters
Parameter Type Description

pretty

string

If 'true', then the output is pretty printed.

HTTP method

POST

Description

create instantiate of a BuildConfig

Table 27. Body parameters
Parameter Type Description

body

BuildRequest build.openshift.io/v1

Table 28. HTTP responses
HTTP code Reponse body

200 - OK

Build build.openshift.io/v1

201 - Created

Build build.openshift.io/v1

202 - Accepted

Build build.openshift.io/v1

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/webhooks/{path}

Table 29. Global path parameters
Parameter Type Description

name

string

name of the Build

namespace

string

object name and auth scope, such as for teams and projects

path

string

path to the resource

Table 30. Global guery parameters
Parameter Type Description

path

string

Path is the URL path to use for the current proxy request to pod.

HTTP method

POST

Description

connect POST requests to webhooks of BuildConfig

Table 31. HTTP responses
HTTP code Reponse body

200 - OK

string

401 - Unauthorized

Empty

/apis/build.openshift.io/v1/namespaces/{namespace}/buildconfigs/{name}/instantiatebinary

Table 32. Global path parameters
Parameter Type Description

name

string

name of the BinaryBuildRequestOptions

namespace

string

object name and auth scope, such as for teams and projects

Table 33. Global guery parameters
Parameter Type Description

asFile

string

asFile determines if the binary should be created as a file within the source rather than extracted as an archive

revision.authorEmail

string

revision.authorEmail of the source control user

revision.authorName

string

revision.authorName of the source control user

revision.commit

string

revision.commit is the value identifying a specific commit

revision.committerEmail

string

revision.committerEmail of the source control user

revision.committerName

string

revision.committerName of the source control user

revision.message

string

revision.message is the description of a specific commit

HTTP method

POST

Description

connect POST requests to instantiatebinary of BuildConfig

Table 34. HTTP responses
HTTP code Reponse body

200 - OK

Build build.openshift.io/v1

401 - Unauthorized

Empty