util

Documentation

Overview

Package util contains common functions that are used by the rest of the OpenShift build system.

Index

• Constants
• func BuildConfigBuilds(c buildclient.BuildLister, namespace, name string, filterFunc buildFilter) (*buildapi.BuildList, error)
• func BuildConfigSelector(name string) labels.Selector
• func BuildConfigSelectorDeprecated(name string) labels.Selector
• func BuildNameForConfigVersion(name string, version int) string
• func BuildNumber(build *buildapi.Build) (int64, error)
• func BuildRunPolicy(build *buildapi.Build) buildapi.BuildRunPolicy
• func ConfigNameForBuild(build *buildapi.Build) string
• func GetBuildName(pod *kapi.Pod) string
• func GetInputReference(strategy buildapi.BuildStrategy) *kapi.ObjectReference
• func IsBuildComplete(build *buildapi.Build) bool
• func IsPaused(bc *buildapi.BuildConfig) bool
• func NameFromImageStream(namespace string, ref *kapi.ObjectReference, tag string) string
• func VersionForBuild(build *buildapi.Build) int

Constants

const (
	// NoBuildLogsMessage reports that no build logs are available
	NoBuildLogsMessage = "No logs are available."
)

Functions

func BuildConfigBuilds

func BuildConfigBuilds(c buildclient.BuildLister, namespace, name string, filterFunc buildFilter) (*buildapi.BuildList, error)

BuildConfigBuilds return a list of builds for the given build config. Optionally you can specify a filter function to select only builds that matches your criteria.

func BuildConfigSelector

func BuildConfigSelector(name string) labels.Selector

BuildConfigSelector returns a label Selector which can be used to find all builds for a BuildConfig.

func BuildConfigSelectorDeprecated

func BuildConfigSelectorDeprecated(name string) labels.Selector

BuildConfigSelectorDeprecated returns a label Selector which can be used to find all builds for a BuildConfig that use the deprecated labels.

func BuildNameForConfigVersion

func BuildNameForConfigVersion(name string, version int) string

BuildNameForConfigVersion returns the name of the version-th build for the config that has the provided name.

func BuildNumber

func BuildNumber(build *buildapi.Build) (int64, error)

BuildNumber returns the given build number.

func BuildRunPolicy

func BuildRunPolicy(build *buildapi.Build) buildapi.BuildRunPolicy

BuildRunPolicy returns the scheduling policy for the build based on the "queued" label.

func ConfigNameForBuild

func ConfigNameForBuild(build *buildapi.Build) string

ConfigNameForBuild returns the name of the build config from a build name.

func GetBuildName

func GetBuildName(pod *kapi.Pod) string

GetBuildName returns name of the build pod.

func GetInputReference

func GetInputReference(strategy buildapi.BuildStrategy) *kapi.ObjectReference

GetInputReference returns the From ObjectReference associated with the BuildStrategy.

func IsBuildComplete

func IsBuildComplete(build *buildapi.Build) bool

IsBuildComplete returns whether the provided build is complete or not

func IsPaused

func IsPaused(bc *buildapi.BuildConfig) bool

IsPaused returns true if the provided BuildConfig is paused and cannot be used to create a new Build

func NameFromImageStream

func NameFromImageStream(namespace string, ref *kapi.ObjectReference, tag string) string

NameFromImageStream returns a concatenated name representing an ImageStream[Tag/Image] reference. If the reference does not contain a Namespace, the namespace parameter is used instead.

func VersionForBuild

func VersionForBuild(build *buildapi.Build) int

VersionForBuild returns the version from the provided build name. If no version can be found, 0 is returned to indicate no version.