Module v1

Structs

BinaryBuildSource

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.

BitbucketWebHookCause

BitbucketWebHookCause has information about a Bitbucket webhook that triggered a build.

Build

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.

BuildConfig

Build configurations define a build process for new container images. There are three types of builds possible - a container image 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 container images as a base and accept the build parameters. Builds run on the cluster and on completion are pushed to the container image 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.

BuildConfigSpec

BuildConfigSpec describes when and how builds are created

BuildConfigStatus

BuildConfigStatus contains current state of the build config object.

BuildLog

BuildLog is the (unused) resource associated with the build log redirector

BuildOutput

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

BuildPostCommitSpec

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.

BuildRequest

BuildRequest is the resource used to pass parameters to build generator

BuildSource

BuildSource is the SCM used for the build.

BuildSpec

BuildSpec has the information to represent a build and also additional information about a build

BuildStatus

BuildStatus contains the status of a build

BuildStatusOutput

BuildStatusOutput contains the status of the built image.

BuildStatusOutputTo

BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.

BuildStrategy

BuildStrategy contains the details of how to perform a build.

BuildTriggerCause

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.

BuildTriggerPolicy

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

ConfigMapBuildSource

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.

ConnectPostNamespacedBuildConfigInstantiatebinaryOptional

Optional parameters of Build::connect_post_namespaced_build_config_instantiatebinary

ConnectPostNamespacedBuildConfigWebhooksOptional

Optional parameters of Build::connect_post_namespaced_build_config_webhooks

ConnectPostNamespacedBuildConfigWebhooksWithPathOptional

Optional parameters of Build::connect_post_namespaced_build_config_webhooks_with_path

CustomBuildStrategy

CustomBuildStrategy defines input parameters specific to Custom build.

DockerBuildStrategy

DockerBuildStrategy defines input parameters specific to container image build.

DockerStrategyOptions

DockerStrategyOptions contains extra strategy options for container image builds

GenericWebHookCause

GenericWebHookCause holds information about a generic WebHook that triggered a build.

GitBuildSource

GitBuildSource defines the parameters of a Git SCM

GitHubWebHookCause

GitHubWebHookCause has information about a GitHub webhook that triggered a build.

GitLabWebHookCause

GitLabWebHookCause has information about a GitLab webhook that triggered a build.

GitSourceRevision

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

ImageChangeCause

ImageChangeCause contains information about the image that triggered a build

ImageChangeTrigger

ImageChangeTrigger allows builds to be triggered when an ImageStream changes

ImageLabel

ImageLabel represents a label applied to the resulting image.

ImageSource

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

ImageSourcePath

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

JenkinsPipelineBuildStrategy

JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.

ReadNamespacedBuildConfigOptional

Optional parameters of BuildConfig::read_namespaced_build_config

ReadNamespacedBuildLogOptional

Optional parameters of BuildLog::read_namespaced_build_log

ReadNamespacedBuildOptional

Optional parameters of Build::read_namespaced_build

SecretBuildSource

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.

SecretLocalReference

SecretLocalReference contains information that points to the local secret being used

SecretSpec

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

SourceBuildStrategy

SourceBuildStrategy defines input parameters specific to an Source build.

SourceControlUser

SourceControlUser defines the identity of a user of source control

SourceRevision

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

SourceStrategyOptions

SourceStrategyOptions contains extra strategy options for Source builds

StageInfo

StageInfo contains details about a build stage.

StepInfo

StepInfo contains details about a build step.

WebHookTrigger

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

Enums

CreateNamespacedBuildConfigInstantiateResponse

Use <CreateNamespacedBuildConfigInstantiateResponse as Response>::try_from_parts to parse the HTTP response body of BuildRequest::create_namespaced_build_config_instantiate

ReadNamespacedBuildConfigResponse

Use <ReadNamespacedBuildConfigResponse as Response>::try_from_parts to parse the HTTP response body of BuildConfig::read_namespaced_build_config

ReadNamespacedBuildLogResponse

Use <ReadNamespacedBuildLogResponse as Response>::try_from_parts to parse the HTTP response body of BuildLog::read_namespaced_build_log

ReadNamespacedBuildResponse

Use <ReadNamespacedBuildResponse as Response>::try_from_parts to parse the HTTP response body of Build::read_namespaced_build