api

package
v0.0.0-...-8452b8d Latest Latest
Warning

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

Go to latest
Published: Sep 24, 2014 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Build

type Build struct {
	api.JSONBase `json:",inline" yaml:",inline"`
	Labels       map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`

	// Input is the set of inputs used to configure the build
	Input BuildInput `json:"input,omitempty" yaml:"input,omitempty"`

	// Status is the current status of the build
	Status BuildStatus `json:"status,omitempty" yaml:"status,omitempty"`

	// PodID is the id of the pod that is used to execute the build
	PodID string `json:"podID,omitempty" yaml:"podID,omitempty"`
}

Build encapsulates the inputs needed to produce a new deployable image, as well as the status of the operation and a reference to the Pod which runs the build.

func (*Build) IsAnAPIObject

func (*Build) IsAnAPIObject()

type BuildConfig

type BuildConfig struct {
	api.JSONBase `json:",inline" yaml:",inline"`
	Labels       map[string]string `json:"labels,omitempty" yaml:"labels,omitempty"`

	// DesiredInput is the input used to create builds from this configuration
	DesiredInput BuildInput `json:"desiredInput,omitempty" yaml:"desiredInput,omitempty"`

	// Secret used to validate requests.
	Secret string `json:"secret,omitempty" yaml:"secret,omitempty"`
}

BuildConfig contains the inputs needed to produce a new deployable image

func (*BuildConfig) IsAnAPIObject

func (*BuildConfig) IsAnAPIObject()

type BuildConfigList

type BuildConfigList struct {
	api.JSONBase `json:",inline" yaml:",inline"`
	Items        []BuildConfig `json:"items,omitempty" yaml:"items,omitempty"`
}

BuildConfigList is a collection of BuildConfigs.

func (*BuildConfigList) IsAnAPIObject

func (*BuildConfigList) IsAnAPIObject()

type BuildInput

type BuildInput struct {
	// Type is the type of build to execute
	Type BuildType `json:"type,omitempty" yaml:"type,omitempty"`

	// SourceURI points to the source that will be built. The structure of the source
	// will depend on the type of build to run
	SourceURI string `json:"sourceURI,omitempty" yaml:"sourceURI,omitempty"`

	// SourceRef is the branch/tag/ref to build.
	SourceRef string `json:"sourceRef,omitempty" yaml:"sourceRef,omitempty"`

	// ImageTag is the tag to give to the image resulting from the build
	ImageTag string `json:"imageTag,omitempty" yaml:"imageTag,omitempty"`

	// BuilderImage is the image used to execute the build when running STI builds
	BuilderImage string `json:"builderImage,omitempty" yaml:"builderImage,omitempty"`
}

BuildInput defines the type of build and input parameters for a given build

type BuildList

type BuildList struct {
	api.JSONBase `json:",inline" yaml:",inline"`
	Items        []Build `json:"items,omitempty" yaml:"items,omitempty"`
}

BuildList is a collection of Builds.

func (*BuildList) IsAnAPIObject

func (*BuildList) IsAnAPIObject()

type BuildStatus

type BuildStatus string

BuildStatus represents the status of a Build at a point in time.

const (
	// BuildNew is automatically assigned to a newly created build
	BuildNew BuildStatus = "new"

	// BuildPending indicates that a pod name has been assigned and a build is
	// about to start running
	BuildPending BuildStatus = "pending"

	// BuildRunning indicates that a pod has been created and a build is running
	BuildRunning BuildStatus = "running"

	// BuildComplete indicates that a build has been successful
	BuildComplete BuildStatus = "complete"

	// BuildFailed indicates that a build has executed and failed
	BuildFailed BuildStatus = "failed"

	// BuildError indicates that an error prevented the build from
	// executing
	BuildError BuildStatus = "error"
)

Valid build status values

type BuildType

type BuildType string

BuildType is a type of build (docker, sti, etc)

const (
	// DockerBuildType is a build based on a Dockerfile with associated artifacts
	DockerBuildType BuildType = "docker"

	// STIBuildType is a build using Source to Image using a git repository
	// and a builder image
	STIBuildType BuildType = "sti"
)

Valid build types

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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