package
4.1.0+incompatible
Repository: https://github.com/openshift/origin.git
Documentation: pkg.go.dev

# Packages

# Functions

AddRoutes sets up routes for the provided objects.
AddServices sets up services for the provided objects.
AllContainerPorts creates a sorted list of all ports in all provided containers.
CloneAndCheckoutSources clones the remote repository using either regular git clone operation or shallow git clone, based on the "ref" provided (you cannot shallow clone using the 'ref').
ContainerPortsFromString extracts sets of port specifications from a comma-delimited string.
GenerateSecret generates a random secret string.
GeneratorInputFromMatch attempts to extract a GeneratorInput struct from the provided match.
InputImageFromMatch returns an image reference from a component match.
IsBuilderImage checks whether the provided Docker image is a builder image or not.
IsBuilderStreamTag checks whether the provided image stream tag is a builder image or not.
IsComponentReference returns an error if the provided string does not appear to be a reference to a source repository on disk, at a URL, a docker image name (which might be on a Docker registry or an OpenShift image stream), or a template.
IsDirectory returns true if the passed-in argument is a directory in the filesystem.
IsParameterizableValue returns true if the value contains standard replacement syntax, to preserve the value for use inside of the generated output.
IsPossibleTemplateFile returns true if the argument can be a template file.
IsRemoteRepository checks whether the provided string is a remote repository or not.
JoinEnvironment joins two different sets of environment variables into one, leaving out all the duplicates.
LabelsFromSpec turns a set of specs NAME=VALUE or NAME- into a map of labels, a remove label list, or an error.
LoadEnvironmentFile accepts filename of a file containing key=value pairs and puts these pairs into a map.
MakeSimpleName strips any non-alphanumeric characters out of a string and returns either an empty string or a string which is valid for most Kubernetes resources.
NewAcceptBuildConfigs creates an acceptor accepting BuildConfig objects and ImageStreams objects.
NewAcceptFirst returns a new Acceptor.
NewAcceptNonExistentImageStream creates an acceptor that accepts an object if it is either a) not an ImageStream, or b) an ImageStream which does not yet exist in the api server.
NewAcceptNonExistentImageStreamTag creates an acceptor that accepts an object if it is either a) not an ImageStreamTag, or b) an ImageStreamTag which does not yet exist in the api server.
NewAcceptUnique creates an acceptor that only accepts unique objects by kind and name.
NewBinarySourceRepository creates a source repository that is configured for binary input.
NewComponentInput returns a new ComponentInput by checking for image using [image]~ (to indicate builder) or [image]~[code] (builder plus code).
NewEnvironment returns a new set of environment variables based on all the provided environment variables.
NewImageRefGenerator creates a new ImageRefGenerator.
TODO: this doesn't really match the others - this should likely be a different type of object that is associated with a build or component.
NewImageStreamByAnnotationSearcher creates a new ImageStreamByAnnotationSearcher.
NewPipelineBuilder returns a PipelineBuilder using name as a base name.
NewSourceRepository creates a reference to a local or remote source code repository from a URL or path.
NewSourceRepositoryForDockerfile creates a source repository that is set up to use the contents of a Dockerfile as the input of the build.
NewSourceRepositoryWithDockerfile creates a reference to a local source code repository with the provided relative Dockerfile path (defaults to "Dockerfile").
NewUniqueNameGenerator creates a new UniqueNameGenerator with the given original name.
ParseAndCombineEnvironment parses key=value records from slice of strings (typically obtained from the command line) and from given files and combines them into single map.
ParseEnvironment takes a slice of strings in key=value format and transforms them into a map.
ParseEnvironmentAllowEmpty converts the provided strings in key=value form into environment entries.
StrategyAndSourceForRepository returns the build strategy and source code reference of the provided source repository TODO: user should be able to choose whether to download a remote source ref for more info.
UniqueContainerToServicePorts creates one service port for each unique container port.

# Constants

# Variables

AcceptAll accepts all objects.
AcceptNew only accepts runtime.Objects with an empty resource version.
ErrNameRequired is the error returned by new-app when a name cannot be suggested and the user needs to provide one explicitly.

# Structs

BuildRef is a reference to a build configuration.
BuildStrategyRef is a reference to a build strategy.
CircularOutputReferenceError is the error returned by new-app when the input and output image stream tags are identical.
CircularReferenceError is the error returned by new-app when either the input or output image stream tags employ circular loops.
ComponentInput is the necessary input for creating a component.
ComponentMatch is a match to a provided component.
DeploymentConfigRef is a reference to a deployment configuration.
DockerClientSearcher finds local docker images locally that match a search value.
DockerRegistrySearcher searches for images in a given docker registry.
ErrMultipleMatches is the error returned to new-app users when multiple matches are found for a given component.
ErrNoMatch is the error returned by new-app when no match is found for a given component.
ErrNoTagsFound is returned when a matching image stream has no tags associated with it.
ErrPartialMatch is the error returned to new-app users when the best match available is only a partial match for a given component.
FirstMatchResolver simply takes the first search result returned by the searcher it holds and resolves it to that match.
Generated is a list of runtime objects.
GeneratorJobReference is a reference that should be treated as a job execution, not a direct app creation.
HighestScoreResolver takes search result returned by the searcher it holds and resolves it to the highest scored match present.
HighestUniqueScoreResolver takes search result returned by the searcher it holds and resolves it to the highest scored match present.
ImageRef is a reference to an image.
ImageStreamByAnnotationSearcher searches for image streams based on 'supports' annotations found in tagged images belonging to the stream.
ImageStreamSearcher searches the openshift server image streams for images matching a particular name.
MissingImageSearcher always returns an exact match for the item being searched for.
Pipeline holds components.
PipelineResolver returns a dummy ComponentMatch for any value input.
ReferenceBuilder is used for building all the necessary object references for an application.
SourceLanguageType contains info about the type of the language a source repository is built in.
SourceRef is a reference to a build source.
SourceRepository represents a code repository that may be the target of a build.
SourceRepositoryEnumerator implements the Detector interface.
SourceRepositoryInfo contains info about a source repository.
TemplateFileSearcher resolves template files into template objects.
TemplateSearcher resolves stored template arguments into template objects.
UniqueExactOrInexactMatchResolver takes search result returned by the searcher it holds.
WeightedResolver is a resolver identified as exact or not, depending on its weight.
WeightedSearcher is a searcher identified as exact or not, depending on its weight.

# Interfaces

Acceptor is an interface for accepting objects.
ComponentReference defines an interface for components.
Detector is an interface for detecting information about a source repository.
DockerClient is the local interface for the docker client.
ImageRefGenerator is an interface for generating ImageRefs Generators for ImageRef - Name -> ImageRef - ImageRepo + tag -> ImageRef.
NameSuggester is an object that can suggest a name for itself.
A PipelineBuilder creates Pipeline instances.
Resolver is an interface for resolving provided input to component matches.
Searcher is responsible for performing a search based on the given terms and return all results found as component matches.
SecretAccessor is an interface for retrieving secrets from the calling context.
A UniqueNameGenerator is able to generate unique names from a given original name.

# Type aliases

Acceptors is a list of acceptors that behave like a single acceptor.
ComponentMatches holds multiple ComponentMatch.
ComponentReferences is a set of components.
Environment holds environment variables for new-app.
GroupedComponentReferences is a set of components that can be grouped by their group id.
MultiSimpleSearcher is a set of searchers.
MultiWeightedSearcher is a set of weighted searchers where lower weight has higher priority in search results.
NameSuggestions suggests names from a collection of NameSuggesters.
Objects is a set of runtime objects.
PerfectMatchWeightedResolver returns only matches from resolvers that are identified as exact (weight 0.0), and only matches from those resolvers that qualify as exact (score = 0.0).
PipelineGroup is a group of Pipelines.
ScoredComponentMatches is a set of component matches grouped by score.
SourceRepositories is a list of SourceRepository objects.