v1alpha1

package
v0.1.2 Latest Latest
Warning

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

 Go to latest Published: Sep 18, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the API. +groupName=build.knative.dev

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: build.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ArgumentSpec 

type ArgumentSpec struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

ArgumentSpec defines the actual values to use to populate a template's parameters.

func (*ArgumentSpec) DeepCopy 

func (in *ArgumentSpec) DeepCopy() *ArgumentSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ArgumentSpec.

func (*ArgumentSpec) DeepCopyInto 

func (in *ArgumentSpec) DeepCopyInto(out *ArgumentSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Build 

type Build struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BuildSpec   `json:"spec"`
	Status BuildStatus `json:"status"`
}

Build represents a build of a container image. A Build is made up of a source, and a set of steps. Steps can mount volumes to share data between themselves. A build may be created by instantiating a BuildTemplate.

func (*Build) DeepCopy 

func (in *Build) DeepCopy() *Build

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Build.

func (*Build) DeepCopyInto 

func (in *Build) DeepCopyInto(out *Build)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Build) DeepCopyObject 

func (in *Build) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*Build) GetGeneration 

func (b *Build) GetGeneration() int64

func (*Build) GetSpecJSON 

func (b *Build) GetSpecJSON() ([]byte, error)

func (*Build) SetGeneration 

func (b *Build) SetGeneration(generation int64)

type BuildCondition 

type BuildCondition struct {
	Type BuildConditionType `json:"state"`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

BuildCondition defines a readiness condition for a Build. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties

func (*BuildCondition) DeepCopy 

func (in *BuildCondition) DeepCopy() *BuildCondition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildCondition.

func (*BuildCondition) DeepCopyInto 

func (in *BuildCondition) DeepCopyInto(out *BuildCondition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BuildConditionType 

type BuildConditionType string
const (
	// BuildSucceeded is set when the build is running, and becomes True
	// when the build finishes successfully.
	//
	// If the build is ongoing, its status will be Unknown. If it fails,
	// its status will be False.
	BuildSucceeded BuildConditionType = "Succeeded"
)

type BuildList 

type BuildList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Build `json:"items"`
}

BuildList is a list of Build resources

func (*BuildList) DeepCopy 

func (in *BuildList) DeepCopy() *BuildList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildList.

func (*BuildList) DeepCopyInto 

func (in *BuildList) DeepCopyInto(out *BuildList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BuildList) DeepCopyObject 

func (in *BuildList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BuildProvider 

type BuildProvider string
const (
	// GoogleBuildProvider indicates that this build was performed with Google Container Builder.
	GoogleBuildProvider BuildProvider = "Google"
	// ClusterBuildProvider indicates that this build was performed on-cluster.
	ClusterBuildProvider BuildProvider = "Cluster"
)

type BuildSpec 

type BuildSpec struct {
	// TODO: Generation does not work correctly with CRD. They are scrubbed
	// by the APIserver (https://github.com/kubernetes/kubernetes/issues/58778)
	// So, we add Generation here. Once that gets fixed, remove this and use
	// ObjectMeta.Generation instead.
	// +optional
	Generation int64 `json:"generation,omitempty"`

	// Source specifies the input to the build.
	Source *SourceSpec `json:"source,omitempty"`

	// Steps are the steps of the build; each step is run sequentially with the
	// source mounted into /workspace.
	Steps []corev1.Container `json:"steps,omitempty"`

	// Volumes is a collection of volumes that are available to mount into the
	// steps of the build.
	Volumes []corev1.Volume `json:"volumes,omitempty"`

	// The name of the service account as which to run this build.
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// Template, if specified, references a BuildTemplate resource to use to
	// populate fields in the build, and optional Arguments to pass to the
	// template.
	Template *TemplateInstantiationSpec `json:"template,omitempty"`
}

BuildSpec is the spec for a Build resource.

func (*BuildSpec) DeepCopy 

func (in *BuildSpec) DeepCopy() *BuildSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildSpec.

func (*BuildSpec) DeepCopyInto 

func (in *BuildSpec) DeepCopyInto(out *BuildSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BuildStatus 

type BuildStatus struct {
	Builder BuildProvider `json:"builder,omitempty"`

	// Additional information based on the Builder executing this build.
	Cluster *ClusterSpec `json:"cluster,omitempty"`
	Google  *GoogleSpec  `json:"google,omitempty"`

	// Information about the execution of the build.
	StartTime      metav1.Time `json:"startTime,omitEmpty"`
	CompletionTime metav1.Time `json:"completionTime,omitEmpty"`

	// Parallel list to spec.Containers
	StepStates []corev1.ContainerState `json:"stepStates,omitEmpty"`
	Conditions []BuildCondition        `json:"conditions,omitempty"`
}

BuildStatus is the status for a Build resource

func (*BuildStatus) DeepCopy 

func (in *BuildStatus) DeepCopy() *BuildStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildStatus.

func (*BuildStatus) DeepCopyInto 

func (in *BuildStatus) DeepCopyInto(out *BuildStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BuildStatus) GetCondition 

func (bs *BuildStatus) GetCondition(t BuildConditionType) *BuildCondition

func (*BuildStatus) RemoveCondition 

func (b *BuildStatus) RemoveCondition(t BuildConditionType)

func (*BuildStatus) SetCondition 

func (b *BuildStatus) SetCondition(newCond *BuildCondition)

type BuildTemplate 

type BuildTemplate struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec BuildTemplateSpec `json:"spec"`
}

BuildTemplate is a template that can used to easily create Builds.

func (*BuildTemplate) DeepCopy 

func (in *BuildTemplate) DeepCopy() *BuildTemplate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildTemplate.

func (*BuildTemplate) DeepCopyInto 

func (in *BuildTemplate) DeepCopyInto(out *BuildTemplate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BuildTemplate) DeepCopyObject 

func (in *BuildTemplate) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

func (*BuildTemplate) GetGeneration 

func (bt *BuildTemplate) GetGeneration() int64

func (*BuildTemplate) GetSpecJSON 

func (bt *BuildTemplate) GetSpecJSON() ([]byte, error)

func (*BuildTemplate) SetGeneration 

func (bt *BuildTemplate) SetGeneration(generation int64)

type BuildTemplateList 

type BuildTemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []BuildTemplate `json:"items"`
}

BuildTemplateList is a list of BuildTemplate resources.

func (*BuildTemplateList) DeepCopy 

func (in *BuildTemplateList) DeepCopy() *BuildTemplateList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildTemplateList.

func (*BuildTemplateList) DeepCopyInto 

func (in *BuildTemplateList) DeepCopyInto(out *BuildTemplateList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BuildTemplateList) DeepCopyObject 

func (in *BuildTemplateList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BuildTemplateSpec 

type BuildTemplateSpec struct {
	// TODO: Generation does not work correctly with CRD. They are scrubbed
	// by the APIserver (https://github.com/kubernetes/kubernetes/issues/58778)
	// So, we add Generation here. Once that gets fixed, remove this and use
	// ObjectMeta.Generation instead.
	// +optional
	Generation int64 `json:"generation,omitempty"`

	// Parameters defines the parameters that can be populated in a template.
	Parameters []ParameterSpec `json:"parameters,omitempty"`

	// Steps are the steps of the build; each step is run sequentially with the
	// source mounted into /workspace.
	Steps []corev1.Container `json:"steps"`

	// Volumes is a collection of volumes that are available to mount into the
	// steps of the build.
	Volumes []corev1.Volume `json:"volumes"`
}

BuildTemplateSpec is the spec for a BuildTemplate.

func (*BuildTemplateSpec) DeepCopy 

func (in *BuildTemplateSpec) DeepCopy() *BuildTemplateSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuildTemplateSpec.

func (*BuildTemplateSpec) DeepCopyInto 

func (in *BuildTemplateSpec) DeepCopyInto(out *BuildTemplateSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ClusterSpec 

type ClusterSpec struct {
	Namespace string `json:"namespace"`
	PodName   string `json:"podName"`
}

func (*ClusterSpec) DeepCopy 

func (in *ClusterSpec) DeepCopy() *ClusterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ClusterSpec.

func (*ClusterSpec) DeepCopyInto 

func (in *ClusterSpec) DeepCopyInto(out *ClusterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCSSourceSpec 

type GCSSourceSpec struct {
	Type     GCSSourceType `json:"type,omitempty"`
	Location string        `json:"location,omitempty"`
}

GCSSourceSpec describes source input to the Build in the form of an archive, or a source manifest describing files to fetch.

func (*GCSSourceSpec) DeepCopy 

func (in *GCSSourceSpec) DeepCopy() *GCSSourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GCSSourceSpec.

func (*GCSSourceSpec) DeepCopyInto 

func (in *GCSSourceSpec) DeepCopyInto(out *GCSSourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GCSSourceType 

type GCSSourceType string
const (
	GCSArchive  GCSSourceType = "Archive"
	GCSManifest GCSSourceType = "Manifest"
)

type GitSourceSpec 

type GitSourceSpec struct {
	// URL of the Git repository to clone from.
	Url string `json:"url"`

	// Git revision (branch, tag, commit SHA or ref) to clone.  See
	// https://git-scm.com/docs/gitrevisions#_specifying_revisions for more
	// information.
	Revision string `json:"revision"`
}

GitSourceSpec describes a Git repo source input to the Build.

func (*GitSourceSpec) DeepCopy 

func (in *GitSourceSpec) DeepCopy() *GitSourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GitSourceSpec.

func (*GitSourceSpec) DeepCopyInto 

func (in *GitSourceSpec) DeepCopyInto(out *GitSourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GoogleSpec 

type GoogleSpec struct {
	Operation string `json:"operation"`
}

func (*GoogleSpec) DeepCopy 

func (in *GoogleSpec) DeepCopy() *GoogleSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GoogleSpec.

func (*GoogleSpec) DeepCopyInto 

func (in *GoogleSpec) DeepCopyInto(out *GoogleSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ParameterSpec 

type ParameterSpec struct {
	// Name is the unique name of this template parameter.
	Name string `json:"name"`

	// Description is a human-readable explanation of this template parameter.
	Description string `json:"description,omitempty"`

	// Default, if specified, defines the default value that should be applied if
	// the build does not specify the value for this parameter.
	Default *string `json:"default,omitempty"`
}

ParameterSpec defines the possible parameters that can be populated in a template.

func (*ParameterSpec) DeepCopy 

func (in *ParameterSpec) DeepCopy() *ParameterSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ParameterSpec.

func (*ParameterSpec) DeepCopyInto 

func (in *ParameterSpec) DeepCopyInto(out *ParameterSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SourceSpec 

type SourceSpec struct {
	Git    *GitSourceSpec    `json:"git,omitempty"`
	GCS    *GCSSourceSpec    `json:"gcs,omitempty"`
	Custom *corev1.Container `json:"custom,omitempty"`
}

SourceSpec defines the input to the Build

func (*SourceSpec) DeepCopy 

func (in *SourceSpec) DeepCopy() *SourceSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceSpec.

func (*SourceSpec) DeepCopyInto 

func (in *SourceSpec) DeepCopyInto(out *SourceSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TemplateInstantiationSpec 

type TemplateInstantiationSpec struct {
	// Name references the BuildTemplate resource to use.
	//
	// The template is assumed to exist in the Build's namespace.
	Name string `json:"name"`

	// Arguments, if specified, lists values that should be applied to the
	// parameters specified by the template.
	Arguments []ArgumentSpec `json:"arguments,omitempty"`

	// Env, if specified will provide variables to all build template steps.
	// This will override any of the template's steps environment variables.
	Env []corev1.EnvVar `json:"env,omitempty"`
}

TemplateInstantiationSpec specifies how a BuildTemplate is instantiated into a Build.

func (*TemplateInstantiationSpec) DeepCopy 

func (in *TemplateInstantiationSpec) DeepCopy() *TemplateInstantiationSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TemplateInstantiationSpec.

func (*TemplateInstantiationSpec) DeepCopyInto 

func (in *TemplateInstantiationSpec) DeepCopyInto(out *TemplateInstantiationSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.