v1alpha1

package
v1.8.0 Latest Latest
Warning

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

 Go to latest Published: Jul 20, 2023 License: Apache-2.0 Imports: 5 Imported by: 6

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the batch v1alpha1 API group +kubebuilder:object:generate=true +groupName=flow.volcano.sh +k8s:deepcopy-gen=package

Package v1alpha1 contains API Schema definitions for the flow v1alpha1 API group +kubebuilder:object:generate=true +groupName=flow.volcano.sh

Index

Constants

View Source 
const (
	Retain = "retain"
	Delete = "delete"
)
View Source 
const GroupName = "flow.volcano.sh"

GroupName is the group name used in this package.

Variables

View Source 
var (
	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"}

SchemeGroupVersion is the group version used to register these objects.

Functions

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Action added in v1.7.0 

type Action string

Action is the action that JobFlow controller will take according to the event. 

const (
	// SyncJobFlowAction is the action to sync JobFlow status.
	SyncJobFlowAction Action = "SyncJobFlow"
	// SyncJobTemplateAction is the action to sync JobTemplate status.
	SyncJobTemplateAction Action = "SyncJobTemplate"
)

type Condition 

type Condition struct {
	Phase           v1alpha1.JobPhase             `json:"phase,omitempty"`
	CreateTimestamp metav1.Time                   `json:"createTime,omitempty"`
	RunningDuration *metav1.Duration              `json:"runningDuration,omitempty"`
	TaskStatusCount map[string]v1alpha1.TaskState `json:"taskStatusCount,omitempty"`
}

func (*Condition) DeepCopy 

func (in *Condition) DeepCopy() *Condition

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

func (*Condition) DeepCopyInto 

func (in *Condition) DeepCopyInto(out *Condition)

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

type DependsOn 

type DependsOn struct {
	Targets []string `json:"targets,omitempty"`
	Probe   *Probe   `json:"probe,omitempty"`
}

func (*DependsOn) DeepCopy 

func (in *DependsOn) DeepCopy() *DependsOn

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

func (*DependsOn) DeepCopyInto 

func (in *DependsOn) DeepCopyInto(out *DependsOn)

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

type Event added in v1.7.0 

type Event string

Event represent the phase of JobFlow 

const (
	// OutOfSyncEvent is triggered if JobFlow is updated(add/update/delete)
	OutOfSyncEvent Event = "OutOfSync"
)

type Flow 

type Flow struct {
	Name      string     `json:"name"`
	DependsOn *DependsOn `json:"dependsOn,omitempty"`
}

Flow defines the dependent of jobs

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.

type HttpGet 

type HttpGet struct {
	TaskName   string        `json:"taskName,omitempty"`
	Path       string        `json:"path,omitempty"`
	Port       int           `json:"port,omitempty"`
	HTTPHeader v1.HTTPHeader `json:"httpHeader,omitempty"`
}

func (*HttpGet) DeepCopy 

func (in *HttpGet) DeepCopy() *HttpGet

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

func (*HttpGet) DeepCopyInto 

func (in *HttpGet) DeepCopyInto(out *HttpGet)

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

type JobFlow 

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

	Spec   JobFlowSpec   `json:"spec,omitempty"`
	Status JobFlowStatus `json:"status,omitempty"`
}

JobFlow is the Schema for the jobflows API

func (*JobFlow) DeepCopy 

func (in *JobFlow) DeepCopy() *JobFlow

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

func (*JobFlow) DeepCopyInto 

func (in *JobFlow) DeepCopyInto(out *JobFlow)

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

func (*JobFlow) DeepCopyObject 

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

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

type JobFlowList 

type JobFlowList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []JobFlow `json:"items"`
}

JobFlowList contains a list of JobFlow

func (*JobFlowList) DeepCopy 

func (in *JobFlowList) DeepCopy() *JobFlowList

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

func (*JobFlowList) DeepCopyInto 

func (in *JobFlowList) DeepCopyInto(out *JobFlowList)

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

func (*JobFlowList) DeepCopyObject 

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

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

type JobFlowSpec 

type JobFlowSpec struct {

	// Foo is an example field of JobFlow. Edit jobflow_types.go to remove/update
	Flows           []Flow `json:"flows,omitempty"`
	JobRetainPolicy string `json:"jobRetainPolicy,omitempty"`
}

JobFlowSpec defines the desired state of JobFlow

func (*JobFlowSpec) DeepCopy 

func (in *JobFlowSpec) DeepCopy() *JobFlowSpec

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

func (*JobFlowSpec) DeepCopyInto 

func (in *JobFlowSpec) DeepCopyInto(out *JobFlowSpec)

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

type JobFlowStatus 

type JobFlowStatus struct {
	PendingJobs    []string             `json:"pendingJobs,omitempty"`
	RunningJobs    []string             `json:"runningJobs,omitempty"`
	FailedJobs     []string             `json:"failedJobs,omitempty"`
	CompletedJobs  []string             `json:"completedJobs,omitempty"`
	TerminatedJobs []string             `json:"terminatedJobs,omitempty"`
	UnKnowJobs     []string             `json:"unKnowJobs,omitempty"`
	JobStatusList  []JobStatus          `json:"jobStatusList,omitempty"`
	Conditions     map[string]Condition `json:"conditions,omitempty"`
	State          State                `json:"state,omitempty"`
}

JobFlowStatus defines the observed state of JobFlow

func (*JobFlowStatus) DeepCopy 

func (in *JobFlowStatus) DeepCopy() *JobFlowStatus

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

func (*JobFlowStatus) DeepCopyInto 

func (in *JobFlowStatus) DeepCopyInto(out *JobFlowStatus)

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

type JobRunningHistory 

type JobRunningHistory struct {
	StartTimestamp metav1.Time       `json:"startTimestamp,omitempty"`
	EndTimestamp   metav1.Time       `json:"endTimestamp,omitempty"`
	State          v1alpha1.JobPhase `json:"state,omitempty"`
}

func (*JobRunningHistory) DeepCopy 

func (in *JobRunningHistory) DeepCopy() *JobRunningHistory

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

func (*JobRunningHistory) DeepCopyInto 

func (in *JobRunningHistory) DeepCopyInto(out *JobRunningHistory)

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

type JobStatus 

type JobStatus struct {
	Name             string              `json:"name,omitempty"`
	State            v1alpha1.JobPhase   `json:"state,omitempty"`
	StartTimestamp   metav1.Time         `json:"startTimestamp,omitempty"`
	EndTimestamp     metav1.Time         `json:"endTimestamp,omitempty"`
	RestartCount     int32               `json:"restartCount,omitempty"`
	RunningHistories []JobRunningHistory `json:"runningHistories,omitempty"`
}

func (*JobStatus) DeepCopy 

func (in *JobStatus) DeepCopy() *JobStatus

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

func (*JobStatus) DeepCopyInto 

func (in *JobStatus) DeepCopyInto(out *JobStatus)

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

type JobTemplate 

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

	Spec   v1alpha1.JobSpec  `json:"spec,omitempty"`
	Status JobTemplateStatus `json:"status,omitempty"`
}

JobTemplate is the Schema for the jobtemplates API

func (*JobTemplate) DeepCopy 

func (in *JobTemplate) DeepCopy() *JobTemplate

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

func (*JobTemplate) DeepCopyInto 

func (in *JobTemplate) DeepCopyInto(out *JobTemplate)

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

func (*JobTemplate) DeepCopyObject 

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

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

type JobTemplateList 

type JobTemplateList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []JobTemplate `json:"items"`
}

JobTemplateList contains a list of JobTemplate

func (*JobTemplateList) DeepCopy 

func (in *JobTemplateList) DeepCopy() *JobTemplateList

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

func (*JobTemplateList) DeepCopyInto 

func (in *JobTemplateList) DeepCopyInto(out *JobTemplateList)

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

func (*JobTemplateList) DeepCopyObject 

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

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

type JobTemplateSpec 

type JobTemplateSpec struct {

	// Foo is an example field of JobTemplate. Edit jobtemplate_types.go to remove/update
	v1alpha1.JobSpec
}

JobTemplateSpec defines the desired state of JobTemplate

func (*JobTemplateSpec) DeepCopy 

func (in *JobTemplateSpec) DeepCopy() *JobTemplateSpec

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

func (*JobTemplateSpec) DeepCopyInto 

func (in *JobTemplateSpec) DeepCopyInto(out *JobTemplateSpec)

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

type JobTemplateStatus 

type JobTemplateStatus struct {

	//Describes the Jobs generated from the JobTemplate
	JobDependsOnList []string `json:"jobDependsOnList,omitempty"`
}

JobTemplateStatus defines the observed state of JobTemplate

func (*JobTemplateStatus) DeepCopy 

func (in *JobTemplateStatus) DeepCopy() *JobTemplateStatus

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

func (*JobTemplateStatus) DeepCopyInto 

func (in *JobTemplateStatus) DeepCopyInto(out *JobTemplateStatus)

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

type Phase 

type Phase string
const (
	Succeed     Phase = "Succeed"
	Terminating Phase = "Terminating"
	Failed      Phase = "Failed"
	Running     Phase = "Running"
	Pending     Phase = "Pending"
)

type Probe 

type Probe struct {
	HttpGetList    []HttpGet    `json:"httpGetList,omitempty"`
	TcpSocketList  []TcpSocket  `json:"tcpSocketList,omitempty"`
	TaskStatusList []TaskStatus `json:"taskStatusList,omitempty"`
}

func (*Probe) DeepCopy 

func (in *Probe) DeepCopy() *Probe

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

func (*Probe) DeepCopyInto 

func (in *Probe) DeepCopyInto(out *Probe)

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

type State 

type State struct {
	Phase Phase `json:"phase,omitempty"`
}

func (*State) DeepCopy 

func (in *State) DeepCopy() *State

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

func (*State) DeepCopyInto 

func (in *State) DeepCopyInto(out *State)

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

type TaskStatus 

type TaskStatus struct {
	TaskName string `json:"taskName,omitempty"`
	Phase    string `json:"phase,omitempty"`
}

func (*TaskStatus) DeepCopy 

func (in *TaskStatus) DeepCopy() *TaskStatus

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

func (*TaskStatus) DeepCopyInto 

func (in *TaskStatus) DeepCopyInto(out *TaskStatus)

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

type TcpSocket 

type TcpSocket struct {
	TaskName string `json:"taskName,omitempty"`
	Port     int    `json:"port"`
}

func (*TcpSocket) DeepCopy 

func (in *TcpSocket) DeepCopy() *TcpSocket

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

func (*TcpSocket) DeepCopyInto 

func (in *TcpSocket) DeepCopyInto(out *TcpSocket)

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.