app

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 19, 2015 License: Apache-2.0 Imports: 36 Imported by: 0

Documentation

Overview

Package app defines reference objects used to generate OpenShift API objects

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuilderForPlatform added in v0.4.2

func BuilderForPlatform(platform string) string

BuilderForPlatform expands the provided platform to the respective OpenShift image

TODO: Remove once a real image searcher is implemented

func ContainerPortsFromString added in v0.3.2

func ContainerPortsFromString(portString string) ([]kapi.ContainerPort, error)

ContainerPortsFromString extracts sets of port specifications from a comma-delimited string. Each segment must be a single port number (container port) or a colon delimited pair of ports (container port and host port).

func IsBuilderImage

func IsBuilderImage(image *imageapi.DockerImage) bool

IsBuilderImage checks whether the provided Docker image is a builder image or not

func IsComponentReference

func IsComponentReference(s string) bool

IsComponentReference returns true if the provided string appears 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.

func IsPossibleSourceRepository

func IsPossibleSourceRepository(s string) bool

IsPossibleSourceRepository checks whether the provided string is a source repository or not

func IsRemoteRepository

func IsRemoteRepository(s string) bool

IsRemoteRepository checks whether the provided string is a remote repository or not

func JoinEnvironment

func JoinEnvironment(a, b []kapi.EnvVar) (out []kapi.EnvVar)

JoinEnvironment joins two different sets of environment variables into one, leaving out all the duplicates

func LabelsFromSpec added in v0.3.2

func LabelsFromSpec(spec []string) (map[string]string, []string, error)

LabelsFromSpec turns a set of specs NAME=VALUE or NAME- into a map of labels, a remove label list, or an error.

func StrategyAndSourceForRepository

func StrategyAndSourceForRepository(repo *SourceRepository, image *ImageRef) (*BuildStrategyRef, *SourceRef, error)

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

Types

type Acceptor

type Acceptor interface {
	Accept(from interface{}) bool
}

Acceptor is an interface for accepting objects

var AcceptAll Acceptor = acceptAll{}

AcceptAll accepts all objects

var AcceptNew Acceptor = acceptNew{}

AcceptNew only accepts runtime.Objects with an empty resource version.

func NewAcceptFirst

func NewAcceptFirst() Acceptor

NewAcceptFirst returns a new Acceptor

func NewAcceptUnique added in v0.4.4

func NewAcceptUnique(typer runtime.ObjectTyper) Acceptor

NewAcceptUnique creates an acceptor that only accepts unique objects by kind and name

type Acceptors added in v0.4.4

type Acceptors []Acceptor

Acceptors is a list of acceptors that behave like a single acceptor. All acceptors must accept an object for it to be accepted.

func (Acceptors) Accept added in v0.4.4

func (aa Acceptors) Accept(from interface{}) bool

Accept iterates through all acceptors and determines whether the object should be accepted

type BuildRef

type BuildRef struct {
	Source   *SourceRef
	Input    *ImageRef
	Strategy *BuildStrategyRef
	Output   *ImageRef
}

BuildRef is a reference to a build configuration

func (*BuildRef) BuildConfig

func (r *BuildRef) BuildConfig() (*buildapi.BuildConfig, error)

BuildConfig creates a buildConfig resource from the build configuration reference

type BuildStrategyRef

type BuildStrategyRef struct {
	IsDockerBuild bool
	Base          *ImageRef
}

BuildStrategyRef is a reference to a build strategy

func (*BuildStrategyRef) BuildStrategy

BuildStrategy builds an OpenShift BuildStrategy from a BuildStrategyRef

type BuildStrategyRefGenerator added in v0.5.1

type BuildStrategyRefGenerator struct {
	// contains filtered or unexported fields
}

BuildStrategyRefGenerator generates BuildStrategyRef

Flows for BuildStrategyRef SourceRef -> BuildStrategyRef SourceRef + Docker Context -> BuildStrategyRef Docker Context + Parent Image -> BuildStrategyRef STI Builder Image -> BuildStrategyRef

func NewBuildStrategyRefGenerator added in v0.5.1

func NewBuildStrategyRefGenerator(sourceDetectors source.Detectors) *BuildStrategyRefGenerator

NewBuildStrategyRefGenerator creates a BuildStrategyRefGenerator

func (*BuildStrategyRefGenerator) FromDockerContextAndParent added in v0.5.1

func (g *BuildStrategyRefGenerator) FromDockerContextAndParent(parentRef *ImageRef) (*BuildStrategyRef, error)

FromDockerContextAndParent generates a build strategy ref from a context path and parent image name

func (*BuildStrategyRefGenerator) FromSTIBuilderImage added in v0.5.1

func (g *BuildStrategyRefGenerator) FromSTIBuilderImage(image *ImageRef) (*BuildStrategyRef, error)

FromSTIBuilderImage generates a build strategy from a builder image ref

func (*BuildStrategyRefGenerator) FromSourceRef added in v0.5.1

func (g *BuildStrategyRefGenerator) FromSourceRef(srcRef *SourceRef) (*BuildStrategyRef, error)

FromSourceRef creates a build strategy from a source reference

func (*BuildStrategyRefGenerator) FromSourceRefAndDockerContext added in v0.5.1

func (g *BuildStrategyRefGenerator) FromSourceRefAndDockerContext(srcRef *SourceRef, context string) (*BuildStrategyRef, error)

FromSourceRefAndDockerContext generates a BuildStrategyRef from a source ref and context path

type ComponentInput

type ComponentInput struct {
	GroupID       int
	From          string
	Argument      string
	Value         string
	ExpectToBuild bool

	Uses  *SourceRepository
	Match *ComponentMatch

	Resolver
}

ComponentInput is the necessary input for creating a component

func NewComponentInput

func NewComponentInput(input string) (*ComponentInput, string, error)

NewComponentInput returns a new ComponentInput by checking for image using [image]~ (to indicate builder) or [image]~[code] (builder plus code)

func (*ComponentInput) Input

func (i *ComponentInput) Input() *ComponentInput

Input returns the component input

func (*ComponentInput) NeedsSource

func (i *ComponentInput) NeedsSource() bool

NeedsSource indicates if the component input needs source code

func (*ComponentInput) Resolve

func (i *ComponentInput) Resolve() error

Resolve sets the match in input

func (*ComponentInput) String

func (i *ComponentInput) String() string

func (*ComponentInput) Use

func (i *ComponentInput) Use(repo *SourceRepository)

Use adds the provided source repository as the used one by the component input

type ComponentMatch

type ComponentMatch struct {
	Value       string
	Argument    string
	Name        string
	Description string
	Score       float32

	Builder     bool
	Image       *imageapi.DockerImage
	ImageStream *imageapi.ImageStream
	ImageTag    string
	Template    *templateapi.Template
}

ComponentMatch is a match to a provided component

func (*ComponentMatch) IsImage added in v0.4.4

func (m *ComponentMatch) IsImage() bool

IsImage returns whether or not the component match is an image or image stream

func (*ComponentMatch) IsTemplate added in v0.4.4

func (m *ComponentMatch) IsTemplate() bool

IsTemplate returns whether or not the component match is a template

func (*ComponentMatch) String

func (m *ComponentMatch) String() string

type ComponentReference

type ComponentReference interface {
	// Input contains the input of the component
	Input() *ComponentInput
	// Resolve sets the match in input
	Resolve() error
	// NeedsSource indicates if the component needs source code
	NeedsSource() bool
}

ComponentReference defines an interface for components

type ComponentReferences

type ComponentReferences []ComponentReference

ComponentReferences is a set of components

func (ComponentReferences) Group

func (r ComponentReferences) Group() (refs []ComponentReferences)

Group groups components based on their group ids

func (ComponentReferences) NeedsSource

func (r ComponentReferences) NeedsSource() (refs ComponentReferences)

NeedsSource returns all the components that need source code in order to build

func (ComponentReferences) String added in v0.5.1

func (r ComponentReferences) String() string

type DeploymentConfigRef

type DeploymentConfigRef struct {
	Name   string
	Images []*ImageRef
	Env    Environment
}

DeploymentConfigRef is a reference to a deployment configuration

func (*DeploymentConfigRef) DeploymentConfig

func (r *DeploymentConfigRef) DeploymentConfig() (*deployapi.DeploymentConfig, error)

DeploymentConfig creates a deploymentConfig resource from the deployment configuration reference

TODO: take a pod template spec as argument

type Detector

type Detector interface {
	Detect(dir string) (*SourceRepositoryInfo, error)
}

Detector is an interface for detecting information about a source repository

type DockerClientResolver

type DockerClientResolver struct {
	Client *docker.Client

	// Optional, will delegate resolution to the registry if no local
	// exact matches are found.
	RegistryResolver Resolver
}

func (DockerClientResolver) Resolve

func (r DockerClientResolver) Resolve(value string) (*ComponentMatch, error)

type DockerRegistryResolver

type DockerRegistryResolver struct {
	Client dockerregistry.Client

	AllowInsecure bool
}

func (DockerRegistryResolver) Resolve

func (r DockerRegistryResolver) Resolve(value string) (*ComponentMatch, error)

type Environment

type Environment map[string]string

Environment holds environment variables for new-app

func NewEnvironment

func NewEnvironment(envs ...map[string]string) Environment

NewEnvironment returns a new set of environment variables based on all the provided environment variables

func (Environment) List

func (e Environment) List() []kapi.EnvVar

List sorts and returns all the environment variables

type ErrMultipleMatches

type ErrMultipleMatches struct {
	Image   string
	Matches []*ComponentMatch
}

ErrMultipleMatches is an error returned to new-app users when multiple matches are found for a given component

func (ErrMultipleMatches) Error

func (e ErrMultipleMatches) Error() string

func (ErrMultipleMatches) UsageError

func (e ErrMultipleMatches) UsageError(commandName string) string

UsageError is the usage error message returned when multiple matches are found

type ErrNoMatch

type ErrNoMatch struct {
	// contains filtered or unexported fields
}

ErrNoMatch is an error returned to new-app users when no match is found for a given component

func (ErrNoMatch) Error

func (e ErrNoMatch) Error() string

func (ErrNoMatch) UsageError

func (e ErrNoMatch) UsageError(commandName string) string

UsageError is the usage error message returned when no match is found

type Generated

type Generated struct {
	Items []runtime.Object
}

Generated is a list of runtime objects

func (*Generated) WithType

func (g *Generated) WithType(slicePtr interface{}) bool

WithType extracts a list of runtime objects with the specified type

type GroupedComponentReferences

type GroupedComponentReferences ComponentReferences

GroupedComponentReferences is a set of components that can be grouped by their group id

func (GroupedComponentReferences) Len

func (GroupedComponentReferences) Less

func (m GroupedComponentReferences) Less(i, j int) bool

func (GroupedComponentReferences) Swap

func (m GroupedComponentReferences) Swap(i, j int)

type ImageRef

type ImageRef struct {
	imageapi.DockerImageReference
	AsImageStream bool
	OutputImage   bool

	Stream *imageapi.ImageStream
	Info   *imageapi.DockerImage
}

ImageRef is a reference to an image

func InputImageFromMatch

func InputImageFromMatch(match *ComponentMatch) (*ImageRef, error)

InputImageFromMatch returns an image reference from a component match. The component match will either be an image stream or an image.

func (*ImageRef) BuildOutput

func (r *ImageRef) BuildOutput() (*buildapi.BuildOutput, error)

BuildOutput returns the BuildOutput of an image reference

func (*ImageRef) BuildTriggers

func (r *ImageRef) BuildTriggers() []buildapi.BuildTriggerPolicy

BuildTriggers sets up build triggers for the base image

func (*ImageRef) DeployableContainer

func (r *ImageRef) DeployableContainer() (container *kapi.Container, triggers []deployapi.DeploymentTriggerPolicy, err error)

DeployableContainer sets up a container for the image ready for deployment

func (*ImageRef) ImageStream added in v0.4.3

func (r *ImageRef) ImageStream() (*imageapi.ImageStream, error)

ImageStream returns an ImageStream from an image reference

func (*ImageRef) ObjectReference added in v0.5.1

func (r *ImageRef) ObjectReference() *kapi.ObjectReference

ObjectReference returns an object reference from the image reference

func (*ImageRef) RepoName

func (r *ImageRef) RepoName() string

RepoName returns the name of the image in namespace/name format

func (*ImageRef) SuggestName

func (r *ImageRef) SuggestName() (string, bool)

SuggestName suggests a name for an image reference

type ImageRefGenerator added in v0.5.1

type ImageRefGenerator interface {
	FromName(name string) (*ImageRef, error)
	FromNameAndPorts(name string, ports []string) (*ImageRef, error)
	FromStream(repo *imageapi.ImageStream, tag string) (*ImageRef, error)
	FromDockerfile(name string, dir string, context string) (*ImageRef, error)
}

ImageRefGenerator is an interface for generating ImageRefs

Generators for ImageRef - Name -> ImageRef - ImageRepo + tag -> ImageRef

func NewImageRefGenerator added in v0.5.1

func NewImageRefGenerator() ImageRefGenerator

NewImageRefGenerator creates a new ImageRefGenerator

type ImageStreamResolver

type ImageStreamResolver struct {
	Client            client.ImageStreamsNamespacer
	ImageStreamImages client.ImageStreamImagesNamespacer
	Namespaces        []string
}

func (ImageStreamResolver) Resolve

func (r ImageStreamResolver) Resolve(value string) (*ComponentMatch, error)

type NameSuggester

type NameSuggester interface {
	SuggestName() (string, bool)
}

NameSuggester is an object that can suggest a name for itself

type NameSuggestions

type NameSuggestions []NameSuggester

NameSuggestions suggests names from a collection of NameSuggesters

func (NameSuggestions) SuggestName

func (s NameSuggestions) SuggestName() (string, bool)

SuggestName suggests a name given a collection of NameSuggesters

type Objects

type Objects []runtime.Object

Objects is a set of runtime objects

func AddRoutes added in v0.5.1

func AddRoutes(objects Objects) Objects

AddRoutes sets up routes for the provided objects

func AddServices

func AddServices(objects Objects) Objects

AddServices sets up services for the provided objects

type PerfectMatchWeightedResolver

type PerfectMatchWeightedResolver []WeightedResolver

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). If no perfect matches exist, an ErrMultipleMatches is returned indicating the remaining candidate(s). Note that this method may resolve ErrMultipleMatches with a single match, indicating an error (no perfect match) but with only one candidate.

func (PerfectMatchWeightedResolver) Resolve

Resolve resolves the provided input and returns only exact matches

type Pipeline

type Pipeline struct {
	From string

	InputImage *ImageRef
	Build      *BuildRef
	Image      *ImageRef
	Deployment *DeploymentConfigRef
}

func NewBuildPipeline

func NewBuildPipeline(from string, input *ImageRef, strategy *BuildStrategyRef, source *SourceRef) (*Pipeline, error)

NewBuildPipeline creates a new pipeline with components that are expected to be built

func NewImagePipeline

func NewImagePipeline(from string, image *ImageRef) (*Pipeline, error)

NewImagePipeline creates a new pipeline with components that are not expected to be built

func (*Pipeline) NeedsDeployment

func (p *Pipeline) NeedsDeployment(env Environment, name string) error

NeedsDeployment sets the pipeline for deployment

func (*Pipeline) Objects

func (p *Pipeline) Objects(accept, objectAccept Acceptor) (Objects, error)

Objects converts all the components in the pipeline into runtime objects

type PipelineGroup

type PipelineGroup []*Pipeline

PipelineGroup is a group of Pipelines

func (PipelineGroup) Reduce

func (g PipelineGroup) Reduce() error

Reduce squashes all common components from the pipelines

func (PipelineGroup) String

func (g PipelineGroup) String() string

type ReferenceBuilder

type ReferenceBuilder struct {
	// contains filtered or unexported fields
}

ReferenceBuilder is used for building all the necessary object references for an application

func (*ReferenceBuilder) AddComponents added in v0.4.4

func (r *ReferenceBuilder) AddComponents(inputs []string, fn func(*ComponentInput) ComponentReference)

AddComponents turns all provided component inputs into component references

func (*ReferenceBuilder) AddGroups

func (r *ReferenceBuilder) AddGroups(inputs []string)

AddGroups adds group ids to groups of components

func (*ReferenceBuilder) AddSourceRepository

func (r *ReferenceBuilder) AddSourceRepository(input string) (*SourceRepository, bool)

AddSourceRepository resolves the input to an actual source repository

func (*ReferenceBuilder) Result

Result returns the result of the config conversion to object references

type Resolver

type Resolver interface {
	Resolve(value string) (*ComponentMatch, error)
}

Resolver is an interface for resolving provided input to component matches. A Resolver should return ErrMultipleMatches when more than one result can be constructed as a match. It should also set the score to 0.0 if this is a perfect match, and to higher values the less adequate the match is.

type ScoredComponentMatches

type ScoredComponentMatches []*ComponentMatch

ScoredComponentMatches is a set of component matches grouped by score

func (ScoredComponentMatches) Exact

Exact returns all the exact component matches

func (ScoredComponentMatches) Len

func (m ScoredComponentMatches) Len() int

func (ScoredComponentMatches) Less

func (m ScoredComponentMatches) Less(i, j int) bool

func (ScoredComponentMatches) Swap

func (m ScoredComponentMatches) Swap(i, j int)

type Searcher

type Searcher interface {
	Search(terms []string) ([]*ComponentMatch, error)
}

type SourceLanguageType

type SourceLanguageType struct {
	Platform string
	Version  string
}

SourceLanguageType contains info about the type of the language a source repository is built in

type SourceRef

type SourceRef struct {
	URL        *url.URL
	Ref        string
	Dir        string
	Name       string
	ContextDir string
}

SourceRef is a reference to a build source

func (*SourceRef) BuildSource

func (r *SourceRef) BuildSource() (*buildapi.BuildSource, []buildapi.BuildTriggerPolicy)

BuildSource returns an OpenShift BuildSource from the SourceRef

func (*SourceRef) SuggestName

func (r *SourceRef) SuggestName() (string, bool)

SuggestName returns a name derived from the source URL

type SourceRefGenerator added in v0.5.1

type SourceRefGenerator struct {
	// contains filtered or unexported fields
}

SourceRefGenerator generates new SourceRefs either from a URL or a Directory

Generators for SourceRef - Git URL -> SourceRef - Directory -> SourceRef

func NewSourceRefGenerator added in v0.5.1

func NewSourceRefGenerator() *SourceRefGenerator

NewSourceRefGenerator creates a new SourceRefGenerator

func (*SourceRefGenerator) FromDirectory added in v0.5.1

func (g *SourceRefGenerator) FromDirectory(directory string) (*SourceRef, error)

SourceRefForDirectory creates a SourceRef from a directory that contains a git repository. The URL is obtained from the origin remote branch, and the reference is taken from the currently checked out branch.

func (*SourceRefGenerator) FromGitURL added in v0.5.1

func (g *SourceRefGenerator) FromGitURL(location string) (*SourceRef, error)

SourceRefForGitURL creates a SourceRef from a Git URL. If the URL includes a hash, it is used for the SourceRef's branch reference. Otherwise, 'master' is assumed

type SourceRepository

type SourceRepository struct {
	// contains filtered or unexported fields
}

SourceRepository represents an code repository that may be the target of a build.

func MockSourceRepositories added in v0.5.1

func MockSourceRepositories() []*SourceRepository

MockSourceRepositories is a set of mocked source repositories used for testing

func NewSourceRepository

func NewSourceRepository(s string) (*SourceRepository, error)

NewSourceRepository creates a reference to a local or remote source code repository from a URL or path.

func (*SourceRepository) BuildWithDocker

func (r *SourceRepository) BuildWithDocker()

BuildWithDocker specifies that the source repository was built with Docker

func (*SourceRepository) InUse

func (r *SourceRepository) InUse() bool

InUse checks if the source repository is in use

func (*SourceRepository) IsDockerBuild

func (r *SourceRepository) IsDockerBuild() bool

IsDockerBuild checks if the source repository was built with Docker

func (*SourceRepository) LocalPath

func (r *SourceRepository) LocalPath() (string, error)

LocalPath returns the local path of the source repository

func (*SourceRepository) Remote

func (r *SourceRepository) Remote() bool

Remote checks whether the source repository is remote

func (*SourceRepository) RemoteURL added in v0.4.1

func (r *SourceRepository) RemoteURL() (*url.URL, error)

RemoteURL returns the remote URL of the source repository

func (*SourceRepository) String

func (r *SourceRepository) String() string

func (*SourceRepository) UsedBy

func (r *SourceRepository) UsedBy(ref ComponentReference)

UsedBy sets up which component uses the source repository

type SourceRepositoryEnumerator

type SourceRepositoryEnumerator struct {
	Detectors source.Detectors
	Tester    dockerfile.Tester
}

SourceRepositoryEnumerator implements the Detector interface

func (SourceRepositoryEnumerator) Detect

Detect extracts source code information about the provided source repository

type SourceRepositoryInfo

type SourceRepositoryInfo struct {
	Path       string
	Types      []SourceLanguageType
	Dockerfile dockerfile.Dockerfile
}

SourceRepositoryInfo contains info about a source repository

func (*SourceRepositoryInfo) Terms

func (info *SourceRepositoryInfo) Terms() []string

Terms returns which languages the source repository was built with

type TemplateResolver added in v0.4.4

type TemplateResolver struct {
	Client                    client.TemplatesNamespacer
	TemplateConfigsNamespacer client.TemplateConfigsNamespacer
	Namespaces                []string
}

func (TemplateResolver) Resolve added in v0.4.4

func (r TemplateResolver) Resolve(value string) (*ComponentMatch, error)

type WeightedResolver

type WeightedResolver struct {
	Resolver
	Weight float32
}

WeightedResolver is a resolver identified as exact or not, depending on its weight

type WeightedResolvers

type WeightedResolvers []WeightedResolver

WeightedResolvers is a set of weighted resolvers

func (WeightedResolvers) Resolve

func (r WeightedResolvers) Resolve(value string) (*ComponentMatch, error)

Resolve resolves the provided input and returns both exact and inexact matches

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL