v1alpha1

package
v0.0.0-...-9c81b8b Latest Latest
Warning

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

 Go to latest Published: Aug 11, 2019 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Package v1alpha1 is the v1alpha1 version of the flow API. +groupName=flow.oooops.com

Index

Constants

View Source 
const (
	// LabelStage used to defines stage of flow
	LabelStage = "alpha.oooops.com/stage"

	// LabelFlowHash used to defines flow definitions
	LabelFlowHash = "alpha.oooops.com/hash"
)
View Source 
const (
	// StageSCM defines internal stage to fetch codes
	StageSCM = "scm"

	// StageImage defines internal stage to build and push image
	StageImage = "image"

	// StageDeploy defines internal stage to deploy application
	StageDeploy = "deploy"
)
View Source 
const GroupName = "flow.oooops.com"

GroupName specifies the group name used to register the objects.

Variables

View Source 
var (
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	// Depreciated: use Install instead
	AddToScheme = localSchemeBuilder.AddToScheme
	Install     = localSchemeBuilder.AddToScheme
)
View Source 
var GroupVersion = v1.GroupVersion{Group: GroupName, Version: "v1alpha1"}

GroupVersion specifies the group and the version used to register the objects.

View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects Deprecated: use GroupVersion instead.

Functions

func RegisterDefaults 

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type CodeSource 

type CodeSource struct {
	// Name defines name of the code source
	Name string `json:"name"`
	// Git defines git source
	Git GitSource `json:"git,omitempty"`
}

CodeSource defines source of code, e.g. github

func (*CodeSource) DeepCopy 

func (in *CodeSource) DeepCopy() *CodeSource

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

func (*CodeSource) DeepCopyInto 

func (in *CodeSource) DeepCopyInto(out *CodeSource)

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

type Destination 

type Destination struct {
	// Path defines dir which contains deploy yaml templates
	Path string `json:"path"`
}

Destination defines config TODO(liubog2008): add different config

func (*Destination) DeepCopy 

func (in *Destination) DeepCopy() *Destination

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

func (*Destination) DeepCopyInto 

func (in *Destination) DeepCopyInto(out *Destination)

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

type Flow 

type Flow struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec defines the desired identities of CI/CD flow
	// +optional
	Spec FlowSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	// Status defines the current status of CI/CD flow
	// +optional
	Status FlowStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=spec"`
}

Flow defines a CI/CD flow

func (*Flow) DeepCopy 

func (in *Flow) DeepCopy() *Flow

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

func (*Flow) DeepCopyInto 

func (in *Flow) DeepCopyInto(out *Flow)

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

func (*Flow) DeepCopyObject 

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

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

type FlowCondition 

type FlowCondition struct {
	// Type of flow condition, Complete or Failed.
	Type FlowConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=FlowConditionType"`
	// Status of the condition, one of True, False, Unknown.
	Status v1.ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=k8s.io/api/core/v1.ConditionStatus"`
	// Last time the condition was checked.
	// +optional
	LastProbeTime metav1.Time `json:"lastProbeTime,omitempty" protobuf:"bytes,3,opt,name=lastProbeTime"`
	// Last time the condition transit from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,4,opt,name=lastTransitionTime"`
	// (brief) reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`
	// Human readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,6,opt,name=message"`
}

FlowCondition describes current state of a flow.

func (*FlowCondition) DeepCopy 

func (in *FlowCondition) DeepCopy() *FlowCondition

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

func (*FlowCondition) DeepCopyInto 

func (in *FlowCondition) DeepCopyInto(out *FlowCondition)

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

type FlowConditionType 

type FlowConditionType string

FlowConditionType defines condition type of flow 

const (
	// FlowComplete means the flow has completed its execution.
	FlowComplete FlowConditionType = "Complete"
	// FlowFailed means the flow has failed its execution.
	FlowFailed FlowConditionType = "Failed"
	// FlowWaiting means the flow is waiting for next trigger
	FlowWaiting FlowConditionType = "Waiting"
)

These are valid conditions of a flow

type FlowList 

type FlowList struct {
	metav1.TypeMeta `json:",inline"`
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items defines an array of flow
	Items []Flow `json:"items" protobuf:"bytes,2,rep,name=items"`
}

FlowList defines list of flow

func (*FlowList) DeepCopy 

func (in *FlowList) DeepCopy() *FlowList

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

func (*FlowList) DeepCopyInto 

func (in *FlowList) DeepCopyInto(out *FlowList)

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

func (*FlowList) DeepCopyObject 

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

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

type FlowSpec 

type FlowSpec struct {
	// Selector defines label selector for pod
	Selector *metav1.LabelSelector

	// Sources defines code source
	Sources []CodeSource `json:"sources"`

	// Images defines container images' config
	Images []Image `json:"images"`

	// Destination defines deploy config
	Destination Destination `json:"destination"`

	// Stage defines flow flow stage
	Stages []Stage `json:"stages"`

	// VolumeClaimTemplate defines whether
	VolumeClaimTemplate v1.PersistentVolumeClaim `json:"volumeClaimTemplate"`
}

FlowSpec defines spec of CI/CD flow

func (*FlowSpec) DeepCopy 

func (in *FlowSpec) DeepCopy() *FlowSpec

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

func (*FlowSpec) DeepCopyInto 

func (in *FlowSpec) DeepCopyInto(out *FlowSpec)

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

type FlowStatus 

type FlowStatus struct {
	// Phase used to mark a simple phase of flow
	Phase string `json:"phase"`

	// Stage defines current stage of flow
	Stage string `json:"stage"`

	// Conditions defines flow conditions
	Conditions []FlowCondition `json:"conditions"`
}

FlowStatus defines status of CI/CD flow

func (*FlowStatus) DeepCopy 

func (in *FlowStatus) DeepCopy() *FlowStatus

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

func (*FlowStatus) DeepCopyInto 

func (in *FlowStatus) DeepCopyInto(out *FlowStatus)

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

type GitSource 

type GitSource struct {
	// Repository defines github repo
	Repository string `json:"repository"`

	// Type defines git source from
	// e.g. branch, pr, release, revision
	Type GitSourceType `json:"type"`

	// Matches defines matcher of git source
	// Now only support equals
	// If matcher is empty, branch will be master,
	// pr and release will be the lastest
	// TODO(liubog2008): support regexp matcher
	Matches string `json:"matches"`
}

GitSource is a config of git

func (*GitSource) DeepCopy 

func (in *GitSource) DeepCopy() *GitSource

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

func (*GitSource) DeepCopyInto 

func (in *GitSource) DeepCopyInto(out *GitSource)

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

type GitSourceType 

type GitSourceType string

GitSourceType defines type of git source 

const (
	// GitBranch defines git source from specified branch
	// Default branch is master
	GitBranch GitSourceType = "Branch"
	// GitPullRequest defines git source from a pull request
	// Default is the latest pull request
	GitPullRequest GitSourceType = "PullRequest"
	// GitRelease defines git source from a release tag
	// TODO(liubog2008): default should use latest release
	GitRelease GitSourceType = "Release"
	// GitRevision defines git source from a specified revision
	// Default is the latest commit of master branch
	GitRevision GitSourceType = "Revision"
)

type Image 

type Image struct {
	// Name defines name of the image
	// Name can be referred by deploy template
	Name string `json:"name"`
	// Repository defines image repository
	Repository string `json:"repository"`
	// Path defines the path of image config
	// e.g. Dockerfile
	// TODO(liubog2008): support relative path of code source
	Path string `json:"path"`

	// WorkDir defines work dir to build image
	WorkDir string `json:"workDir"`
}

Image defines container image config

func (*Image) DeepCopy 

func (in *Image) DeepCopy() *Image

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

func (*Image) DeepCopyInto 

func (in *Image) DeepCopyInto(out *Image)

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

type Stage 

type Stage struct {
	// Name defines name of enviroment
	Name string `json:"name"`
	// When defines when to run the stage
	When When `json:"when"`
	// TemplateName defines pod template of enviroment
	TemplateName string `json:"template"`
	// Commands defines commands
	Commands []string `json:"commands"`
}

Stage defines CI/CD stage config

func (*Stage) DeepCopy 

func (in *Stage) DeepCopy() *Stage

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

func (*Stage) DeepCopyInto 

func (in *Stage) DeepCopyInto(out *Stage)

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

type When 

type When string

When defines when to run the stage 

const (
	// WhenCodeReady defines time point after code is ready
	WhenCodeReady When = "CodeReady"
	// WhenImageReady defines time point after iamge is ready
	WhenImageReady When = "ImageReady"
	// WhenApplicationReady defines time point after application is ready
	WhenApplicationReady When = "ApplicationReady"
)

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.