# Functions
Resource generated code relies on this being here, but it logically belongs to the group DEPRECATED.
# Constants
AllowedUIDs is an environment variable that contains ranges of UIDs that are allowed in Source builder images.
BitbucketWebHookBuildTriggerType represents a trigger that launches builds on Bitbucket webhook invocations.
BuildAnnotation is an annotation that identifies a Pod as being for a Build.
BuildCloneAnnotation is an annotation whose value is the name of the build this build was cloned from.
BuildConfigAnnotation is an annotation that identifies the BuildConfig that a Build was created from.
BuildConfigLabel is the key of a Build label whose value is the ID of a BuildConfig on which the Build is based.
BuildConfigLabelDeprecated was used as BuildConfigLabel before adding namespaces.
BuildConfigPausedAnnotation is an annotation that marks a BuildConfig as paused.
BuildJenkinsBlueOceanLogURLAnnotation is an annotation holding a link to the Jenkins build console log via the Jenkins BlueOcean UI Plugin.
BuildJenkinsBuildURIAnnotation is an annotation holding a link to the Jenkins build.
BuildJenkinsConsoleLogURLAnnotation is an annotation holding a link to the Jenkins build console log (including Jenkins chrome wrappering).
BuildJenkinsLogURLAnnotation is an annotation holding a link to the raw Jenkins build console log.
BuildJenkinsStatusJSONAnnotation is an annotation holding the Jenkins status information.
BuildLabel is the key of a Pod label whose value is the Name of a Build which is run.
BuildNumberAnnotation is an annotation whose value is the sequential number for this Build.
BuildPhaseCancelled indicates that a running/pending build was stopped from executing.
BuildPhaseComplete indicates that a build has been successful.
BuildPhaseError indicates that an error prevented the build from executing.
BuildPhaseFailed indicates that a build has executed and failed.
BuildPhaseNew is automatically assigned to a newly created build.
BuildPhasePending indicates that a pod name has been assigned and a build is about to start running.
BuildPhaseRunning indicates that a pod has been created and a build is running.
BuildPodNameAnnotation is an annotation whose value is the name of the pod running this build.
BuildRunPolicyLabel represents the start policy used to start the build.
BuildRunPolicyParallel schedules new builds immediately after they are created.
BuildRunPolicySerial schedules new builds to execute in a sequence as they are created.
BuildRunPolicySerialLatestOnly schedules only the latest build to execute, cancelling all the previously queued build.
BuildSourceBinary indicates the build will accept a Binary file as input.
BuildSourceDockerfile uses a Dockerfile as the start of a build.
BuildSourceGit instructs a build to use a Git source control repository as the build input.
BuildSourceImage indicates the build will accept an image as input.
BuildSourceNone indicates the build has no predefined input (only valid for Source and Custom Strategies).
BuildSourceSecretMatchURIAnnotationPrefix is a prefix for annotations on a Secret which indicate a source URI against which the Secret can be used.
BuildVolumeSourceTypeConfigmap is the ConfigMap build source volume type.
BuildVolumeSourceTypeCSI is the CSI build source volume type.
BuildVolumeSourceTypeSecret is the Secret build source volume type.
ConfigChangeBuildTriggerType will trigger a build on an initial build config creation WARNING: In the future the behavior will change to trigger a build on any config change.
CustomBuildStrategyBaseImageKey is the environment variable that indicates the base image to be used when performing a custom build, if needed.
CustomBuildStrategyType performs builds using custom builder container image.
DockerBuildStrategyType performs builds using a Dockerfile.
DropCapabilities is an environment variable that contains a list of capabilities to drop when executing a Source build.
GenericWebHookBuildTriggerType represents a trigger that launches builds on generic webhook invocations.
No description provided by the author
GitHubWebHookBuildTriggerType represents a trigger that launches builds on GitHub webhook invocations.
No description provided by the author
GitLabWebHookBuildTriggerType represents a trigger that launches builds on GitLab webhook invocations.
ImageChangeBuildTriggerType represents a trigger that launches builds on availability of a new version of an image.
No description provided by the author
ImageOptimizationNone will generate a canonical container image as produced by the `container image build` command.
ImageOptimizationSkipLayers is an experimental policy and will avoid creating unique layers for each dockerfile line, resulting in smaller images and saving time during creation.
ImageOptimizationSkipLayersAndWarn is the same as SkipLayers, but will only warn to the build output instead of failing when unsupported syntax is detected.
JenkinsPipelineBuildStrategyType indicates the build will run via Jenkine Pipeline.
RegistryConfKey is the ConfigMap key for the build pod's registry configuration file.
ServiceCAKey is the ConfigMap key for the service signing certificate authority mounted into build pods.
SignaturePolicyKey is the ConfigMap key for the build pod's image signature policy file.
SourceBuildStrategyType performs builds build using Source To Images with a Git repository and a builder image.
StageBuild performs the steps necessary to build the image.
StageFetchInputs fetches any inputs such as source code.
StagePostCommit executes any post commit steps.
StagePullImages pulls any images that are needed such as base images or input images.
StagePushImage pushes the image to the node.
StatusReasonBuildPodDeleted is an error condition when the build pod is deleted before build completion.
StatusReasonBuildPodEvicted is the reason a build fails due to the build pod being evicted from its node.
StatusReasonBuildPodExists indicates that the build tried to create a build pod but one was already present.
StatusReasonCancelBuildFailed is an error condition when cancelling a build fails.
StatusReasonCancelledBuild indicates that the build was cancelled by the user.
StatusReasonCannotCreateBuildPod is an error condition when a build pod cannot be created.
StatusReasonCannotCreateBuildPodSpec is an error condition when the build strategy cannot create a build pod spec.
StatusReasonCannotRetrieveServiceAccount is the reason associated with a failure to look up the service account associated with the BuildConfig.
StatusReasonDockerBuildFailed indicates that the container image build strategy has failed.
StatusReasonError is a generic reason for a build error condition.
StatusReasonExceededRetryTimeout is an error condition when the build has not completed and retrying the build times out.
StatusReasonFailedContainer indicates that the pod for the build has at least one container with a non-zero exit status.
StatusReasonFetchImageContentFailed indicates that the fetching of an image and extracting its contents for inclusion in the build has failed.
StatusReasonFetchSourceFailed indicates that fetching the source of the build has failed.
StatusReasonGenericBuildFailed is the reason associated with a broad range of build failures.
StatusReasonInvalidContextDirectory indicates that the supplied contextDir does not exist.
StatusReasonInvalidImageReference is an error condition when the build references an invalid image.
StatusReasonInvalidOutputReference is an error condition when the build output is an invalid reference.
StatusReasonManageDockerfileFailed indicates that the set up of the Dockerfile for the build has failed.
StatusReasonMissingPushSecret indicates that the build is missing required secret for pushing the output image.
StatusReasonNoBuildContainerStatus indicates that the build failed because the the build pod has no container statuses.
StatusReasonOutOfMemoryKilled indicates that the build pod was killed for its memory consumption.
StatusReasonPostCommitHookFailed indicates the post-commit hook failed.
StatusReasonPullBuilderImageFailed indicates that we failed to pull the builder image.
StatusReasonPushImageToRegistryFailed indicates that an image failed to be pushed to the registry.
StatusReasonUnresolvableEnvironmentVariable indicates that an error occurred processing the supplied options for environment variables in the build strategy environment.
StepDockerBuild performs the container image build.
StepExecPostCommitHook executes the buildconfigs post commit hook.
StepFetchGitSource fetches source code for the build.
StepPullBaseImage pulls a base image for the build.
StepPullInputImage pulls an input image for the build.
StepPushDockerImage pushes a container image to the registry.
StepPushImage pushes an image to the registry.
WebHookSecretKey is the key used to identify the value containing the webhook invocation secret within a secret referenced by a webhook trigger.
# Variables
AddToScheme exists solely to keep the old generators creating valid code DEPRECATED.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Install is a function which adds this version to a scheme.
SchemeGroupVersion generated code relies on this name Deprecated.
env vars WhitelistEnvVarNames is a list of special env vars allows s2i containers.
# Structs
BinaryBuildRequestOptions are the options required to fully speficy a binary build request
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
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 has information about a Bitbucket webhook that triggered a 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.
BuildCondition describes the state of a build at a certain point.
Build configurations define a build process for new container images.
BuildConfigList is a collection of BuildConfigs.
BuildConfigSpec describes when and how builds are created.
BuildConfigStatus contains current state of the build config object.
BuildList is a collection of Builds.
BuildLog is the (unused) resource associated with the build log redirector
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
BuildLogOptions is the REST options for a build log
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
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.
BuildRequest is the resource used to pass parameters to build generator
Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
BuildSource is the SCM used for the build.
BuildSpec has the information to represent a build and also additional information about a build.
BuildStatus contains the status of a build.
BuildStatusOutput contains the status of the built image.
BuildStatusOutputTo describes the status of the built image with regards to image registry to which it was supposed to be pushed.
BuildStrategy contains the details of how to perform a build.
BuildTriggerCause holds information about a triggered build.
BuildTriggerPolicy describes a policy for a single trigger that results in a new Build.
BuildVolume describes a volume that is made available to build pods, such that it can be mounted into buildah's runtime environment.
BuildVolumeMount describes the mounting of a Volume within buildah's runtime environment.
BuildVolumeSource represents the source of a volume to mount Only one of its supported types may be specified at any given time.
CommonSpec encapsulates all the inputs necessary to represent a build.
CommonWebHookCause factors out the identical format of these webhook causes into struct so we can share it in the specific causes; it is too late for GitHub and Generic but we can leverage this pattern with GitLab and Bitbucket.
ConfigMapBuildSource describes a configmap and its destination directory that will be used only at the build time.
CustomBuildStrategy defines input parameters specific to Custom build.
DockerBuildStrategy defines input parameters specific to container image build.
DockerStrategyOptions contains extra strategy options for container image builds.
GenericWebHookCause holds information about a generic WebHook that triggered a build.
GenericWebHookEvent is the payload expected for a generic webhook post.
GitBuildSource defines the parameters of a Git SCM.
GitHubWebHookCause has information about a GitHub webhook that triggered a build.
GitInfo is the aggregated git information for a generic webhook post.
GitLabWebHookCause has information about a GitLab webhook that triggered a build.
GitRefInfo is a single ref.
GitSourceRevision is the commit information from a git source for a build.
ImageChangeCause contains information about the image that triggered a build.
ImageChangeTrigger allows builds to be triggered when an ImageStream changes.
ImageChangeTriggerStatus tracks the latest resolved status of the associated ImageChangeTrigger policy specified in the BuildConfigSpec.Triggers struct.
ImageLabel represents a label applied to the resulting image.
ImageSource is used to describe build source that will be extracted from an image or used during a multi stage build.
ImageSourcePath describes a path to be copied from a source image and its destination within the build directory.
ImageStreamTagReference references the ImageStreamTag in an image change trigger by namespace and name.
JenkinsPipelineBuildStrategy holds parameters specific to a Jenkins Pipeline build.
ProxyConfig defines what proxies to use for an operation.
SecretBuildSource describes a secret and its destination directory that will be used only at the build time.
SecretLocalReference contains information that points to the local secret being used.
SecretSpec specifies a secret to be included in a build pod and its corresponding mount point.
SourceBuildStrategy defines input parameters specific to an Source build.
SourceControlUser defines the identity of a user of source control.
SourceRevision is the revision or commit information from the source for the build.
SourceStrategyOptions contains extra strategy options for Source builds.
StageInfo contains details about a build stage.
StepInfo contains details about a build step.
WebHookTrigger is a trigger that gets invoked using a webhook type of post.
# Type aliases
No description provided by the author
BuildPhase represents the status of a build at a point in time.
BuildRunPolicy defines the behaviour of how the new builds are executed from the existing build configuration.
BuildSourceType is the type of SCM used.
BuildStrategyType describes a particular way of performing a build.
BuildTriggerType refers to a specific BuildTriggerPolicy implementation.
BuildVolumeSourceType represents a build volume source type.
ImageOptimizationPolicy describes what optimizations the builder can perform when building images.
OptionalNodeSelector is a map that may also be left nil to distinguish between set and unset.
StageName is the unique identifier for each build stage.
StatusReason is a brief CamelCase string that describes a temporary or permanent build error condition, meant for machine parsing and tidy display in the CLI.
StepName is a unique identifier for each build step.