BuildConfig [build.openshift.io/v1]

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

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.

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.

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.

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.

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'

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

email

string

email of the source control user

name

string

name of the source control user

email

string

email of the source control user

name

string

name of the source control user

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

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

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.

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

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.

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.

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.

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.

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

mountPath

string

mountPath is the path at which to mount the secret

secretSource

LocalObjectReference core/v1

secretSource is a reference to the secret

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

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.

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

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

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

name

string

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

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

name

string

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

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

name

string

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

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

name

string

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

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.

lastVersion

integer

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