Documentation ¶
Overview ¶
+k8s:deepcopy-gen=package +groupName=overseer.quanxiang.cloud.io
Package v1alpha1 contains API Schema definitions for the overseer v1alpha1 API group +kubebuilder:object:generate=true +groupName=overseer.quanxiang.cloud.io
Index ¶
- Constants
- Variables
- func Resource(resource string) schema.GroupResource
- type Builder
- type BuilderEngine
- type BuilderList
- type BuilderSpec
- type BuilderStatus
- type Condition
- type Conditions
- type Git
- type Image
- type Knative
- type Overseer
- type OverseerList
- type OverseerSpec
- type OverseerStatus
- type Param
- type Phase
- type PipelineRunSpec
- type Serve
- type Service
- type Serving
- type ServingList
- type ServingSpec
- type ServingStatus
- type Shipwright
- type ShipwrightStrategy
- type Stage
- type Type
- type Versatile
- type VersatileStatus
- type Workspace
Constants ¶
const (
// Cancel specifies that the resource has cancel.
Cancel = "Cancel"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "overseer.uanxiang.cloud.io", Version: "v1alpha1"} // SchemeGroupVersion is group version used to register these objects // added for generated clientset SchemeGroupVersion = GroupVersion // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &schemeBuilder // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( // NonePhase none phase NonePhase = Phase{} // DonePhase done phase DonePhase = Phase{ Stage: DoneStage, } )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
Types ¶
type Builder ¶
type Builder struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec BuilderSpec `json:"spec,omitempty"` Status BuilderStatus `json:"status,omitempty"` }
Builder is the Schema for the builders API
func (*Builder) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Builder.
func (*Builder) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Builder) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Builder) GetCondition ¶
type BuilderEngine ¶
type BuilderEngine struct {
Shipwright *Shipwright `json:"shipwright,omitempty"`
}
BuilderEngine various builder collections.
func (*BuilderEngine) DeepCopy ¶
func (in *BuilderEngine) DeepCopy() *BuilderEngine
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuilderEngine.
func (*BuilderEngine) DeepCopyInto ¶
func (in *BuilderEngine) DeepCopyInto(out *BuilderEngine)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BuilderList ¶
type BuilderList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Builder `json:"items"` }
BuilderList contains a list of Builder
func (*BuilderList) DeepCopy ¶
func (in *BuilderList) DeepCopy() *BuilderList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuilderList.
func (*BuilderList) DeepCopyInto ¶
func (in *BuilderList) DeepCopyInto(out *BuilderList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BuilderList) DeepCopyObject ¶
func (in *BuilderList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type BuilderSpec ¶
type BuilderSpec struct { // ServiceAccountName ServiceAccountName *string `json:"serviceAccountName,omitempty"` // Git Git Git `json:"git,omitempty"` // Image Image Image `json:"image,omitempty"` // Param Params []Param `json:"params,omitempty"` // BuilderEngine BuilderEngine `json:",omitempty"` }
BuilderSpec defines the desired state of Builder
func (*BuilderSpec) DeepCopy ¶
func (in *BuilderSpec) DeepCopy() *BuilderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuilderSpec.
func (*BuilderSpec) DeepCopyInto ¶
func (in *BuilderSpec) DeepCopyInto(out *BuilderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BuilderStatus ¶
type BuilderStatus struct { // Ref the name of builder. Ref string `json:"ref,omitempty"` // StartTime is the time the task is actually started. // +optional StartTime metav1.Time `json:"startTime,omitempty"` // CompletionTime is the time the task completed. // +optional CompletionTime metav1.Time `json:"completionTime,omitempty"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` // Conditions the latest available observations of a resource's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` }
BuilderStatus defines the observed state of Builder
func (*BuilderStatus) DeepCopy ¶
func (in *BuilderStatus) DeepCopy() *BuilderStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BuilderStatus.
func (*BuilderStatus) DeepCopyInto ¶
func (in *BuilderStatus) DeepCopyInto(out *BuilderStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BuilderStatus) IsKnown ¶
func (b *BuilderStatus) IsKnown() bool
type Condition ¶
type Condition struct { // Type of condition // +required Type Type `json:"type" description:"type of status condition"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` // LastTransitionTime is the last time the condition transitioned from one status to another. // We use VolatileTime in place of metav1.Time to exclude this from creating equality.Semantic // differences (all other things held constant). // +optional LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" description:"last time the condition transit from one status to another"` // The reason for the condition's last transition. // +optional Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"` // A human readable message indicating details about the transition. // +optional Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"` }
Condition defines a readiness condition. +k8s:deepcopy-gen=true
func (*Condition) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Condition.
func (*Condition) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Conditions ¶
type Conditions []Condition
Conditions condition set
func (Conditions) DeepCopy ¶
func (in Conditions) DeepCopy() Conditions
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Conditions.
func (Conditions) DeepCopyInto ¶
func (in Conditions) DeepCopyInto(out *Conditions)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Git ¶
type Git struct { // Repository URL to clone from. Url string `json:"url,omitempty"` // Revision to checkout. (branch, tag, sha, ref, etc...) // +optional Revision *string `json:"revision,omitempty"` // Subpath A subpath within checked out source // where the source to build is located. // +optional Subpath *string `json:"subpath,omitempty"` // Credentials // +optional Credentials *corev1.LocalObjectReference `json:"credentials,omitempty"` }
Git refers to the Git repository.
func (*Git) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Git.
func (*Git) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Image ¶
type Image struct { // Docker image name. // +require Image string `json:"image"` // Credentials // +optional Credentials *corev1.LocalObjectReference `json:"credentials,omitempty"` }
Image refers to the docker registry.
func (*Image) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Image.
func (*Image) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Knative ¶
type Knative struct { }
func (*Knative) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Knative.
func (*Knative) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Overseer ¶
type Overseer struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec OverseerSpec `json:"spec,omitempty"` Status OverseerStatus `json:"status,omitempty"` }
Overseer is the Schema for the overseers API
func (*Overseer) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Overseer.
func (*Overseer) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Overseer) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Overseer) GetVersatile ¶
func (*Overseer) ShoudContinue ¶
ShoudContinue return to true if the current task is not completed, or there are still unexecuted tasks.
type OverseerList ¶
type OverseerList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Overseer `json:"items"` }
OverseerList contains a list of Overseer
func (*OverseerList) DeepCopy ¶
func (in *OverseerList) DeepCopy() *OverseerList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OverseerList.
func (*OverseerList) DeepCopyInto ¶
func (in *OverseerList) DeepCopyInto(out *OverseerList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OverseerList) DeepCopyObject ¶
func (in *OverseerList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type OverseerSpec ¶
type OverseerSpec struct { // ServiceAccountName If the deep CRD does not set serviceAccountName, // it will inherit from here. // +optional ServiceAccountName string `json:"serviceAccountName,omitempty"` Versatile []Versatile `json:"versatile,omitempty"` // More info: https://kubernetes.io/docs/concepts/storage/volumes // +optional // +patchMergeKey=name // +patchStrategy=merge,retainKeys Volumes []corev1.Volume `json:"volumes,omitempty" patchStrategy:"merge,retainKeys" patchMergeKey:"name" protobuf:"bytes,1,rep,name=volumes"` }
OverseerSpec defines the desired state of Overseer
func (*OverseerSpec) DeepCopy ¶
func (in *OverseerSpec) DeepCopy() *OverseerSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OverseerSpec.
func (*OverseerSpec) DeepCopyInto ¶
func (in *OverseerSpec) DeepCopyInto(out *OverseerSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type OverseerStatus ¶
type OverseerStatus struct { Phase Phase `json:"phase,omitempty"` // StartTime is the time the task is actually started. // +optional StartTime metav1.Time `json:"startTime,omitempty"` // CompletionTime is the time the task completed. // +optional CompletionTime metav1.Time `json:"completionTime,omitempty"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` // +optional VersatileStatus []VersatileStatus `json:"versatileStatus,omitempty"` }
OverseerStatus defines the observed state of Overseer
func (*OverseerStatus) DeepCopy ¶
func (in *OverseerStatus) DeepCopy() *OverseerStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new OverseerStatus.
func (*OverseerStatus) DeepCopyInto ¶
func (in *OverseerStatus) DeepCopyInto(out *OverseerStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*OverseerStatus) IsUnkonwn ¶
func (o *OverseerStatus) IsUnkonwn() bool
func (*OverseerStatus) SetFalse ¶
func (o *OverseerStatus) SetFalse()
SetFalse If any one task fails, the overall failure. this overseer will failure and stop.
func (*OverseerStatus) SetVersatileStatus ¶
func (o *OverseerStatus) SetVersatileStatus(vs VersatileStatus)
type Param ¶
Param is a key/value that populates a strategy parameter
func (*Param) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Param.
func (*Param) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Phase ¶
Phase record the task being performed
func (*Phase) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Phase.
func (*Phase) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type PipelineRunSpec ¶
type PipelineRunSpec struct { PipelineRef string `json:"pipelineRef,omitempty"` Params []Param `json:"params,omitempty"` Workspace []Workspace `json:"workspace,omitempty"` Template *corev1.PodSpec `json:"template,omitempty"` }
func (*PipelineRunSpec) DeepCopy ¶
func (in *PipelineRunSpec) DeepCopy() *PipelineRunSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PipelineRunSpec.
func (*PipelineRunSpec) DeepCopyInto ¶
func (in *PipelineRunSpec) DeepCopyInto(out *PipelineRunSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Serve ¶
type Serve struct { // Knative // +optional Knative *Knative `json:"knative,omitempty"` // Service // +optional Service *Service `json:"service,omitempty"` }
func (*Serve) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Serve.
func (*Serve) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Service ¶
type Service struct {
Ports []corev1.ServicePort `json:"ports,omitempty"`
}
func (*Service) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Service.
func (*Service) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Serving ¶
type Serving struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ServingSpec `json:"spec,omitempty"` Status ServingStatus `json:"status,omitempty"` }
Serving is the Schema for the servings API
func (*Serving) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Serving.
func (*Serving) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Serving) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Serving) GetCondition ¶
type ServingList ¶
type ServingList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Serving `json:"items"` }
ServingList contains a list of Serving
func (*ServingList) DeepCopy ¶
func (in *ServingList) DeepCopy() *ServingList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServingList.
func (*ServingList) DeepCopyInto ¶
func (in *ServingList) DeepCopyInto(out *ServingList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ServingList) DeepCopyObject ¶
func (in *ServingList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ServingSpec ¶
type ServingSpec struct { // INSERT ADDITIONAL SPEC FIELDS - desired state of cluster // Important: Run "make" to regenerate code after modifying this file Name string `json:"name,omitempty"` // ServiceAccountName ServiceAccountName *string `json:"serviceAccountName,omitempty"` // Serve Serve Serve `json:",inline"` Template *corev1.PodSpec `json:"template,omitempty"` }
ServingSpec defines the desired state of Serving
func (*ServingSpec) DeepCopy ¶
func (in *ServingSpec) DeepCopy() *ServingSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServingSpec.
func (*ServingSpec) DeepCopyInto ¶
func (in *ServingSpec) DeepCopyInto(out *ServingSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ServingStatus ¶
type ServingStatus struct { Ref string `json:"ref,omitempty"` // StartTime is the time the task is actually started. // +optional StartTime metav1.Time `json:"startTime,omitempty"` // CompletionTime is the time the task completed. // +optional CompletionTime metav1.Time `json:"completionTime,omitempty"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` // Conditions the latest available observations of a resource's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` }
ServingStatus defines the observed state of Serving
func (*ServingStatus) DeepCopy ¶
func (in *ServingStatus) DeepCopy() *ServingStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServingStatus.
func (*ServingStatus) DeepCopyInto ¶
func (in *ServingStatus) DeepCopyInto(out *ServingStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ServingStatus) IsKnown ¶
func (s *ServingStatus) IsKnown() bool
type Shipwright ¶
type Shipwright struct { // Strategy references the BuildStrategy to use to build the container image. Strategy ShipwrightStrategy `json:"strategy,omitempty"` }
Shipwright more info https://github.com/shipwright-io/build
func (*Shipwright) DeepCopy ¶
func (in *Shipwright) DeepCopy() *Shipwright
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Shipwright.
func (*Shipwright) DeepCopyInto ¶
func (in *Shipwright) DeepCopyInto(out *Shipwright)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ShipwrightStrategy ¶
type ShipwrightStrategy struct { // Name of the referent; More info: http://kubernetes.io/docs/user-guide/identifiers#names Name string `json:"name"` // BuildStrategyKind indicates the kind of the buildstrategy, namespaced or cluster scoped. Kind string `json:"kind,omitempty"` }
ShipwrightStrategy can be used to refer to a specific instance of a buildstrategy.
func (*ShipwrightStrategy) DeepCopy ¶
func (in *ShipwrightStrategy) DeepCopy() *ShipwrightStrategy
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ShipwrightStrategy.
func (*ShipwrightStrategy) DeepCopyInto ¶
func (in *ShipwrightStrategy) DeepCopyInto(out *ShipwrightStrategy)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Stage ¶
type Stage string
Stage the task it is performing
const ( // NoneStage init stage NoneStage Stage = "" // DoneState done State DoneStage Stage = "Done" // PipelineRunStage PipelineRun stage PipelineRunStage Stage = "pipelineRun" // BuilderStage builder state BuilderStage Stage = "builder" // ServingStage serving stage ServingStage Stage = "serving" )
When multiple phases exist at the same time, first pipelineRun stage,then build stage,last serving stage
type Type ¶
type Type string
Type used for defining the conditiont Type field flavour
const ( // Succeeded specifies that the resource has finished. // For resources that run to completion. Succeeded Type = "Succeeded" )
type Versatile ¶
type Versatile struct { // Name If the name is empty, will get oveseer name. // +optional Name string `json:"name,omitempty"` // PipelineRun Relying on tekton's pipeline to complete various tasks // +optional PipelineRun *PipelineRunSpec `json:"pipelineRun,omitempty"` Builder *BuilderSpec `json:"builder,omitempty"` Serving *ServingSpec `json:"serving,omitempty"` }
func (*Versatile) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Versatile.
func (*Versatile) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type VersatileStatus ¶
type VersatileStatus struct { // Ref the name of the related task. // +require Ref string `json:"ref,omitempty"` // StartTime is the time the task is actually started. // +optional StartTime metav1.Time `json:"startTime,omitempty"` // Conditions the latest available observations of a resource's current state. // +optional // +patchMergeKey=type // +patchStrategy=merge Conditions Conditions `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type"` // Status of the condition, one of True, False, Unknown. // +required Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"` }
VersatileStatus holds the versatile status
func (*VersatileStatus) DeepCopy ¶
func (in *VersatileStatus) DeepCopy() *VersatileStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new VersatileStatus.
func (*VersatileStatus) DeepCopyInto ¶
func (in *VersatileStatus) DeepCopyInto(out *VersatileStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*VersatileStatus) IsFinish ¶
func (v *VersatileStatus) IsFinish() bool
IsFinish return ture while status is not conditionUnknown
type Workspace ¶
type Workspace struct { // Name is the name of the workspace populated by the volume. Name string `json:"name"` // SubPath is optionally a directory on the volume which should be used // for this binding (i.e. the volume will be mounted at this sub directory). // +optional SubPath string `json:"subPath,omitempty"` }
func (*Workspace) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Workspace.
func (*Workspace) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.